Authorizations
- Authorization string required header
Workspace REST API token prefixed with bp_
Path Parameters
- agentId string required
Identifier of the agent conversation to retrieve.
Query Parameters
- historyLimit integer
Maximum number of recent history items to return. Defaults to 100 and caps at 500.
Response
application/json- agentId string
Opaque identifier for the linked agent conversation.
- kind string enum enum
Type of REST API resource represented by the response. Allowed values: agent, code_review.
- status string enum enum
Current high-level lifecycle state for the asynchronous run. Allowed values: queued, running, completed, error.
- appId string
Bubble app ID for the workspace project this request targets.
- projectId string
Opaque identifier for the workspace project.
- projectName string
Human-readable name of the workspace project.
- reviewId string | null
Opaque identifier for the code review.
- model string enum enum
Model identifier used for the run. 15 allowed enum values.
- reasoningEffort string enum | null
Requested reasoning effort for the selected model.
- permission string enum enum
Whether the run can only inspect the app or is also allowed to make edits. Allowed values: read_only, allow_edits.
- permittedBranches[] string array
Branches the run is allowed to access when branch restrictions apply.
- createdAt number
Unix timestamp in milliseconds when the resource was created.
- updatedAt number
Unix timestamp in milliseconds when the resource was last updated.
- completedAt number | null
Unix timestamp in milliseconds when the resource completed.
- lastError string | null
Last error message recorded for the run.
- history[] object array
Recent conversation history for the run. Single message returned in agent or review history.
+ - Show Child Attributes
- id string
Unique identifier for the history message.
- sequence number
Conversation sequence number for the message.
- role string enum enum
Normalized role for the history message. 6 allowed enum values.
- content string | null
Message content when the message carries textual content.
- toolName string | null
Tool name associated with the message when the message represents tool activity.
- toolParameters any | null
Structured tool arguments when the message represents a tool call.
- attachments[] oneOf array
Files and linked issues attached to the message.
+ - Show Child Attributes
- oneOf options 2 variants oneOf
Exactly one option applies.
+ - Show Child Attributes
- option 1 object
+ - Show Child Attributes
- id string
Unique identifier for the attached file.
- type string
Attachment type.
- name string
Display name of the attached file.
- contentType string | null
MIME type for the attached file.
- sizeBytes number | null
Size of the attached file in bytes.
- createdAt number
Unix timestamp in milliseconds when the attachment was created.
- option 2 object
+ - Show Child Attributes
- id string
Unique identifier for the linked Linear attachment.
- type string
Attachment type.
- name string
Display name of the linked Linear issue.
- linearIssue anyOf
Linked Linear issue metadata when one is associated.
+ - Show Child Attributes
- anyOf options 2 variants anyOf
One or more options can apply.
+ - Show Child Attributes
- option 1 object
+ - Show Child Attributes
- id string
Linked Linear issue ID. Schema traversal was truncated at maximum depth.
- identifier string
Human-readable Linear issue identifier. Schema traversal was truncated at maximum depth.
- url string
URL of the linked Linear issue. Schema traversal was truncated at maximum depth.
- option 2 null
- createdAt number
Unix timestamp in milliseconds when the attachment was created.
- createdAt number
Unix timestamp in milliseconds when the message was created.
- lifecycle object
Lifecycle summary for the linked agent conversation.
+ - Show Child Attributes
- conversationState string enum enum
Internal lifecycle state of the linked conversation. Allowed values: draft, ready, running_turn, errored, archived.
- sandboxState string enum enum
Current lifecycle state of the sandbox used by the run. 6 allowed enum values.
- queuedTurnCount number
Number of turns still queued to run.
- lastLifecycleEventAt number | null
Unix timestamp in milliseconds for the most recent lifecycle event.