{ "opencollection": "1.0.0", "info": { "name": "Crowdbotics API Documentation admin conversations API", "version": "1.26.2" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "conversations", "type": "folder" }, "items": [ { "info": { "name": "Get all Project's conversations for a User with pagination", "type": "http" }, "http": { "method": "GET", "url": "/api/projects/:project_id/chat/conversations/", "params": [ { "name": "project_id", "value": "", "type": "path" }, { "name": "limit", "value": "", "type": "query", "description": "Number of items per page" }, { "name": "offset", "value": "", "type": "query", "description": "Number of items to skip" } ] }, "docs": "Retrieve all conversations related to the Project for a User with pagination support and optional filtering" }, { "info": { "name": "Create a new conversation", "type": "http" }, "http": { "method": "POST", "url": "/api/projects/:project_id/chat/conversations/", "params": [ { "name": "project_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new conversation for a specific project and user" }, { "info": { "name": "DEPRECATED: Get all Project's conversations for a User with pagination", "type": "http" }, "http": { "method": "GET", "url": "/api/projects/:project_id/chat/conversations/list", "params": [ { "name": "project_id", "value": "", "type": "path" }, { "name": "limit", "value": "", "type": "query", "description": "Number of items per page" }, { "name": "offset", "value": "", "type": "query", "description": "Number of items to skip" } ] }, "docs": "DEPRECATED: Use GET / instead. Retrieve all conversations related to the Project for a User." }, { "info": { "name": "Get conversation details with settings and metadata", "type": "http" }, "http": { "method": "GET", "url": "/api/projects/:project_id/chat/conversations/:conversation_id", "params": [ { "name": "conversation_id", "value": "", "type": "path" }, { "name": "project_id", "value": "", "type": "path" } ] }, "docs": "Retrieve details for a specific conversation including settings, message metadata, and messages (deprecated)." }, { "info": { "name": "Update conversation", "type": "http" }, "http": { "method": "PATCH", "url": "/api/projects/:project_id/chat/conversations/:conversation_id", "params": [ { "name": "project_id", "value": "", "type": "path" }, { "name": "conversation_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Partially update conversation fields (title, read_only status, and/or settings)" }, { "info": { "name": "Delete a conversation", "type": "http" }, "http": { "method": "DELETE", "url": "/api/projects/:project_id/chat/conversations/:conversation_id", "params": [ { "name": "project_id", "value": "", "type": "path" }, { "name": "conversation_id", "value": "", "type": "path" } ] }, "docs": "Delete a specific conversation and its associated chat messages" }, { "info": { "name": "Get all chat messages for a conversation", "type": "http" }, "http": { "method": "GET", "url": "/api/projects/:project_id/chat/conversations/:conversation_id/messages", "params": [ { "name": "project_id", "value": "", "type": "path" }, { "name": "conversation_id", "value": "", "type": "path" } ] }, "docs": "Retrieve all chat messages associated with a specific conversation" }, { "info": { "name": "Add Chat Message", "type": "http" }, "http": { "method": "POST", "url": "/api/projects/:project_id/chat/conversations/:conversation_id/messages", "params": [ { "name": "project_id", "value": "", "type": "path" }, { "name": "conversation_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add a new chat message to a specific conversation.\nArgs:\n project_id: The ID of the project the conversation belongs to\n conversation_id: The ID of the conversation to add a message to\n data: QueryRequest object containing the message content (query and optional reasoning_mode)\n user: The authenticated user\n organization: The current Organization of the user\n\nReturns:\n ChatMessageResponse: Details of the created chat message\n\nRaises:\n HTTPException 422: If reasoning_mode=Tru" }, { "info": { "name": "Clear all messages from a conversation", "type": "http" }, "http": { "method": "DELETE", "url": "/api/projects/:project_id/chat/conversations/:conversation_id/messages", "params": [ { "name": "conversation_id", "value": "", "type": "path" }, { "name": "project_id", "value": "", "type": "path" } ] }, "docs": "Delete all chat messages from a specific conversation. Useful for testing or starting fresh while keeping the conversation and its settings." }, { "info": { "name": "Get source files for a chat message", "type": "http" }, "http": { "method": "GET", "url": "/api/projects/:project_id/chat/conversations/:conversation_id/messages/:message_id/sources", "params": [ { "name": "project_id", "value": "", "type": "path" }, { "name": "conversation_id", "value": "", "type": "path" }, { "name": "message_id", "value": "", "type": "path" } ] }, "docs": "Retrieve all source file references associated with a specific chat message." }, { "info": { "name": "Submit feedback on a chat message", "type": "http" }, "http": { "method": "PATCH", "url": "/api/projects/:project_id/chat/conversations/:conversation_id/messages/:message_id/feedback", "params": [ { "name": "project_id", "value": "", "type": "path" }, { "name": "conversation_id", "value": "", "type": "path" }, { "name": "message_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create or update user feedback (thumbs up/down) on a specific assistant message." }, { "info": { "name": "Get conversation settings", "type": "http" }, "http": { "method": "GET", "url": "/api/projects/:project_id/chat/conversations/:conversation_id/settings", "params": [ { "name": "conversation_id", "value": "", "type": "path" }, { "name": "project_id", "value": "", "type": "path" } ] }, "docs": "Retrieve persona and context scope settings for a conversation. DEPRECATED: Settings are now embedded in ConversationResponse from GET /{conversation_id}." }, { "info": { "name": "Update conversation settings", "type": "http" }, "http": { "method": "PATCH", "url": "/api/projects/:project_id/chat/conversations/:conversation_id/settings", "params": [ { "name": "conversation_id", "value": "", "type": "path" }, { "name": "project_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update persona and/or context scope for a conversation. DEPRECATED: Use PATCH /{conversation_id} instead." }, { "info": { "name": "Generate a shareable link for a conversation", "type": "http" }, "http": { "method": "PATCH", "url": "/api/projects/:project_id/chat/conversations/:conversation_id/export", "params": [ { "name": "project_id", "value": "", "type": "path" }, { "name": "conversation_id", "value": "", "type": "path" } ] }, "docs": "Create a shareable link that allows other users to import this conversation. The conversation will be marked as shared (is_shared=True). If the conversation was previously imported, returns the link to the original conversation." }, { "info": { "name": "Import a shared conversation into your account", "type": "http" }, "http": { "method": "GET", "url": "/api/projects/:project_id/chat/conversations/:conversation_id/import", "params": [ { "name": "project_id", "value": "", "type": "path" }, { "name": "conversation_id", "value": "", "type": "path" } ] }, "docs": "Import a shared conversation, creating a read-only copy with all messages. The imported conversation will have 'Shared - ' prefix and cannot be edited. If already imported, returns the existing copy without creating a duplicate." }, { "info": { "name": "DEPRECATED: Create a new conversation", "type": "http" }, "http": { "method": "POST", "url": "/api/projects/:project_id/chat/conversations/create-conversation", "params": [ { "name": "project_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "DEPRECATED: Use POST / instead. Create a new conversation for a specific project and user." }, { "info": { "name": "DEPRECATED: Add a chat message to a conversation", "type": "http" }, "http": { "method": "POST", "url": "/api/projects/:project_id/chat/conversations/:conversation_id/new-message", "params": [ { "name": "project_id", "value": "", "type": "path" }, { "name": "conversation_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "DEPRECATED: Use POST /{conversation_id}/messages instead." } ] } ], "bundled": true }