Assistant

Create Assistant Thread

Start a conversation with the assistant (RO-303), optionally with a model the workspace offers (RO-320).

API key access

Not available to API keys or connected apps: only a signed-in person can call this route.
POST/api/v1/assistant/threads
AuthorizationBearer <token>

Access token from /api/v1/auth/login, or an API key (ro_pat_..., RO-176) from /api/v1/workspaces/current/api-keys: the key implies its workspace and needs the route's scope. MCP connectors (/api/v1/mcp only) may use an OAuth access token (ro_oat_..., RO-284).

In: header

Header Parameters

X-Workspace-Id?string | null

Id of the workspace to act on (must be a member).

title?string | null

Default "New chat" (the first message then names the thread).

Length1 <= length <= 200
model?string | null

A model the workspace offers (null = Auto).

Lengthlength <= 120

Response Body

curl -X POST "http://localhost:8000/api/v1/assistant/threads" \  -H "X-Workspace-Id: string" \  -H "Content-Type: application/json" \  -d '{}'
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "title": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "pinned_at": "2019-08-24T14:15:22Z",
  "archived_at": "2019-08-24T14:15:22Z",
  "model": "string"
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}