Skip to main content

Chat API

Ask questions about your knowledge base using an AI agent with optional filtering to focus the search context.

POST /api/v1/chat

Authentication: Project API Key from https://platform.useskald.com Request (using Project API Key):
Request (using Token Authentication):
Parameters:
  • query (string, required): The question to ask
  • project_id (UUID, optional): Only required when using Token Authentication
  • stream (boolean, optional): Enable streaming responses (default: false)
  • system_prompt (string, optional): A system prompt to guide the chat agent’s behavior
  • filters (array of filter objects, optional): Filters to narrow the search context. See Filters for detailed documentation.
Filter Support: Filters are applied during the initial retrieval of relevant context, allowing you to:
  • Filter by a “workspace” or “team” ID from your side
  • Focus the chat on specific sources (e.g., only Notion docs)
  • Query only memos with certain tags
  • Exclude certain categories of content
See Filters for complete documentation on filter structure, operators, and examples. Response (Non-streaming):
Response (Streaming): When stream: true, returns Server-Sent Events:

GET /api/v1/chat

Get a list of chats. Authentication: Project API Key from https://platform.useskald.com Query Parameters:
  • page (integer, optional): Page number (default: 1)
  • page_size (integer, optional): Page size (default: 20)
Example Response:
  • Count: The total number of chats
  • Page: The page number
  • Page size: The number of chats per page
  • Total pages: The total number of pages

GET /api/v1/chat/:chat_uuid

Get a chat by its UUID. Authentication: Project API Key from https://platform.useskald.com Path Parameters:
  • :chat_uuid (string, required): The UUID of the chat
Example Response:

Error Responses

Missing query (400):
Invalid filters (400):
Invalid filter structure (400):
Agent error (500):