Skip to main content
POST
/
v1
/
sessions
/
{id}
Error
A valid request URL is required to generate request examples
{
  "session_id": "<string>",
  "name": "<string>",
  "turns": [
    {
      "speaker": 123,
      "source": "<string>",
      "text": "<string>",
      "start": 123,
      "end": 123
    }
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "modified_at": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "brief": "<string>"
}

Authorizations

​
X-API-Key
string
header
required

Personal Access Token, sent verbatim as pat_<32 chars>. PATs are minted from the Chief settings UI.

Headers

​
X-Project-Id
string
required

Project identifier scoping the request. Required on every project-scoped public endpoint. Missing or malformed values respond with HTTP 400 and code publicapi.tenancy.project.missing.

Pattern: ^project_[a-z0-9]{20}$

Path Parameters

​
id
string
required

Session identifier.

Pattern: ^session_[a-z0-9]{20}$

Body

application/json

Patch a session's name and/or description. Each field is optional; omitting one leaves it unchanged.

​
name
string
​
description
string

Response

Session updated.

Full session view including the transcript. Blob location and tenancy are not exposed.

​
session_id
string
required
Pattern: ^session_[a-z0-9]{20}$
​
name
string
required
​
turns
object[]
required
​
created_at
string<date-time>
required
​
modified_at
string<date-time>
required
​
description
string
​
brief
string

User-supplied framing for the session.