Sessions
Get a session
`running` reports whether a turn is in flight; it is reconciled against the durable turn queue on every read, so it is safe to poll.
running reports whether a turn is in flight; it is reconciled against the durable turn queue
on every read, so it is safe to poll.
Authorization
api_key sessions:readAuthorizationBearer <token>
An atk_-prefixed API key, created under Settings → API keys.
In: header
Scope: sessions:read
Path Parameters
session_id*string
Session id
Format
uuidResponse Body
application/json
application/json
application/json
curl -X GET "https://example.com/v1/sessions/497f6eca-6276-4993-bfeb-53cbbbba6f08"{ "agent_id": "2b1e3b65-2c04-4fa2-a2d7-467901e98978", "created_at": "2019-08-24T14:15:22Z", "depth": 0, "factcheck_enabled": true, "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "parent_kind": "string", "parent_schedule_id": "976bdf23-5dc8-4474-a778-a91df331c3aa", "parent_session_id": "332c228e-f2af-4ec3-b6d2-c6dd59f66c36", "parent_user_id": "d5c8e834-f292-42c2-b18e-c80e5d13a7f3", "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9", "running": true, "source_card_id": "3a228978-b733-49f5-a345-691ace7056d4", "status": "string", "title": "string", "updated_at": "2019-08-24T14:15:22Z"}Create a chat POST
Opens a new empty chat. Send it work with `POST /v1/sessions/{session_id}/messages`, or leave it for someone to pick up in the web app.
Update a session PATCH
Renames the session and/or moves it between projects. Both fields are optional; a present-null `project_id` unlinks the session from its project.