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

Authorization

AuthorizationBearer token · headerrequired

Request body

requiredapplication/json

topicPatternstringrequired

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

min length 1 · max length 1024

inputSerializationSampleRecordSerializationEnumrequired

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.

Allowed:AvroConfluentJsonConfluentProtobufString

Responses

200

Successful Response

recordobject | null

The latest deserialized record, or null if none was found

Show properties

Any of:

object

object

null

null

sourceTopicstring | null

Concrete topic name the record came from after regex resolution

Show properties

Any of:

string

string

null

null

errorMessagestring | null

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

Show properties

Any of:

string

string

null

null

422

Validation Error

detailValidationError[]

Show properties

Array of ValidationError

locstring | integer[]required

Show properties

Array of string | integer

Any of:

string

string

integer

integer

msgstringrequired

typestringrequired

inputany

ctxobject

Request

curl -X POST 'https://api.streamkap.com/agents/sample-record' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
  "topicPattern": "string",
  "inputSerialization": "AvroConfluent"
}'

const response = await fetch("https://api.streamkap.com/agents/sample-record", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: "{\n  \"topicPattern\": \"string\",\n  \"inputSerialization\": \"AvroConfluent\"\n}"
});

import requests

response = requests.post(
    "https://api.streamkap.com/agents/sample-record",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    data="{\n  \"topicPattern\": \"string\",\n  \"inputSerialization\": \"AvroConfluent\"\n}",
)

Response

{
  "record": {},
  "sourceTopic": "string",
  "errorMessage": "string"
}

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}