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

Get thread delta

Access control

  • Restricted tokens need the API scope api.everything_else
GET/v1/ai/threads/{thread_id}/delta
Authorization
AuthorizationBearer token · headerrequired
Path parameters
thread_idstringrequired
Query parameters
next_tokenstringrequired
Header parameters
X-Roboto-Org-Idstring
X-Roboto-User-Idstring
Responses
200

OK

dataobjectrequired

Incremental update to an agent thread.

Contains only the changes since the last synchronization, used for efficient real-time updates without transferring the entire thread history.

Show properties
messages_by_idxobjectrequired
continuation_tokenstringrequired
reset_from_message_sequence_numinteger | null
default: null
Show properties
Any of:
integer
integer
null
null
statusAgentThreadStatus | null
default: null
Show properties
Any of:
AgentThreadStatus
string
null
null
titlestring | null
default: null
Show properties
Any of:
string
string
null
null
goalsAgentThreadGoalRecord[] | null
default: null
Show properties
Any of:
AgentThreadGoalRecord[]
Array of AgentThreadGoalRecord
goal_typestringrequired
goal_dataobjectrequired
statusAgentGoalStatusrequired

Lifecycle of a per-turn declared goal.

Goals begin PENDING when registered. They transition to ACHIEVED when the corresponding achieve-tool reports success, or to FAILED when the runner's corrective re-prompt budget for the turn is exhausted (or when the worker cannot construct an achieve-tool for the goal).

Allowed:pendingachievedfailed
message_sequence_numintegerrequired
createdstring<date-time>required
concluded_atstring<date-time> | null
default: null
Show properties
Any of:
string<date-time>
string<date-time>
null
null
achieve_tool_use_idstring | null
default: null
Show properties
Any of:
string
string
null
null
null
null
tasksAgentTask[] | null
default: null
Show properties
Any of:
AgentTask[]
Array of AgentTask
task_idintegerrequired
positionintegerrequired
titlestringrequired
statusAgentTaskStatusrequired

Lifecycle state of a top-level agent task.

Allowed:pendingin_progresscompleted
descriptionstring | null
default: null
Show properties
Any of:
string
string
null
null
conclusionstring | null
default: null
Show properties
Any of:
string
string
null
null
startAgentTaskBoundary | null
default: null
Show properties
Any of:
AgentTaskBoundary
message_sequence_numintegerrequired
content_sequence_numintegerrequired
null
null
endAgentTaskBoundary | null
default: null
Show properties
Any of:
AgentTaskBoundary
message_sequence_numintegerrequired
content_sequence_numintegerrequired
null
null
subtasksAgentSubtask[]
Show properties
Array of AgentSubtask
titlestringrequired
statusAgentSubtaskStatusrequired

Lifecycle state of a sub-task.

Sub-tasks are never activated independently — they are implicitly active with their parent task — so they have no in_progress state.

Allowed:pendingdone
null
null
400

Thrown when the conversation context (messages, system prompt, tool results) exceeds the model's context window limit.

The token estimate and the model's context limit are not carried on the exception, so a caller cannot read usage numbers off it.

errorobject
Show properties
error_codenumber
messagestring
stack_tracestring | null
401

Thrown when authentication fails

errorobject
Show properties
error_codenumber
messagestring
stack_tracestring | null
403

Thrown if an operation would exceed a user or org level limit.

errorobject
Show properties
error_codenumber
messagestring
stack_tracestring | null
404

Thrown if a user is attempting to perform an action unrecognized by the Roboto platform.

errorobject
Show properties
error_codenumber
messagestring
stack_tracestring | null
409

Thrown if there is a conflict between a resource you're creating and another existing resource

errorobject
Show properties
error_codenumber
messagestring
stack_tracestring | null
410

Thrown if a resource is missing or expired.

errorobject
Show properties
error_codenumber
messagestring
stack_tracestring | null
500

An error the platform reported that this SDK release cannot resolve to a specific exception class.

Reported for an element of a :py:class:~roboto.http.BatchResponse whose error names a code this release defines no class for, or that arrived without a code, without a message, or as text that is not an error envelope at all. It carries whatever code and message the platform sent, so a caller handling the failure still learns what went wrong; when no message could be read, the message is the error's raw text.

The error envelope carries no status code, so http_status_code reports the 500 inherited from :py:class:RobotoDomainException rather than the status the failure actually had.

errorobject
Show properties
error_codenumber
messagestring
stack_tracestring | null
501

Thrown by shimmed out APIs which have not yet been implemented

errorobject
Show properties
error_codenumber
messagestring
stack_tracestring | null
503

Thrown when a service is unavailable, such as when it's under heavy load and can't accept new requests. This is expected to be transient and ought to be retried.

errorobject
Show properties
error_codenumber
messagestring
stack_tracestring | null
504

Thrown when the service times out while processing a request. This is exepcted to be transient and ought to be retried.

errorobject
Show properties
error_codenumber
messagestring
stack_tracestring | null
507

Thrown when the server cannot complete the request because the response payload exceeds a storage or transport capacity limit (e.g., Lambda response size). This is NOT expected to be transient and should NOT be retried.

errorobject
Show properties
error_codenumber
messagestring
stack_tracestring | null
Try it
Server
Authorization
Parameters
Request
curl -X GET 'https://api.roboto.ai/v1/ai/threads/string/delta?next_token=string' \
  -H 'Authorization: Bearer YOUR_TOKEN'
Response
{
  "data": {
    "messages_by_idx": {
      "property1": {
        "role": "user",
        "content": [
          {
            "text": "string"
          }
        ],
        "status": "not_started",
        "created": "2019-08-24T14:15:22Z"
      },
      "property2": {
        "role": "user",
        "content": [
          {
            "text": "string"
          }
        ],
        "status": "not_started",
        "created": "2019-08-24T14:15:22Z"
      }
    },
    "continuation_token": "string",
    "reset_from_message_sequence_num": null,
    "status": null,
    "title": null,
    "goals": null,
    "tasks": null
  }
}