Skip to main content
GET
List the Architect conversation
The reference panel describes the current v3 operation. The notes below describe its v2 compatibility API. Follow the v3 request schema for current calls: v3 can move identifiers from the body or query into the URL. Keep the v2 method, path, and payload together when using the compatibility API.

v2 compatibility notes

GET /api/v2/workflows/listArchitectMessages One page of the draft’s current Architect conversation, oldest first, and the state of its turn. Poll it after startArchitectConversation or sendArchitectMessage until turn.state is "idle". Items are what a person sent (person), the Architect’s replies (architect) and its notices (notice: a stop, a budget warning, or a plan or batch it is waiting on). Tool calls and results, seed context, authors and token counts are never returned. A message fenced to knowledge or companies keeps its place with text: null and withheld: true.

Authentication

Personal key, External App credential or platform API key. Requires permission workflows:write, and workflows:write and workflows:read held at the workflow’s home org unit: the transcript carries the author’s brief, so it is read by those who may send.

Query

string
required
The workflow ID. Give it exactly once.
string
meta.nextCursor from the previous page.
integer
default:"20"
Stored messages to read for this page, 1 to 50. Messages that are never returned count toward it, so a page can hold fewer items.

Responses

200 with:
object[]
object
state: none (no conversation), idle (ready for a message), running, queued or stopping (a turn is in progress, so a new message is refused). since: when the in-progress turn was claimed, else null.
string | null
The cursor for the next page, or null on the last page.

Errors

Example

Authorizations

Authorization
string
header
required

An External App: the JWT it obtains from POST /oauth/token with OAuth2 client_credentials. Pass as Authorization: Bearer <jwt>. An app's static companion key also authenticates as the app, but is deprecated and is not protected by Idempotency-Key.

Path Parameters

workflowId
string
required

Workflow document id. Give it exactly once.

Minimum string length: 1

Query Parameters

cursor
string

meta.nextCursor from the previous page.

Minimum string length: 1
limit
integer
default:20

Stored rows to read for this page (filtered rows count toward it).

Required range: 1 <= x <= 50

Response

List the Architect conversation

data
object
required
meta
object
required

A list page's continuation. While hasMore is true, nextCursor is a string: pass it as cursor for the next page. hasMore: false ends the list; with truncated: true, more exist past what this list reads, and no cursor reaches them.