Runtime

POST/v1/agents/sessions/{sessionId}/turns

Base URL *

Your instance endpoint, shown on the instance page in the dashboard. Each instance has its own host; there is no shared API host.

Authorization (Bearer token)

sessionId (path) *

Request Body (JSON)

Parameters

Name	In	Type	Required	Description
`sessionId`	path	`string`	Yes

Request Body

Property	Type	Required	Description
`tenantId`	`string`	No
`userInput`	`string`	No

Responses

200 Run a single turn in an agent session

Property	Type	Description
`turn`	`object`	AgentSessionTurn is a single conversation turn within a session.
`sessionStatus`	`"SESSION_STATUS_UNSPECIFIED" \| "SESSION_STATUS_CREATED" \| "SESSION_STATUS_RUNNING" \| "SESSION_STATUS_WAITING_FOR_INPUT" \| "SESSION_STATUS_WAITING_FOR_APPROVAL" \| "SESSION_STATUS_COMPLETED" \| "SESSION_STATUS_FAILED" \| "SESSION_STATUS_CANCELLED"`	SessionStatus tracks the lifecycle of an agent session.

default An unexpected error response.

Property	Type	Description
`code`	`integer`
`message`	`string`
`details`	`object[]`

Request

curl -X POST "http://localhost:8089/v1/agents/sessions/{sessionId}/turns" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"tenantId":"string","userInput":"string"}'

const response = await fetch("http://localhost:8089/v1/agents/sessions/{sessionId}/turns", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
  "tenantId": "string",
  "userInput": "string"
}),
});
const data = await response.json();

import requests

response = requests.post(
    "http://localhost:8089/v1/agents/sessions/{sessionId}/turns",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Content-Type": "application/json",
    },
    json={
  "tenantId": "string",
  "userInput": "string"
},
)
data = response.json()

Response

{
  "turn": {
    "id": "string",
    "sessionId": "string",
    "turnNumber": 0,
    "status": "TURN_STATUS_UNSPECIFIED",
    "userInput": "string",
    "assistantOutput": "string",
    "toolCalls": "string",
    "promptTokens": 0,
    "completionTokens": 0,
    "totalTokens": 0,
    "latencyMs": "string",
    "error": "string",
    "createdAt": "2024-01-01T00:00:00Z",
    "completedAt": "2024-01-01T00:00:00Z"
  },
  "sessionStatus": "SESSION_STATUS_UNSPECIFIED"
}

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}