Skip to main content
POST
Get Agent Sample Record

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Request body for POST /agents/sample-record.

Mirrors the shape of :class:AgentInputConfig so the FE can forward the wizard's input config straight through without remapping field names.

topicPattern
string
required

Regex pattern for input topics, e.g. '^(orders)$'

Required string length: 1 - 1024
inputSerialization
enum<string>
required

Format used to deserialize the latest record

Available options:
AvroConfluent,
JsonConfluent,
Protobuf,
String

Response

Successful Response

Response body for POST /agents/sample-record.

All three fields nullable because every "no record found" branch (regex matches no topic, every matched topic is empty, or deserialization fails) is a 200 with explanatory state - not an HTTP error - so the FE can render a hint inline without retry logic.

record
Record · object | null

The latest deserialized record, or null if none was found

sourceTopic
string | null

Concrete topic name the record came from after regex resolution

errorMessage
string | null

Set when a topic was found but its latest record could not be read or deserialized