Overview
The Chat API enables conversational interactions with your research notebooks. Send messages and receive AI-generated responses based on the notebook’s research content using vector search and retrieval-augmented generation (RAG).Send Chat Message
POST /chat/message
Send a chat message and receive an AI-generated response
Request
Array of chat messages in the conversation
The ID of the notebook to query against
Optional additional metadata for the message
Response
Status of the request:
successThe AI-generated response to your message
Example Request
Example Response
Multi-turn Conversation
The API supports multi-turn conversations by passing the full message history:Example with Metadata
Error Responses
How It Works
- Vector Search: Your message is used to search the notebook’s research content using semantic similarity
- Context Retrieval: Relevant research sections are retrieved from the vector database
- AI Generation: The chat agent generates a response using the retrieved context and conversation history
- Response: The generated answer is returned, grounded in your notebook’s research
Best Practices
- Be Specific: Ask specific questions about the research topic for more focused answers
- Maintain Context: Include previous messages for coherent multi-turn conversations
- Notebook Scope: Questions are answered based only on the specified notebook’s research content
- Error Handling: Implement retry logic for 500 errors as they may be transient