v3

latestOpenAPI 3.1.0Proprietary2026-08-07266348629.6 KB

Agents

Get Agent Sample Record

Pull the latest record from the topic that matches topicPattern.

Used by the wizard's persistent test pane to pre-fill the Monaco editor with a concrete sample, so the user doesn't have to hand-craft one. Returns 200 in every "no record" case (regex matches no topic, every matched topic is empty, deserialization fails) so the FE can render inline state without retry logic.

read:agents is the right gate - this is observation, not config mutation, and the response is the same record any team member with Kafka topic-read access could pull manually.

Per-tenant rate limit: 30 req/min/bucket -> 429 with Retry-After.

post/agents/sample-record

Request body

topicPatternstring required

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

inputSerialization'AvroConfluent' | 'JsonConfluent' | 'Protobuf' | 'String' required

Input deserialization formats accepted by POST /agents/sample-record.

Wider than :class:AgentSerializationEnum (which only governs the agent runtime contract) - this endpoint also accepts the raw shapes a topic may carry in the wild so the FE can pre-fill the test pane regardless of how the source upstream is producing.

Response

Successful Response

recordobject nullable

The latest deserialized record, or null if none was found

sourceTopicstring nullable

Concrete topic name the record came from after regex resolution

errorMessagestring nullable

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