Authentication
All endpoints require JWT authentication via theAuthorization header:
List Conversations
Query Parameters
Number of conversations to return per page (max 100)
Pagination cursor from previous response’s
nextCursorFilter by archived status (true/false)
Sort field:
updatedAt, createdAt, or titleSort direction:
asc or descFilter by conversation tags (can be multiple)
Search query to filter conversations by title or content
Response
Array of conversation objects
Cursor for next page, null if no more results
Get Conversation
Path Parameters
The conversation ID to retrieve
Response
Returns a complete conversation object with all settings and metadata.Unique conversation identifier
Conversation title
Model endpoint (e.g., “openAI”, “anthropic”, “agents”)
Model name used in the conversation
Model temperature parameter
ISO 8601 timestamp
ISO 8601 timestamp
Error Responses
- 404 Not Found: Conversation does not exist or user lacks access
Get Generated Title
Path Parameters
The conversation ID
Response
The generated conversation title
Error Responses
- 404 Not Found: Title generation not available or method not implemented for the conversation’s endpoint
Update Conversation Title
Request Body
The conversation ID to update
New title (max 1024 characters, will be trimmed and sanitized)
Response
Returns the updated conversation object.Error Responses
- 400 Bad Request: Missing or invalid parameters
- 403 Forbidden: User lacks access to the conversation
- 500 Internal Server Error: Update failed
Archive/Unarchive Conversation
Request Body
The conversation ID
Set to
true to archive, false to unarchiveResponse
Returns the updated conversation object.Error Responses
- 400 Bad Request: Missing or invalid parameters
- 403 Forbidden: User lacks access to the conversation
- 500 Internal Server Error: Operation failed
Delete Conversation
Request Body
The conversation ID to delete
Thread ID for Assistants API conversations (optional)
Endpoint type (required if deleting Assistant thread)
Source of deletion request (e.g., “button”)
Response
Returns deletion confirmation with the number of deleted documents.Error Responses
- 400 Bad Request: No parameters provided
- 500 Internal Server Error: Deletion failed
Delete All Conversations
Response
Returns deletion confirmation with the number of deleted documents.Error Responses
- 500 Internal Server Error: Deletion failed
Fork Conversation
Request Body
Source conversation ID
Target message ID to fork from
Fork option: “branch” or “direct”
Whether to split at the target message
Latest message ID in the conversation
Response
The newly created forked conversation
Messages copied to the forked conversation
Error Responses
- 429 Too Many Requests: Rate limit exceeded
- 500 Internal Server Error: Fork operation failed
Duplicate Conversation
Request Body
The conversation ID to duplicate
Optional title for the duplicated conversation
Response
Returns the newly created conversation object with duplicated messages.Error Responses
- 500 Internal Server Error: Duplication failed
Import Conversations
Request
Multipart form data with a single file field.JSON file containing conversation data
Response
Success message: “Conversation(s) imported successfully”
Error Responses
- 429 Too Many Requests: Rate limit exceeded
- 500 Internal Server Error: Import failed
Common Error Codes
| Status Code | Description |
|---|---|
| 400 | Bad Request - Invalid parameters or missing required fields |
| 401 | Unauthorized - Invalid or missing JWT token |
| 403 | Forbidden - User lacks permission to access the conversation |
| 404 | Not Found - Conversation does not exist |
| 429 | Too Many Requests - Rate limit exceeded |
| 500 | Internal Server Error - Server-side error occurred |