AI Chat

Link a sandbox to the chat, or create one for it. Replaces any earlier link.

Changed on
post/ai/conversations/{public_id}/sandbox

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/ai/conversations/{public_id}/sandbox
  • Auth: HTTP bearer

Path parameters

public_idstring required

Conversation public id

Request body

createboolean

Create a fresh sandbox for this chat instead.

sandbox_idstring nullable

Public id of one of the caller's own sandboxes.

Response

Sandbox linked

configuredboolean required

Whether this chat can use a sandbox at all.

connected_projectsinteger[] required

Projects whose services the linked sandbox is connected to: its commands run with credentials for a database of its own on each.

offeredboolean required

True once the assistant has asked the user to link a sandbox.

reasonstring nullable

Why it cannot, when configured is false.

runtime'running' | 'asleep'

Whether a linked sandbox's compute is running.

setup_pathstring nullable

Console path where the user can fix it, when there is one.

Changes