Skip to main content
POST
/
agent
/
{agent-app-id}
/
responses
Agent App
curl --request POST \
  --url https://{gatewayBaseURL}/agent/{agent-app-id}/responses \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "iteration_limit": 5,
  "response_format": "<unknown>",
  "messages": [
    {
      "content": "<string>",
      "name": "<string>"
    }
  ],
  "stream": true
}
'
{
  "created": 123,
  "model": "<string>",
  "choices": [
    {
      "index": 123,
      "delta": {
        "content": "<string>",
        "role": "<string>",
        "refusal": "<unknown>"
      },
      "finish_reason": "<string>",
      "logprobs": "<unknown>"
    }
  ],
  "id": "<string>",
  "service_tier": "<string>",
  "system_fingerprint": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://www.truefoundry.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
agent-app-id
string
required

The ID of the agent app to use for configuration

Body

application/json

Chat parameters. The model, MCP servers, system prompt, guardrails, and model parameters (temperature, max_tokens, etc.) are autofilled from agent app configuration.

​
iteration_limit
integer
default:5
required

Maximum number of iterations to perform with tool calls. Must be a positive integer. Defaults to 5.

Required range: 0 < x <= 20
​
response_format
any

Response format specification for structured output

​
messages
(System Message · object | User Message · object | Assistant Message · object | Function Message · object | Tool Message · object | Developer Message · object)[]

A list of messages comprising the conversation history

​
stream
boolean | null

Whether to stream responses

Response

Chat completions response with tool calls using agent app configuration

​
object
enum<string>
required

Object type.

Available options:
chat.completion.chunk
​
created
number
required

Unix timestamp when the chunk was created.

​
model
string
required

Model that produced the chunk.

​
choices
object[]
required
​
id
string

Chunk ID.

​
service_tier
string

Service tier used.

​
system_fingerprint
string

System fingerprint.