Skip to content
Streamkap
Esc
↑↓navigate↵open⌘Jpreview

Get Agent Config History Entry

Return the masked full config for a specific history version.

The stored snapshot is re-validated against the current agent config rules. If those rules have tightened since the snapshot was written, the response is 422 with the validation errors (the same shape the rollback endpoint returns). 404 if no history entry exists at that version.

GET/agents/{job_id}/config/history/{version}
Authorization
AuthorizationBearer token · headerrequired
Path parameters
job_idstringrequired
versionintegerrequired
Responses
200

Successful Response

versionintegerrequired
min 0
changedByEmailstring | null
Show properties
Any of:
string
string
null
null
changedTimestampstring<date-time>required
changeKindstringrequired
Allowed:createupdaterollback
rollbackSourceVersioninteger | null
Show properties
Any of:
integer
integer
null
null
changeNotestring | null
Show properties
Any of:
string
string
null
null
agentConfigCreateAgentConfigRequestrequired

Historical agent_config at this version, masked

Show properties
namestringrequired

Agent display name

min length 1 · max length 200
descriptionstring | null

Human-readable context for the agent

Show properties
Any of:
string
string
null
null
enabledboolean

Kill switch. When false, the Flink runtime accepts the deploy but stops emitting output — used by support to disable a runaway tenant agent without a full cancel/redeploy.

default: true
agentTypeAgentTypeEnum

Agent type — derived from the tool list post-validation; client-supplied value is overwritten

default: "workflow"
Allowed:workflowreact
inputAgentInputConfigrequired

Input configuration for the agent.

Show properties
topicPatternstringrequired

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

min length 1 · max length 1024
inputSerializationAgentSerializationEnum

Input deserialization format

default: "JsonConfluent"
Allowed:JsonConfluentAvroConfluent
fieldsstring[] | null

Column-level filter - only these fields sent to LLM

Show properties
Any of:
string[]
Array of string
string
null
null
createTableSQLstring | null

Flink SQL CREATE TABLE (required if filterSQL is set)

Show properties
Any of:
string
string
null
null
filterSQLstring | null

WHERE clause predicate for row-level filtering

Show properties
Any of:
string
string
null
null
outputAgentOutputConfigrequired

Output configuration for the agent.

Show properties
topicstringrequired

Fixed output topic name

min length 1 · max length 249
deadLetterTopicstring | null

DLQ topic name

Show properties
Any of:
string
string
null
null
outputSerializationAgentSerializationEnum

Output serialization format

default: "JsonConfluent"
Allowed:JsonConfluentAvroConfluent
schemaobject

Output schema: {field_name: TYPE_STRING}

llmAgentLlmConfigrequired

Inline LLM configuration embedded on the agent.

Carries provider, credentials, model, and tuning controls as a single object. Values can be copied from a saved AgentLlmConnection (which carries default model, tuning and reasoning controls) and overridden per agent; the object is stored as sent and used by the agent runtime at deploy.

Two credential shapes (exactly one, same rule as ValidateLlmRequest):

  1. Inline - apiKey is filled directly. Streamkap encrypts it at rest and decrypts it only at deploy / test-run.
  2. Linked - llmConnectionId references one of the tenant's saved LLM connections and apiKey is left empty. Streamkap resolves the real key server-side at deploy and at test-run, so a client never needs to hold or re-send the stored key when editing an existing agent.

provider == ollama accepts an empty key without a link (the runtime is local and unauthenticated).

Show properties
providerAgentLlmProviderEnumrequired

LLM provider

Allowed:anthropicopenaiopenai-responsesollamaazureazure-openaibedrockqwenopenai-compatible
modelstringrequired

Model name, e.g. claude-sonnet-4-20250514

min length 1
apiKeystring

API key - use '${SECRET:ENV_VAR_NAME}' for env var resolution. Empty when llmConnectionId is set.

max length 512 · default: ""
llmConnectionIdstring | null

Id of one of the tenant's saved LLM connections (llmConnections[].id in GET /agents/connections). When set with an empty apiKey, Streamkap resolves the real key server-side at deploy and at test-run.

Show properties
Any of:
string
string
null
null
baseUrlstring | null

Base URL for OpenAI-compatible proxies

Show properties
Any of:
string
string
null
null
temperaturenumber | null

Sampling temperature (null = matrix-skipped)

