Chat and attachments¶
Use the linked wire models for field constraints. Operation metadata does not enumerate every possible HTTP error or replace current server authorization.
On this page¶
- Threads (GET)
- Thread create (POST)
- Messages (GET)
- Submit (POST)
- Cancel (POST)
- Retry (POST)
- Events (GET)
- Result (GET)
- Activities (GET)
- Audit (GET)
- Folders (GET)
- Create folder (POST)
- Folder (GET)
- Patch folder (PATCH)
- Delete folder (DELETE)
- Thread (GET)
- Patch thread (PATCH)
- Title suggestion (POST)
- Delete thread (DELETE)
- Capabilities (GET)
- Upload (POST)
- List files (GET)
- Get (GET)
- Original (GET)
- Chunks (GET)
- Cancel (POST)
- Retry (POST)
- Delete (DELETE)
- Knowledge (POST)
- Get (GET)
- Update (PUT)
Threads¶
GET /api/v1/tenants/{tenant_id}/chat/threads
Contract operation: AssistantController.threads.
| SDK | Method |
|---|---|
| Python | threads |
| TypeScript | chat.threads |
| Java | client.chat.threads |
Parameters¶
These are the declared path, query and body arguments. Multipart and binary inputs are described by their request schema below. SDK argument names may follow each language’s conventions.
| Name | Location | Declared type | Required | Default |
|---|---|---|---|---|
tenant_id |
path | PathVar[str] |
Yes | Not specified |
q |
query | QueryParam[str] |
No | "" |
page |
query | QueryParam[int] |
No | 1 |
page_size |
query | QueryParam[int] |
No | 25 |
sort |
query | QueryParam[str] |
No | "updated_at" |
order |
query | QueryParam[str] |
No | "desc" |
folder_id |
query | QueryParam[str | None] |
No | null |
unfiled |
query | QueryParam[bool] |
No | false |
project_id |
query | QueryParam[str | None] |
No | null |
workspace_id |
query | QueryParam[str | None] |
No | null |
status |
query | QueryParam[str] |
No | "active" |
Request and response¶
| Contract | Value |
|---|---|
| Request schema | No request schema declared |
| Response schema | Page[ChatThread] |
| Success status | 200 |
| Declared encoding | application/json |
Encoding identifies the upload, stream or download format when applicable; otherwise it is JSON. It is not a declaration that a GET request has a body.
Headers¶
No operation-specific headers are declared in the canonical metadata.
Authentication and resource bounds still apply. See request behavior and the SDK runtime reference.
Thread create¶
POST /api/v1/tenants/{tenant_id}/chat/threads
Contract operation: AssistantController.thread_create.
| SDK | Method |
|---|---|
| Python | create_thread |
| TypeScript | chat.create |
| Java | client.chat.createThread |
Parameters¶
These are the declared path, query and body arguments. Multipart and binary inputs are described by their request schema below. SDK argument names may follow each language’s conventions.
| Name | Location | Declared type | Required | Default |
|---|---|---|---|---|
tenant_id |
path | PathVar[str] |
Yes | Not specified |
body |
body | Valid[Body[ThreadInput]] |
Yes | Not specified |
Request and response¶
| Contract | Value |
|---|---|
| Request schema | ThreadInput |
| Response schema | ChatThread |
| Success status | 201 |
| Declared encoding | application/json |
Encoding identifies the upload, stream or download format when applicable; otherwise it is JSON. It is not a declaration that a GET request has a body.
Headers¶
No operation-specific headers are declared in the canonical metadata.
Authentication and resource bounds still apply. See request behavior and the SDK runtime reference.
Messages¶
GET /api/v1/tenants/{tenant_id}/chat/threads/{thread_id}/messages
Contract operation: AssistantController.messages.
| SDK | Method |
|---|---|
| Python | messages |
| TypeScript | chat.messages |
| Java | client.chat.messages |
Parameters¶
These are the declared path, query and body arguments. Multipart and binary inputs are described by their request schema below. SDK argument names may follow each language’s conventions.
| Name | Location | Declared type | Required | Default |
|---|---|---|---|---|
tenant_id |
path | PathVar[str] |
Yes | Not specified |
thread_id |
path | PathVar[str] |
Yes | Not specified |
before |
query | QueryParam[str | None] |
No | null |
limit |
query | QueryParam[int] |
No | 50 |
Request and response¶
| Contract | Value |
|---|---|
| Request schema | No request schema declared |
| Response schema | Page[ChatMessage] |
| Success status | 200 |
| Declared encoding | application/json |
Encoding identifies the upload, stream or download format when applicable; otherwise it is JSON. It is not a declaration that a GET request has a body.
Headers¶
No operation-specific headers are declared in the canonical metadata.
Authentication and resource bounds still apply. See request behavior and the SDK runtime reference.
Submit¶
POST /api/v1/tenants/{tenant_id}/chat/threads/{thread_id}/runs
Contract operation: AssistantController.submit.
| SDK | Method |
|---|---|
| Python | submit_run |
| TypeScript | chat.submit |
| Java | client.chat.submit |
Parameters¶
These are the declared path, query and body arguments. Multipart and binary inputs are described by their request schema below. SDK argument names may follow each language’s conventions.
| Name | Location | Declared type | Required | Default |
|---|---|---|---|---|
tenant_id |
path | PathVar[str] |
Yes | Not specified |
thread_id |
path | PathVar[str] |
Yes | Not specified |
body |
body | Valid[Body[RunInput]] |
Yes | Not specified |
Request and response¶
| Contract | Value |
|---|---|
| Request schema | RunInput |
| Response schema | ChatRun |
| Success status | 202 |
| Declared encoding | application/json |
Encoding identifies the upload, stream or download format when applicable; otherwise it is JSON. It is not a declaration that a GET request has a body.
Headers¶
No operation-specific headers are declared in the canonical metadata.
Authentication and resource bounds still apply. See request behavior and the SDK runtime reference.
Cancel¶
POST /api/v1/tenants/{tenant_id}/chat/runs/{run_id}/cancel
Contract operation: AssistantController.cancel.
| SDK | Method |
|---|---|
| Python | cancel_run |
| TypeScript | chat.cancel |
| Java | client.chat.cancel |
Parameters¶
These are the declared path, query and body arguments. Multipart and binary inputs are described by their request schema below. SDK argument names may follow each language’s conventions.
| Name | Location | Declared type | Required | Default |
|---|---|---|---|---|
tenant_id |
path | PathVar[str] |
Yes | Not specified |
run_id |
path | PathVar[str] |
Yes | Not specified |
Request and response¶
| Contract | Value |
|---|---|
| Request schema | No request schema declared |
| Response schema | ChatRun |
| Success status | 200 |
| Declared encoding | application/json |
Encoding identifies the upload, stream or download format when applicable; otherwise it is JSON. It is not a declaration that a GET request has a body.
Headers¶
No operation-specific headers are declared in the canonical metadata.
Authentication and resource bounds still apply. See request behavior and the SDK runtime reference.
Retry¶
POST /api/v1/tenants/{tenant_id}/chat/runs/{run_id}/retry
Contract operation: AssistantController.retry.
| SDK | Method |
|---|---|
| Python | retry_run |
| TypeScript | chat.retry |
| Java | client.chat.retry |
Parameters¶
These are the declared path, query and body arguments. Multipart and binary inputs are described by their request schema below. SDK argument names may follow each language’s conventions.
| Name | Location | Declared type | Required | Default |
|---|---|---|---|---|
tenant_id |
path | PathVar[str] |
Yes | Not specified |
run_id |
path | PathVar[str] |
Yes | Not specified |
Request and response¶
| Contract | Value |
|---|---|
| Request schema | No request schema declared |
| Response schema | ChatRun |
| Success status | 202 |
| Declared encoding | application/json |
Encoding identifies the upload, stream or download format when applicable; otherwise it is JSON. It is not a declaration that a GET request has a body.
Headers¶
No operation-specific headers are declared in the canonical metadata.
Authentication and resource bounds still apply. See request behavior and the SDK runtime reference.
Events¶
GET /api/v1/tenants/{tenant_id}/chat/runs/{run_id}/events
Contract operation: AssistantController.events.
| SDK | Method |
|---|---|
| Python | events |
| TypeScript | chat.events |
| Java | client.chat.events |
Parameters¶
These are the declared path, query and body arguments. Multipart and binary inputs are described by their request schema below. SDK argument names may follow each language’s conventions.
| Name | Location | Declared type | Required | Default |
|---|---|---|---|---|
tenant_id |
path | PathVar[str] |
Yes | Not specified |
run_id |
path | PathVar[str] |
Yes | Not specified |
Request and response¶
| Contract | Value |
|---|---|
| Request schema | No request schema declared |
| Response schema | StreamEvent |
| Success status | 200 |
| Declared encoding | text/event-stream |
Encoding identifies the upload, stream or download format when applicable; otherwise it is JSON. It is not a declaration that a GET request has a body.
Headers¶
Last-Event-ID (last fully processed opaque event ID)
Authentication and resource bounds still apply. See request behavior and the SDK runtime reference.
Result¶
GET /api/v1/tenants/{tenant_id}/chat/runs/{run_id}/results/{result_id}
Contract operation: AssistantController.result.
| SDK | Method |
|---|---|
| Python | result |
| TypeScript | chat.result |
| Java | client.chat.result |
Parameters¶
These are the declared path, query and body arguments. Multipart and binary inputs are described by their request schema below. SDK argument names may follow each language’s conventions.
| Name | Location | Declared type | Required | Default |
|---|---|---|---|---|
tenant_id |
path | PathVar[str] |
Yes | Not specified |
run_id |
path | PathVar[str] |
Yes | Not specified |
result_id |
path | PathVar[str] |
Yes | Not specified |
Request and response¶
| Contract | Value |
|---|---|
| Request schema | No request schema declared |
| Response schema | EvidenceResult |
| Success status | 200 |
| Declared encoding | application/json |
Encoding identifies the upload, stream or download format when applicable; otherwise it is JSON. It is not a declaration that a GET request has a body.
Headers¶
No operation-specific headers are declared in the canonical metadata.
Authentication and resource bounds still apply. See request behavior and the SDK runtime reference.
Activities¶
GET /api/v1/tenants/{tenant_id}/chat/runs/{run_id}/activity
Contract operation: AssistantController.activities.
| SDK | Method |
|---|---|
| Python | run_activities |
| TypeScript | chat.activities |
| Java | client.chat.activities |
Parameters¶
These are the declared path, query and body arguments. Multipart and binary inputs are described by their request schema below. SDK argument names may follow each language’s conventions.
| Name | Location | Declared type | Required | Default |
|---|---|---|---|---|
tenant_id |
path | PathVar[str] |
Yes | Not specified |
run_id |
path | PathVar[str] |
Yes | Not specified |
page |
query | QueryParam[int] |
No | 1 |
page_size |
query | QueryParam[int] |
No | 25 |
Request and response¶
| Contract | Value |
|---|---|
| Request schema | No request schema declared |
| Response schema | Page[ToolActivity] |
| Success status | 200 |
| Declared encoding | application/json |
Encoding identifies the upload, stream or download format when applicable; otherwise it is JSON. It is not a declaration that a GET request has a body.
Headers¶
No operation-specific headers are declared in the canonical metadata.
Authentication and resource bounds still apply. See request behavior and the SDK runtime reference.
Audit¶
GET /api/v1/tenants/{tenant_id}/chat/runs/{run_id}/audit
Contract operation: AssistantController.audit.
| SDK | Method |
|---|---|
| Python | run_audit |
| TypeScript | chat.audit |
| Java | client.chat.audit |
Parameters¶
These are the declared path, query and body arguments. Multipart and binary inputs are described by their request schema below. SDK argument names may follow each language’s conventions.
| Name | Location | Declared type | Required | Default |
|---|---|---|---|---|
tenant_id |
path | PathVar[str] |
Yes | Not specified |
run_id |
path | PathVar[str] |
Yes | Not specified |
Request and response¶
| Contract | Value |
|---|---|
| Request schema | No request schema declared |
| Response schema | AnswerAudit |
| Success status | 200 |
| Declared encoding | application/json |
Encoding identifies the upload, stream or download format when applicable; otherwise it is JSON. It is not a declaration that a GET request has a body.
Headers¶
No operation-specific headers are declared in the canonical metadata.
Authentication and resource bounds still apply. See request behavior and the SDK runtime reference.
Folders¶
GET /api/v1/tenants/{tenant_id}/chat/folders
Contract operation: ChatHistoryController.folders.
| SDK | Method |
|---|---|
| Python | folders |
| TypeScript | chat.folders.list |
| Java | client.chatFolders.list |
Parameters¶
These are the declared path, query and body arguments. Multipart and binary inputs are described by their request schema below. SDK argument names may follow each language’s conventions.
| Name | Location | Declared type | Required | Default |
|---|---|---|---|---|
tenant_id |
path | PathVar[str] |
Yes | Not specified |
q |
query | QueryParam[str] |
No | "" |
page |
query | QueryParam[int] |
No | 1 |
page_size |
query | QueryParam[int] |
No | 25 |
parent_id |
query | QueryParam[str | None] |
No | null |
root_only |
query | QueryParam[bool] |
No | false |
workspace_id |
query | QueryParam[str | None] |
No | null |
sort |
query | QueryParam[str] |
No | "name" |
order |
query | QueryParam[str] |
No | "asc" |
Request and response¶
| Contract | Value |
|---|---|
| Request schema | No request schema declared |
| Response schema | Page[ChatFolder] |
| Success status | 200 |
| Declared encoding | application/json |
Encoding identifies the upload, stream or download format when applicable; otherwise it is JSON. It is not a declaration that a GET request has a body.
Headers¶
No operation-specific headers are declared in the canonical metadata.
Authentication and resource bounds still apply. See request behavior and the SDK runtime reference.
Create folder¶
POST /api/v1/tenants/{tenant_id}/chat/folders
Contract operation: ChatHistoryController.create_folder.
| SDK | Method |
|---|---|
| Python | create_folder |
| TypeScript | chat.folders.create |
| Java | client.chatFolders.create |
Parameters¶
These are the declared path, query and body arguments. Multipart and binary inputs are described by their request schema below. SDK argument names may follow each language’s conventions.
| Name | Location | Declared type | Required | Default |
|---|---|---|---|---|
tenant_id |
path | PathVar[str] |
Yes | Not specified |
body |
body | Valid[Body[FolderCreate]] |
Yes | Not specified |
Request and response¶
| Contract | Value |
|---|---|
| Request schema | FolderCreate |
| Response schema | ChatFolder |
| Success status | 201 |
| Declared encoding | application/json |
Encoding identifies the upload, stream or download format when applicable; otherwise it is JSON. It is not a declaration that a GET request has a body.
Headers¶
No operation-specific headers are declared in the canonical metadata.
Authentication and resource bounds still apply. See request behavior and the SDK runtime reference.
Folder¶
GET /api/v1/tenants/{tenant_id}/chat/folders/{folder_id}
Contract operation: ChatHistoryController.folder.
| SDK | Method |
|---|---|
| Python | folder |
| TypeScript | chat.folders.get |
| Java | client.chatFolders.get |
Parameters¶
These are the declared path, query and body arguments. Multipart and binary inputs are described by their request schema below. SDK argument names may follow each language’s conventions.
| Name | Location | Declared type | Required | Default |
|---|---|---|---|---|
tenant_id |
path | PathVar[str] |
Yes | Not specified |
folder_id |
path | PathVar[str] |
Yes | Not specified |
Request and response¶
| Contract | Value |
|---|---|
| Request schema | No request schema declared |
| Response schema | ChatFolder |
| Success status | 200 |
| Declared encoding | application/json |
Encoding identifies the upload, stream or download format when applicable; otherwise it is JSON. It is not a declaration that a GET request has a body.
Headers¶
No operation-specific headers are declared in the canonical metadata.
Authentication and resource bounds still apply. See request behavior and the SDK runtime reference.
Patch folder¶
PATCH /api/v1/tenants/{tenant_id}/chat/folders/{folder_id}
Contract operation: ChatHistoryController.patch_folder.
| SDK | Method |
|---|---|
| Python | update_folder |
| TypeScript | chat.folders.update |
| Java | client.chatFolders.update |
Parameters¶
These are the declared path, query and body arguments. Multipart and binary inputs are described by their request schema below. SDK argument names may follow each language’s conventions.
| Name | Location | Declared type | Required | Default |
|---|---|---|---|---|
tenant_id |
path | PathVar[str] |
Yes | Not specified |
folder_id |
path | PathVar[str] |
Yes | Not specified |
body |
body | Valid[Body[FolderPatch]] |
Yes | Not specified |
Request and response¶
| Contract | Value |
|---|---|
| Request schema | FolderPatch |
| Response schema | ChatFolder |
| Success status | 200 |
| Declared encoding | application/json |
Encoding identifies the upload, stream or download format when applicable; otherwise it is JSON. It is not a declaration that a GET request has a body.
Headers¶
No operation-specific headers are declared in the canonical metadata.
Authentication and resource bounds still apply. See request behavior and the SDK runtime reference.
Delete folder¶
DELETE /api/v1/tenants/{tenant_id}/chat/folders/{folder_id}
Contract operation: ChatHistoryController.delete_folder.
| SDK | Method |
|---|---|
| Python | delete_folder |
| TypeScript | chat.folders.delete |
| Java | client.chatFolders.delete |
Parameters¶
These are the declared path, query and body arguments. Multipart and binary inputs are described by their request schema below. SDK argument names may follow each language’s conventions.
| Name | Location | Declared type | Required | Default |
|---|---|---|---|---|
tenant_id |
path | PathVar[str] |
Yes | Not specified |
folder_id |
path | PathVar[str] |
Yes | Not specified |
expected_revision |
query | QueryParam[int] |
Yes | Not specified |
Request and response¶
| Contract | Value |
|---|---|
| Request schema | No request schema declared |
| Response schema | No response body |
| Success status | 204 |
| Declared encoding | application/json |
Encoding identifies the upload, stream or download format when applicable; otherwise it is JSON. It is not a declaration that a GET request has a body.
Headers¶
No operation-specific headers are declared in the canonical metadata.
Authentication and resource bounds still apply. See request behavior and the SDK runtime reference.
Thread¶
GET /api/v1/tenants/{tenant_id}/chat/threads/{thread_id}
Contract operation: ChatHistoryController.thread.
| SDK | Method |
|---|---|
| Python | thread |
| TypeScript | chat.get |
| Java | client.chat.get |
Parameters¶
These are the declared path, query and body arguments. Multipart and binary inputs are described by their request schema below. SDK argument names may follow each language’s conventions.
| Name | Location | Declared type | Required | Default |
|---|---|---|---|---|
tenant_id |
path | PathVar[str] |
Yes | Not specified |
thread_id |
path | PathVar[str] |
Yes | Not specified |
Request and response¶
| Contract | Value |
|---|---|
| Request schema | No request schema declared |
| Response schema | ChatThread |
| Success status | 200 |
| Declared encoding | application/json |
Encoding identifies the upload, stream or download format when applicable; otherwise it is JSON. It is not a declaration that a GET request has a body.
Headers¶
No operation-specific headers are declared in the canonical metadata.
Authentication and resource bounds still apply. See request behavior and the SDK runtime reference.
Patch thread¶
PATCH /api/v1/tenants/{tenant_id}/chat/threads/{thread_id}
Contract operation: ChatHistoryController.patch_thread.
| SDK | Method |
|---|---|
| Python | update_thread |
| TypeScript | chat.update |
| Java | client.chat.update |
Parameters¶
These are the declared path, query and body arguments. Multipart and binary inputs are described by their request schema below. SDK argument names may follow each language’s conventions.
| Name | Location | Declared type | Required | Default |
|---|---|---|---|---|
tenant_id |
path | PathVar[str] |
Yes | Not specified |
thread_id |
path | PathVar[str] |
Yes | Not specified |
body |
body | Valid[Body[ThreadPatch]] |
Yes | Not specified |
Request and response¶
| Contract | Value |
|---|---|
| Request schema | ThreadPatch |
| Response schema | ChatThread |
| Success status | 200 |
| Declared encoding | application/json |
Encoding identifies the upload, stream or download format when applicable; otherwise it is JSON. It is not a declaration that a GET request has a body.
Headers¶
No operation-specific headers are declared in the canonical metadata.
Authentication and resource bounds still apply. See request behavior and the SDK runtime reference.
Title suggestion¶
POST /api/v1/tenants/{tenant_id}/chat/threads/{thread_id}/title-suggestion
Contract operation: ChatHistoryController.title_suggestion.
| SDK | Method |
|---|---|
| Python | suggest_title |
| TypeScript | chat.suggestTitle |
| Java | client.chat.suggestTitle |
Parameters¶
These are the declared path, query and body arguments. Multipart and binary inputs are described by their request schema below. SDK argument names may follow each language’s conventions.
| Name | Location | Declared type | Required | Default |
|---|---|---|---|---|
tenant_id |
path | PathVar[str] |
Yes | Not specified |
thread_id |
path | PathVar[str] |
Yes | Not specified |
body |
body | Valid[Body[TitleRequest]] |
Yes | Not specified |
Request and response¶
| Contract | Value |
|---|---|
| Request schema | TitleRequest |
| Response schema | TitleSuggestion |
| Success status | 200 |
| Declared encoding | application/json |
Encoding identifies the upload, stream or download format when applicable; otherwise it is JSON. It is not a declaration that a GET request has a body.
Headers¶
No operation-specific headers are declared in the canonical metadata.
Authentication and resource bounds still apply. See request behavior and the SDK runtime reference.
Delete thread¶
DELETE /api/v1/tenants/{tenant_id}/chat/threads/{thread_id}
Contract operation: ChatHistoryController.delete_thread.
| SDK | Method |
|---|---|
| Python | delete_thread |
| TypeScript | chat.delete |
| Java | client.chat.delete |
Parameters¶
These are the declared path, query and body arguments. Multipart and binary inputs are described by their request schema below. SDK argument names may follow each language’s conventions.
| Name | Location | Declared type | Required | Default |
|---|---|---|---|---|
tenant_id |
path | PathVar[str] |
Yes | Not specified |
thread_id |
path | PathVar[str] |
Yes | Not specified |
expected_revision |
query | QueryParam[int] |
Yes | Not specified |
Request and response¶
| Contract | Value |
|---|---|
| Request schema | No request schema declared |
| Response schema | No response body |
| Success status | 204 |
| Declared encoding | application/json |
Encoding identifies the upload, stream or download format when applicable; otherwise it is JSON. It is not a declaration that a GET request has a body.
Headers¶
No operation-specific headers are declared in the canonical metadata.
Authentication and resource bounds still apply. See request behavior and the SDK runtime reference.
Capabilities¶
GET /api/v1/tenants/{tenant_id}/chat/threads/{thread_id}/attachments/capabilities
Contract operation: ChatAttachmentsController.capabilities.
| SDK | Method |
|---|---|
| Python | attachment_capabilities |
| TypeScript | chat.attachments.capabilities |
| Java | client.chatAttachments.capabilities |
Parameters¶
These are the declared path, query and body arguments. Multipart and binary inputs are described by their request schema below. SDK argument names may follow each language’s conventions.
| Name | Location | Declared type | Required | Default |
|---|---|---|---|---|
tenant_id |
path | PathVar[str] |
Yes | Not specified |
thread_id |
path | PathVar[str] |
Yes | Not specified |
Request and response¶
| Contract | Value |
|---|---|
| Request schema | No request schema declared |
| Response schema | AttachmentCapabilities |
| Success status | 200 |
| Declared encoding | application/json |
Encoding identifies the upload, stream or download format when applicable; otherwise it is JSON. It is not a declaration that a GET request has a body.
Headers¶
No operation-specific headers are declared in the canonical metadata.
Authentication and resource bounds still apply. See request behavior and the SDK runtime reference.
Upload¶
POST /api/v1/tenants/{tenant_id}/chat/threads/{thread_id}/attachments
Contract operation: ChatAttachmentsController.upload.
| SDK | Method |
|---|---|
| Python | upload_attachment |
| TypeScript | chat.attachments.upload |
| Java | client.chatAttachments.upload |
Parameters¶
These are the declared path, query and body arguments. Multipart and binary inputs are described by their request schema below. SDK argument names may follow each language’s conventions.
| Name | Location | Declared type | Required | Default |
|---|---|---|---|---|
tenant_id |
path | PathVar[str] |
Yes | Not specified |
thread_id |
path | PathVar[str] |
Yes | Not specified |
Request and response¶
| Contract | Value |
|---|---|
| Request schema | AttachmentUpload |
| Response schema | AttachmentView |
| Success status | 202 |
| Declared encoding | multipart/form-data |
Encoding identifies the upload, stream or download format when applicable; otherwise it is JSON. It is not a declaration that a GET request has a body.
Headers¶
Idempotency-Key (required; caller-supplied stable operation key)
Authentication and resource bounds still apply. See request behavior and the SDK runtime reference.
List files¶
GET /api/v1/tenants/{tenant_id}/chat/threads/{thread_id}/attachments
Contract operation: ChatAttachmentsController.list_files.
| SDK | Method |
|---|---|
| Python | attachments |
| TypeScript | chat.attachments.list |
| Java | client.chatAttachments.list |
Parameters¶
These are the declared path, query and body arguments. Multipart and binary inputs are described by their request schema below. SDK argument names may follow each language’s conventions.
| Name | Location | Declared type | Required | Default |
|---|---|---|---|---|
tenant_id |
path | PathVar[str] |
Yes | Not specified |
thread_id |
path | PathVar[str] |
Yes | Not specified |
page |
query | QueryParam[int] |
No | 1 |
page_size |
query | QueryParam[int] |
No | 25 |
q |
query | QueryParam[str] |
No | "" |
status |
query | QueryParam[str | None] |
No | null |
kind |
query | QueryParam[str | None] |
No | null |
Request and response¶
| Contract | Value |
|---|---|
| Request schema | No request schema declared |
| Response schema | AttachmentPage |
| Success status | 200 |
| Declared encoding | application/json |
Encoding identifies the upload, stream or download format when applicable; otherwise it is JSON. It is not a declaration that a GET request has a body.
Headers¶
No operation-specific headers are declared in the canonical metadata.
Authentication and resource bounds still apply. See request behavior and the SDK runtime reference.
Get¶
GET /api/v1/tenants/{tenant_id}/chat/threads/{thread_id}/attachments/{attachment_id}
Contract operation: ChatAttachmentsController.get.
| SDK | Method |
|---|---|
| Python | attachment |
| TypeScript | chat.attachments.get |
| Java | client.chatAttachments.get |
Parameters¶
These are the declared path, query and body arguments. Multipart and binary inputs are described by their request schema below. SDK argument names may follow each language’s conventions.
| Name | Location | Declared type | Required | Default |
|---|---|---|---|---|
tenant_id |
path | PathVar[str] |
Yes | Not specified |
thread_id |
path | PathVar[str] |
Yes | Not specified |
attachment_id |
path | PathVar[str] |
Yes | Not specified |
Request and response¶
| Contract | Value |
|---|---|
| Request schema | No request schema declared |
| Response schema | AttachmentView |
| Success status | 200 |
| Declared encoding | application/json |
Encoding identifies the upload, stream or download format when applicable; otherwise it is JSON. It is not a declaration that a GET request has a body.
Headers¶
No operation-specific headers are declared in the canonical metadata.
Authentication and resource bounds still apply. See request behavior and the SDK runtime reference.
Original¶
GET /api/v1/tenants/{tenant_id}/chat/threads/{thread_id}/attachments/{attachment_id}/original
Contract operation: ChatAttachmentsController.original.
| SDK | Method |
|---|---|
| Python | attachment_original |
| TypeScript | chat.attachments.original |
| Java | client.chatAttachments.original |
Parameters¶
These are the declared path, query and body arguments. Multipart and binary inputs are described by their request schema below. SDK argument names may follow each language’s conventions.
| Name | Location | Declared type | Required | Default |
|---|---|---|---|---|
tenant_id |
path | PathVar[str] |
Yes | Not specified |
thread_id |
path | PathVar[str] |
Yes | Not specified |
attachment_id |
path | PathVar[str] |
Yes | Not specified |
Request and response¶
| Contract | Value |
|---|---|
| Request schema | No request schema declared |
| Response schema | BinaryDownload |
| Success status | 200 |
| Declared encoding | binary |
Encoding identifies the upload, stream or download format when applicable; otherwise it is JSON. It is not a declaration that a GET request has a body.
Headers¶
No operation-specific headers are declared in the canonical metadata.
Authentication and resource bounds still apply. See request behavior and the SDK runtime reference.
Chunks¶
GET /api/v1/tenants/{tenant_id}/chat/threads/{thread_id}/attachments/{attachment_id}/chunks
Contract operation: ChatAttachmentsController.chunks.
| SDK | Method |
|---|---|
| Python | attachment_chunks |
| TypeScript | chat.attachments.chunks |
| Java | client.chatAttachments.chunks |
Parameters¶
These are the declared path, query and body arguments. Multipart and binary inputs are described by their request schema below. SDK argument names may follow each language’s conventions.
| Name | Location | Declared type | Required | Default |
|---|---|---|---|---|
tenant_id |
path | PathVar[str] |
Yes | Not specified |
thread_id |
path | PathVar[str] |
Yes | Not specified |
attachment_id |
path | PathVar[str] |
Yes | Not specified |
page |
query | QueryParam[int] |
No | 1 |
page_size |
query | QueryParam[int] |
No | 25 |
q |
query | QueryParam[str] |
No | "" |
Request and response¶
| Contract | Value |
|---|---|
| Request schema | No request schema declared |
| Response schema | PrivateChunkPage |
| Success status | 200 |
| Declared encoding | application/json |
Encoding identifies the upload, stream or download format when applicable; otherwise it is JSON. It is not a declaration that a GET request has a body.
Headers¶
No operation-specific headers are declared in the canonical metadata.
Authentication and resource bounds still apply. See request behavior and the SDK runtime reference.
Cancel¶
POST /api/v1/tenants/{tenant_id}/chat/threads/{thread_id}/attachments/{attachment_id}/cancel
Contract operation: ChatAttachmentsController.cancel.
| SDK | Method |
|---|---|
| Python | cancel_attachment |
| TypeScript | chat.attachments.cancel |
| Java | client.chatAttachments.cancel |
Parameters¶
These are the declared path, query and body arguments. Multipart and binary inputs are described by their request schema below. SDK argument names may follow each language’s conventions.
| Name | Location | Declared type | Required | Default |
|---|---|---|---|---|
tenant_id |
path | PathVar[str] |
Yes | Not specified |
thread_id |
path | PathVar[str] |
Yes | Not specified |
attachment_id |
path | PathVar[str] |
Yes | Not specified |
body |
body | Valid[Body[AttachmentRevision]] |
Yes | Not specified |
Request and response¶
| Contract | Value |
|---|---|
| Request schema | AttachmentRevision |
| Response schema | AttachmentView |
| Success status | 200 |
| Declared encoding | application/json |
Encoding identifies the upload, stream or download format when applicable; otherwise it is JSON. It is not a declaration that a GET request has a body.
Headers¶
No operation-specific headers are declared in the canonical metadata.
Authentication and resource bounds still apply. See request behavior and the SDK runtime reference.
Retry¶
POST /api/v1/tenants/{tenant_id}/chat/threads/{thread_id}/attachments/{attachment_id}/retry
Contract operation: ChatAttachmentsController.retry.
| SDK | Method |
|---|---|
| Python | retry_attachment |
| TypeScript | chat.attachments.retry |
| Java | client.chatAttachments.retry |
Parameters¶
These are the declared path, query and body arguments. Multipart and binary inputs are described by their request schema below. SDK argument names may follow each language’s conventions.
| Name | Location | Declared type | Required | Default |
|---|---|---|---|---|
tenant_id |
path | PathVar[str] |
Yes | Not specified |
thread_id |
path | PathVar[str] |
Yes | Not specified |
attachment_id |
path | PathVar[str] |
Yes | Not specified |
body |
body | Valid[Body[AttachmentRevision]] |
Yes | Not specified |
Request and response¶
| Contract | Value |
|---|---|
| Request schema | AttachmentRevision |
| Response schema | AttachmentView |
| Success status | 202 |
| Declared encoding | application/json |
Encoding identifies the upload, stream or download format when applicable; otherwise it is JSON. It is not a declaration that a GET request has a body.
Headers¶
Idempotency-Key (required; caller-supplied stable operation key)
Authentication and resource bounds still apply. See request behavior and the SDK runtime reference.
Delete¶
DELETE /api/v1/tenants/{tenant_id}/chat/threads/{thread_id}/attachments/{attachment_id}
Contract operation: ChatAttachmentsController.delete.
| SDK | Method |
|---|---|
| Python | remove_attachment |
| TypeScript | chat.attachments.remove |
| Java | client.chatAttachments.remove |
Parameters¶
These are the declared path, query and body arguments. Multipart and binary inputs are described by their request schema below. SDK argument names may follow each language’s conventions.
| Name | Location | Declared type | Required | Default |
|---|---|---|---|---|
tenant_id |
path | PathVar[str] |
Yes | Not specified |
thread_id |
path | PathVar[str] |
Yes | Not specified |
attachment_id |
path | PathVar[str] |
Yes | Not specified |
expected_revision |
query | QueryParam[int] |
Yes | Not specified |
Request and response¶
| Contract | Value |
|---|---|
| Request schema | No request schema declared |
| Response schema | No response body |
| Success status | 204 |
| Declared encoding | application/json |
Encoding identifies the upload, stream or download format when applicable; otherwise it is JSON. It is not a declaration that a GET request has a body.
Headers¶
No operation-specific headers are declared in the canonical metadata.
Authentication and resource bounds still apply. See request behavior and the SDK runtime reference.
Knowledge¶
POST /api/v1/tenants/{tenant_id}/chat/threads/{thread_id}/attachments/{attachment_id}/knowledge
Contract operation: ChatAttachmentsController.knowledge.
| SDK | Method |
|---|---|
| Python | promote_attachment |
| TypeScript | chat.attachments.promote |
| Java | client.chatAttachments.promote |
Parameters¶
These are the declared path, query and body arguments. Multipart and binary inputs are described by their request schema below. SDK argument names may follow each language’s conventions.
| Name | Location | Declared type | Required | Default |
|---|---|---|---|---|
tenant_id |
path | PathVar[str] |
Yes | Not specified |
thread_id |
path | PathVar[str] |
Yes | Not specified |
attachment_id |
path | PathVar[str] |
Yes | Not specified |
body |
body | Valid[Body[AttachmentPromotionInput]] |
Yes | Not specified |
Request and response¶
| Contract | Value |
|---|---|
| Request schema | AttachmentPromotionInput |
| Response schema | AttachmentPromotionView |
| Success status | 201 |
| Declared encoding | application/json |
Encoding identifies the upload, stream or download format when applicable; otherwise it is JSON. It is not a declaration that a GET request has a body.
Headers¶
Idempotency-Key (required; caller-supplied stable operation key)
Authentication and resource bounds still apply. See request behavior and the SDK runtime reference.
Get¶
GET /api/v1/tenants/{tenant_id}/chat/settings
Contract operation: OrganizationChatController.get.
| SDK | Method |
|---|---|
| Python | organization_chat_settings |
| TypeScript | organizationChat.get |
| Java | client.organizationChat.get |
Parameters¶
These are the declared path, query and body arguments. Multipart and binary inputs are described by their request schema below. SDK argument names may follow each language’s conventions.
| Name | Location | Declared type | Required | Default |
|---|---|---|---|---|
tenant_id |
path | PathVar[str] |
Yes | Not specified |
workspace_id |
query | QueryParam[str | None] |
No | null |
project_id |
query | QueryParam[str | None] |
No | null |
Request and response¶
| Contract | Value |
|---|---|
| Request schema | No request schema declared |
| Response schema | OrganizationChatSettings |
| Success status | 200 |
| Declared encoding | application/json |
Encoding identifies the upload, stream or download format when applicable; otherwise it is JSON. It is not a declaration that a GET request has a body.
Headers¶
No operation-specific headers are declared in the canonical metadata.
Authentication and resource bounds still apply. See request behavior and the SDK runtime reference.
Update¶
PUT /api/v1/tenants/{tenant_id}/chat/settings
Contract operation: OrganizationChatController.update.
| SDK | Method |
|---|---|
| Python | update_organization_chat_settings |
| TypeScript | organizationChat.update |
| Java | client.organizationChat.update |
Parameters¶
These are the declared path, query and body arguments. Multipart and binary inputs are described by their request schema below. SDK argument names may follow each language’s conventions.
| Name | Location | Declared type | Required | Default |
|---|---|---|---|---|
tenant_id |
path | PathVar[str] |
Yes | Not specified |
body |
body | Valid[Body[OrganizationChatSettingsInput]] |
Yes | Not specified |
Request and response¶
| Contract | Value |
|---|---|
| Request schema | OrganizationChatSettingsInput |
| Response schema | OrganizationChatSettings |
| Success status | 200 |
| Declared encoding | application/json |
Encoding identifies the upload, stream or download format when applicable; otherwise it is JSON. It is not a declaration that a GET request has a body.
Headers¶
No operation-specific headers are declared in the canonical metadata.
Authentication and resource bounds still apply. See request behavior and the SDK runtime reference.