Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.sequentum.com/llms.txt

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

An Agent Builder session is a stateful, conversational object. Unlike a one-shot API call, a session lives across multiple requests: you start it, watch events stream, send follow-ups, and finish it to produce a real Agent.

Statuses

A session reports one of five statuses on GET /{sessionId}/status:
StatusMeaningWhat you can do
processingAgent Builder is actively working — loading the site, planning, executing steps, or testing.stop, cancel
readyBuilder is paused awaiting your input — typically after a ready_for_interaction event.followup, finish, cancel
completedSession ended; the Agent was saved. Read-only.(none — see Agents API)
errorSession ended with an unrecoverable error.(none)
cancelledYou cancelled the session.(none)
The five values above are returned as lowercase strings in the status field of the GET /status response.

Endpoints

POST /api/v1/agent-builder/start
GET  /api/v1/agent-builder/{sessionId}/status
GET  /api/v1/agent-builder/{sessionId}/events?lastEventIndex=-1
GET  /api/v1/agent-builder/{sessionId}/conversation
POST /api/v1/agent-builder/{sessionId}/followup
POST /api/v1/agent-builder/{sessionId}/finish
POST /api/v1/agent-builder/{sessionId}/cancel
POST /api/v1/agent-builder/{sessionId}/stop

Watching progress

GET /events?lastEventIndex=N is the event stream — long-poll it. Pass lastEventIndex=-1 on the first call, then keep passing the index from each response. See Streaming events for the full event taxonomy and code examples.

Operating verbs

  • followup — send a new user message. Resumes building from a ready state.
  • finish — save the in-progress agent. Session ends with completed status; the response carries the new agentId.
  • stop — interrupt the current operation without ending the session. The session stays alive and can accept follow-ups.
  • cancel — terminate the session entirely. No Agent is created.
Cancelled sessions don’t emit a cancelled event in the streaming endpoint — detect cancellation by polling GET /status and watching for status: "cancelled".