Get a turn

GET

/api/v1/ai/turns/{id}

const url = 'https://example.com/api/v1/ai/turns/example';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/api/v1/ai/turns/example \
  --header 'Authorization: Bearer <token>'

Return one of the caller’s turns. The response includes its prompt, current status, and recorded file changes. Route: /api/v1/ai/turns/{id}. Inputs: id. Safe reads can use bounded retries.

Authorizations

installationBearer
browserSession

Parameters

Path Parameters

required

string

Responses

200

application/json

object

changes

required

Files, Notes and Tasks writes made with this turn’s token, newest first.

Array<object>

One attributed write. The item ID is the stable identity for /f/<item-id>.

object

item_id

required

string

old_path

Previous path for a move.

string | null

operation

required

Files change-feed operation: create, write, move or trash.

string

path

required

Home-relative path right after the change.

string

created_ms

required

integer format: int64

error_code

Stable failure or cancellation reason, for example credential_removed.

string | null

finished_ms

Unix time in milliseconds when the turn reached a final state.

integer | null format: int64

required

string

kind

required

The server-side turn policy. Ask turns get a token with a read-only scope.

string

Allowed values: agent ask

prompt

required

The User’s request as it was sent, without the server’s framing.

string

provider

required

The official coding Agent selected by a prompt mention.

string

Allowed values: claude codex

status

required

queued, running, completed, failed, cancelled, undoing or undone.

string

Example

{
  "kind": "agent",
  "provider": "claude"
}

404

application/json

The standard API error response: { "error": { ... } }.

object

error

required

Error details.

object

code

required

Stable machine-readable code.

string

Allowed values: bad_request unauthorized forbidden not_found conflict name_conflict_case name_too_long push_endpoint_rejected too_many_requests internal service_unavailable

details

One of:

object
null

Optional field or operation details.

object

key

additional properties

string

message

required

Safe text for logs or a user-facing error message.

string

Example

{
  "error": {
    "code": "bad_request"
  }
}