Skip to main content
GET
/
api
/
v1
/
agent-builder
/
{sessionId}
/
status
Get current status for a session (lightweight polling endpoint)
curl --request GET \
  --url https://api.example.com/api/v1/agent-builder/{sessionId}/status \
  --header 'Authorization: Bearer <token>'
{
  "agentId": 123,
  "agentName": "<string>",
  "error": "<string>"
}

Authorizations

​
Authorization
string
header
required

API Key authorization header. Example: "Authorization: ApiKey {your-api-key}"

​
Authorization
string
header
required

OAuth 2.0 Bearer token. Example: "Authorization: Bearer {access-token}"

Path Parameters

​
sessionId
string
required

The session ID returned from /start

Response

OK

Session status response for the external API.

​
status
enum<string>

All observable status values for an agent builder session. Serialized as lowercase strings on the wire (processing, ready, completed, error, cancelled).

Available options:
processing,
ready,
completed,
error,
cancelled
​
agentId
integer<int32> | null

ID of the agent draft. Populated once the agent draft has been created in your workspace. Always present when status is "completed" or "ready".

​
agentName
string | null

Name of the agent draft. Populated alongside agentId. Always present when status is "completed" or "ready".

​
error
string | null

Error message when status is "error".