Get conversation state

GET

sandboxes

{id}

conversation

curl --request GET \
  --url "https://api.bead.run/sandboxes/$SANDBOX_ID/conversation" \
  --header "X-API-Key: $BEAD_API_KEY"

# sandbox is returned by Sandbox.create or Sandbox.connect.
print(sandbox.agent.status())

// sandbox is returned by Sandbox.create or Sandbox.connect.
console.log(await sandbox.agent.status());

{
  "activeTurnId": {},
  "queued": 123,
  "threadId": {},
  "credentialUsage": {
    "component": "<string>",
    "version": "<string>",
    "pid": 123,
    "credentials": [
      {
        "credentialId": "<string>",
        "requests": 123
      }
    ]
  },
  "recoveryRequired": true
}

Authentication

Send your scoped bearer token in the Authorization: Bearer <BEAD_TOKEN> header, or send your API key in X-API-Key.

Parameters

string

required

Machine identifier returned by creation.

curl --request GET \
  --url "https://api.bead.run/sandboxes/$SANDBOX_ID/conversation" \
  --header "X-API-Key: $BEAD_API_KEY"

# sandbox is returned by Sandbox.create or Sandbox.connect.
print(sandbox.agent.status())

// sandbox is returned by Sandbox.create or Sandbox.connect.
console.log(await sandbox.agent.status());

Response

200

Conversation queue and recovery state.

string | null

required

UUID of the active prompt, or null while idle. May be null.

integer

required

Number of accepted prompts waiting to run.

string | null

required

Native conversation thread identifier. May be null.

object | null

required

Credential pool request counters, when configured. May be null.

Show Properties

string

required

Credential routing component name.

string

required

Credential routing component version.

integer

required

Process identifier of the active credential router.

object[]

required

Requests counted per credential.

Show Properties

string

required

Credential identifier.

integer

required

Requests observed for this credential.

boolean

required

Whether you must recover the conversation before sending another prompt.

Errors

Status	Meaning
401	Authentication credential is missing or rejected.
403	The credential lacks the required scope.
404	The requested resource does not exist or is outside your organization.
409	The machine must be resumed, a conversation binding changed, or a request UUID was reused for different prompt content.
410	Execution memory was lost (`machine_lost`).
429	Request or resource admission limit exceeded (`admission_limit`). Follow limit.next_action and Retry-After when present.
502	The runner returned an invalid response.
503	Machine wake or native agent recovery is required, or the runner is unavailable.

curl --request GET \
  --url "https://api.bead.run/sandboxes/$SANDBOX_ID/conversation" \
  --header "X-API-Key: $BEAD_API_KEY"

# sandbox is returned by Sandbox.create or Sandbox.connect.
print(sandbox.agent.status())

// sandbox is returned by Sandbox.create or Sandbox.connect.
console.log(await sandbox.agent.status());

{
  "activeTurnId": {},
  "queued": 123,
  "threadId": {},
  "credentialUsage": {
    "component": "<string>",
    "version": "<string>",
    "pid": 123,
    "credentials": [
      {
        "credentialId": "<string>",
        "requests": 123
      }
    ]
  },
  "recoveryRequired": true
}

Start here

Endpoints

Get conversation state

Authentication

Parameters

Response

200

Errors

​Authentication

​Parameters

​Response

​200

​Errors

Authentication

Parameters

Response

200

Errors