Show properties
Any of:
number
number
null
null
maxTokensinteger | null

Max output tokens (null = matrix-skipped)

Show properties
Any of:
integer
integer
null
null
timeoutinteger | null

Request timeout in seconds (null = matrix-skipped)

Show properties
Any of:
integer
integer
null
null
reasoningEffortstring | null

OpenAI / GPT-5 reasoning effort. The accepted set is per-model; a value the chosen provider + model does not support is rejected with 422.

Show properties
Any of:
string
string
null
null
thinkingBudgetTokensinteger | null

Anthropic Claude 4 extended-thinking budget (tokens). Non-null enables thinking.

Show properties
Any of:
integer
integer
null
null
ollamaThinkboolean | null

Ollama 'think' toggle for reasoning models

Show properties
Any of:
boolean
boolean
null
null
maxRetriesinteger | null

Universal — max retry attempts on LLM call. Accepted by every provider.

Show properties
Any of:
integer
integer
null
null
regionstring | null

Bedrock: AWS region (e.g. us-east-1). Ignored for non-bedrock providers.

Show properties
Any of:
string
string
null
null
strictboolean | null

openai-responses: enable JSON-schema strict mode.

Show properties
Any of:
boolean
boolean
null
null
storeboolean | null

openai-responses: server-side response storage flag.

Show properties
Any of:
boolean
boolean
null
null
instructionsstring | null

openai-responses: system-level instructions passed as a top-level Responses param.

Show properties
Any of:
string
string
null
null
additionalKwargsobject | null

openai-responses / azure-openai: free-form extra request params forwarded verbatim by the runtime.

Show properties
Any of:
object
object
null
null
apiVersionstring | null

azure-openai: Azure OpenAI API version (e.g. '2024-02-01'). Required for azure-openai.

Show properties
Any of:
string
string
null
null
azureEndpointstring | null

