PAI Chat·Glossary
Glossary
Shared vocabulary used across the PAI API docs. Terms are tagged by the product they apply to — All, Chat, or Subtitles.
| Term | Applies to | Definition |
|---|---|---|
API key | All | A secret credential sent in the x-api-key header to authenticate service-to-service requests. Shown once at creation; store it in a secrets manager. |
x-api-key | All | The request header carrying the raw API key. Missing, invalid, disabled, or expired keys return 401. |
Scope | All | The boundary a key is locked to at creation time and cannot escalate later. Determines which resources the key may act on. |
Rate limit | All | A cap on requests per key (and, for Chat, per IP). Exceeding it returns 429; Chat surfaces RATE_LIMITED with details on when to retry. |
Organisation | Chat | The top-level account that owns chatbots. An organisation key works for any chatbot within it. |
Chatbot | Chat | A single configured assistant inside an organisation. A chatbot key works for that one chatbot only. |
x-chatbot-id | Chat | Header identifying which chatbot a request targets. Required for chatbot-scoped calls; send it explicitly for server-to-server requests. |
x-organization-id | Chat | Header identifying the organisation for organisation-level routes. It must match the key's organisation or the request returns 403. |
Tenant | Subtitles | The workspace a subtitle job belongs to. Tenant-scoped routes check membership and role. |
x-tenant-id | Subtitles | Header selecting the tenant to act on. Must be a valid UUID; absence returns 400, non-membership returns 403. |
Job | Subtitles | A single subtitle operation. Moves through pending → processing → completed / failed. |
Child job | Subtitles | A sub-task (e.g. transcription or translation) spawned by a parent job. The parent stays processing until children settle, which gates restart and delete. |
SRT / VTT | Subtitles | The two accepted subtitle file formats (SubRip and WebVTT). Other extensions are rejected with 400. |