v20

OpenAPI 3.1.0raw.githubusercontent.com2026-08-035471202.8 KB

Chatboxes

Get a chatbox

One chatbox's full read-only settings: model, system prompt, tool-approval policy, attached servers, and share link. A chatbox that exists but belongs to a different project reads as 404 NOT_FOUND.

get/projects/{projectId}/chatboxes/{chatboxId}

Path parameters

projectIdstring required

ID of the hosted project that contains the server.

chatboxIdstring required

Chatbox ID, as returned by the project's chatbox list.

Response

The chatbox settings.

idstring required

projectIdstring nullable

namestring required

descriptionstring nullable

mode'project_members' | 'invited_only' | 'anyone_with_link' | 'null' nullable

Who can use the chatbox.

hostStylestring nullable

Chat surface style the chatbox renders (e.g. claude, chatgpt).

hostIdstring nullable

The named host the chatbox publishes (hosts and chatboxes are 1:1).

hostNamestring nullable

serverCountinteger required

serverNamesstring[] required

createdAtnumber nullable

Unix epoch milliseconds.

updatedAtnumber nullable

Unix epoch milliseconds.

modelIdstring nullable

Model the chatbox chats with.

systemPromptstring nullable

temperaturenumber nullable

requireToolApprovalboolean required