azure-openai: Azure resource endpoint (e.g. https://<resource>.openai.azure.com). Required.

Show properties
Any of:
string
string
null
null
azureUrlPathModestring | null

azure-openai: URL path resolution — AUTO / LEGACY / UNIFIED. Optional.

Show properties
Any of:
string
string
null
null
promptsAgentPromptConfigrequired

Prompt configuration for the agent.

The final system prompt is assembled automatically from the agent type template + output schema + tool descriptions + customInstructions. The system field stores the assembled result (set by Streamkap, not the user).

Show properties
systemstring

Assembled system prompt (generated by Streamkap)

max length 8000 · default: ""
customInstructionsstring

User-provided instructions appended to the auto-generated prompt

max length 8000 · default: ""
userstring

User prompt template - {input_json} is replaced with the input record

max length 2000 · default: "<record>{input_json}</record>"
mcpServerAgentMcpServerConfig | null

Shared MCP server config for all MCP tools

Show properties
Any of:
AgentMcpServerConfig
projectKeyIdstring | null

ID of an agentic-enabled Project Key. When set, deploy-time resolves the Streamkap MCP serverUrl + auth header from the PK row. Mutually exclusive with serverUrl - one or the other, never both.

Show properties
Any of:
string
string
null
null
serverUrlstring | null

External MCP server URL. Required when projectKeyId is unset. Server-stamped from the PK row when projectKeyId is set.

Show properties
Any of:
string
string
null
null
headersobject

Auth headers for MCP server

null
null
toolsAgentToolConfig[]

Agent tools (MCP, HTTP, transform)

Show properties
Array of AgentToolConfig
namestringrequired

Tool name (must be unique)

min length 1 · max length 100
typeAgentToolTypeEnumrequired

Tool type: http, transform, or mcp

Allowed:httptransformmcp
descriptionstring

Tool description for the LLM

max length 2000 · default: ""
configobject

Type-specific configuration

parametersAgentToolParameterConfig[]

Tool parameters the LLM can provide

Show properties
Array of AgentToolParameterConfig
namestringrequired

Parameter name

min length 1 · max length 100
typestring

Parameter type (string, number, boolean)

max length 50 · default: "string"
descriptionstring

Parameter description for the LLM

max length 2000 · default: ""
memoryAgentMemoryConfig | null

Memory config (short-term + long-term)

Show properties
Any of:
AgentMemoryConfig
keyFieldstring | null

Field to partition memory by (e.g. 'customer_id'). Default: topic key

Show properties
Any of:
string
string
null
null
shortTermAgentShortTermMemoryConfig

Short-term conversation memory

Show properties
enabledboolean

Enable short-term memory

default: false
ttlMsinteger

Time-to-live in milliseconds (default: 1 hour)

min 0 · default: 3600000
maxEntriesinteger

Max conversation entries per key

min 1 · max 100 · default: 20
longTermAgentLongTermMemoryConfig

Long-term vector store memory

Show properties
enabledboolean

Enable long-term memory

default: false
vectorStoreConnectionIdstring | null

Reference to a saved AgentVectorStoreConnection. Resolved at deploy time.

Show properties
Any of:
string
string
null
null
namespacestring | null

Per-agent namespace override (falls back to connection's defaultNamespace)

Show properties
Any of:
string
string
null
null
destinationIdstring | null

(Legacy) ObjectId of a Pinecone destination connector. Prefer vectorStoreConnectionId.

Show properties
Any of:
string
string
null
null
null
null
knowledgeBasesAgentKnowledgeBaseRef[]

Knowledge bases this agent can query at runtime for RAG

max items 10
Show properties
Array of AgentKnowledgeBaseRef
idstringrequired

Knowledge base entity ID

min length 1 · max length 64
namestring

Display name (denormalized for UI)

max length 200 · default: ""
processingAgentProcessingConfig

Processing configuration for the agent.

Show properties
parallelisminteger

Parallelism

min 1 · max 128 · default: 1
checkpointIntervalMininteger

Checkpoint interval in minutes

min 1 · max 60 · default: 5
maxIterationsinteger

Max tool-call iterations per record (react type only)

min 1 · max 25 · default: 10
maxTokensPerHourinteger

Per-TaskManager rolling-hour token budget. 0 = unlimited. When exceeded, records pass through with a _budget_exceeded: true marker.

min 0 · default: 0
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 GET 'https://api.streamkap.com/agents/string/config/history/0' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Response
{
  "version": 0,
  "changedByEmail": "string",
  "changedTimestamp": "2019-08-24T14:15:22Z",
  "changeKind": "create",
  "rollbackSourceVersion": 0,
  "changeNote": "string",
  "agentConfig": {
    "name": "string",
    "description": "string",
    "enabled": true,
    "agentType": "workflow",
    "input": {
      "topicPattern": "string",
      "inputSerialization": "JsonConfluent",
      "fields": [
        "string"
      ],
      "createTableSQL": "string",
      "filterSQL": "string"
    },
    "output": {
      "topic": "string",
      "deadLetterTopic": "string",
      "outputSerialization": "JsonConfluent",
      "schema": {
        "property1": "STRING",
        "property2": "STRING"
      }
    },
    "llm": {
      "provider": "anthropic",
      "model": "string",
      "apiKey": "",
      "llmConnectionId": "string",
      "baseUrl": "string",
      "temperature": 0,
      "maxTokens": 1,
      "timeout": 1,
      "reasoningEffort": "none",
      "thinkingBudgetTokens": 0,
      "ollamaThink": true,
      "maxRetries": 0,
      "region": "string",
      "strict": true,
      "store": true,
      "instructions": "string",
      "additionalKwargs": {},
      "apiVersion": "string",
      "azureEndpoint": "string",
      "azureUrlPathMode": "AUTO"
    },
    "prompts": {
      "system": "",
      "customInstructions": "",
      "user": "<record>{input_json}</record>"
    },
    "mcpServer": {
      "projectKeyId": "string",
      "serverUrl": "string",
      "headers": {
        "property1": "string",
        "property2": "string"
      }
    },
    "tools": [
      {
        "name": "string",
        "type": "http",
        "description": "",
        "config": {},
        "parameters": [
          {
            "name": "string",
            "type": "string",
            "description": ""
          }
        ]
      }
    ],
    "memory": {
      "keyField": "string",
      "shortTerm": {
        "enabled": false,
        "ttlMs": 3600000,
        "maxEntries": 20
      },
      "longTerm": {
        "enabled": false,
        "vectorStoreConnectionId": "string",
        "namespace": "string",
        "destinationId": "string"
      }
    },
    "knowledgeBases": [
      {
        "id": "string",
        "name": ""
      }
    ],
    "processing": {
      "parallelism": 1,
      "checkpointIntervalMin": 5,
      "maxIterations": 10,
      "maxTokensPerHour": 0
    }
  }
}