# ReyGrid Docs

> Documentation for the ReyGrid RAG platform: REST API and the official Python and TypeScript SDKs.

- [ReyGrid Documentation](https://docs.reygrid.com/index.md): Build with the ReyGrid RAG platform API: chat with RAG agents, manage persistent conversations, and integrate through the official Python and TypeScript SDKs.
- [Quickstart](https://docs.reygrid.com/quickstart.md): Validate your API key and send your first message to a ReyGrid agent in a few minutes.
- [REST API overview](https://docs.reygrid.com/rest-api/overview.md): Base URL, request and response format, pagination, and an overview of every ReyGrid API endpoint.
- [Authentication](https://docs.reygrid.com/rest-api/authentication.md): Authenticate ReyGrid API requests with a Bearer API key.
- [Errors](https://docs.reygrid.com/rest-api/errors.md): HTTP status codes and error payloads returned by the ReyGrid API.
- [Persistent conversations](https://docs.reygrid.com/rest-api/conversations.md): Keep one ReyGrid conversation per user with userId or conversationId.
- [Streaming](https://docs.reygrid.com/rest-api/streaming.md): Receive ReyGrid chat replies as Server-Sent Events by setting stream to true.
- [Tool calling](https://docs.reygrid.com/rest-api/tool-calling.md): Define tools on a chat request, send tool results back, and cancel tool calls.
- [Knowledge & search](https://docs.reygrid.com/rest-api/knowledge.md): Manage an agent's knowledge from your code and search it without generating an answer.
- [Webhooks](https://docs.reygrid.com/rest-api/webhooks/overview.md): Get notified on your server when something happens in your ReyGrid account.
- [Webhook events](https://docs.reygrid.com/rest-api/webhooks/events.md): Every webhook event ReyGrid sends, and what's inside it.
- [Verifying signatures](https://docs.reygrid.com/rest-api/webhooks/verifying.md): Check that a webhook request really comes from ReyGrid and hasn't been tampered with.
- [Health check](https://docs.reygrid.com/api-reference/health-check.md): Checks whether the ReyGrid API is operational.
- [Validate API key](https://docs.reygrid.com/api-reference/validate-api-key.md): Validates the provided API key and returns usage information when the key is valid.
- [Get usage](https://docs.reygrid.com/api-reference/get-usage.md): Returns your credit balance and API usage over the last N days (UTC calendar days, today included): totals, a daily series and the busiest agents.
- [List models](https://docs.reygrid.com/api-reference/list-models.md): Returns every model with its price per message and whether your plan can use it.
- [Chat with an agent](https://docs.reygrid.com/api-reference/chat-with-an-agent.md): Sends a message to an agent.
- [List agents](https://docs.reygrid.com/api-reference/list-agents.md): Returns the agents this API key can use: every agent of the key's owner, or only the agents the key is restricted to.
- [Get an agent](https://docs.reygrid.com/api-reference/get-an-agent.md): Returns an agent with the number of knowledge sources of each type and its storage usage.
- [Update an agent](https://docs.reygrid.com/api-reference/update-an-agent.md): Updates the agent's name, instructions or model. Send only the fields to change.
- [List knowledge sources](https://docs.reygrid.com/api-reference/list-knowledge-sources.md): Returns the agent's knowledge sources, newest first.
- [Add a text source](https://docs.reygrid.com/api-reference/add-a-text-source.md): Adds a titled piece of text to the agent's knowledge.
- [Add a Q&A source](https://docs.reygrid.com/api-reference/add-a-q&a-source.md): Adds a question and its exact answer to the agent's knowledge.
- [Upload a file](https://docs.reygrid.com/api-reference/upload-a-file.md): Uploads a PDF, DOC, DOCX or TXT file (as large as the agent's remaining storage). The file is split into chunks and indexed before the response is returned.
- [Crawl a website](https://docs.reygrid.com/api-reference/crawl-a-website.md): Crawls the website from the given URL, following links on the same domain, and indexes each page. Pages already crawled are skipped. The crawl stops at your plan's page or storage limit. The request returns when the crawl is finished.
- [Delete a source](https://docs.reygrid.com/api-reference/delete-a-source.md): Removes a source and everything indexed from it (all chunks of a file or page).
- [Search knowledge](https://docs.reygrid.com/api-reference/search-knowledge.md): Returns the knowledge passages closest to a query, best match first, without generating an answer. Use it to build your own retrieval flows or "related articles". No model is called: each search costs a flat 0.2 credits.
- [List agent conversations](https://docs.reygrid.com/api-reference/list-agent-conversations.md): Returns a paginated list of conversations belonging to the agent.
- [Delete a conversation](https://docs.reygrid.com/api-reference/delete-a-conversation.md): Deletes all messages belonging to a conversation.
- [List conversation messages](https://docs.reygrid.com/api-reference/list-conversation-messages.md): Returns a paginated list of messages.
- [Delete a message](https://docs.reygrid.com/api-reference/delete-a-message.md): Deletes a specific message.
- [Rate a reply](https://docs.reygrid.com/api-reference/rate-a-reply.md): Records a thumbs up or down (and an optional comment) on an assistant message. Sending it again replaces the previous rating.
- [Cancel a tool call](https://docs.reygrid.com/api-reference/cancel-a-tool-call.md): Cancels a tool call belonging to a conversation.
- [Integrations overview](https://docs.reygrid.com/integrations/overview.md): Official ReyGrid SDKs for Python and TypeScript, and the n8n community node.
- [Installation](https://docs.reygrid.com/integrations/python/installation.md): Install the ReyGrid Python SDK from PyPI.
- [Quickstart](https://docs.reygrid.com/integrations/python/quickstart.md): From pip install to your first ReyGrid chat reply with the Python SDK.
- [Configuration](https://docs.reygrid.com/integrations/python/configuration.md): Client options for the ReyGrid Python SDK: API key, base URL, headers, timeout, and custom httpx clients.
- [Authentication](https://docs.reygrid.com/integrations/python/authentication.md): Authenticate the ReyGrid Python SDK with an API key.
- [Usage](https://docs.reygrid.com/integrations/python/usage.md): Reference for every ReyGrid Python SDK client method: chat, conversations, messages, pagination, and tool calls.
- [Streaming](https://docs.reygrid.com/integrations/python/streaming.md): Stream ReyGrid chat replies in Python with stream_chat and async_stream_chat.
- [Error handling](https://docs.reygrid.com/integrations/python/error-handling.md): Exception types raised by the ReyGrid Python SDK and how to handle them.
- [Installation](https://docs.reygrid.com/integrations/typescript/installation.md): Install the ReyGrid TypeScript SDK from npm.
- [Quickstart](https://docs.reygrid.com/integrations/typescript/quickstart.md): From npm install to your first ReyGrid chat reply with the TypeScript SDK.
- [Configuration](https://docs.reygrid.com/integrations/typescript/configuration.md): Client options for the ReyGrid TypeScript SDK: API key, base URL, headers, timeout, custom fetch, and error hook.
- [Authentication](https://docs.reygrid.com/integrations/typescript/authentication.md): Authenticate the ReyGrid TypeScript SDK with an API key.
- [Usage](https://docs.reygrid.com/integrations/typescript/usage.md): Reference for every ReyGrid TypeScript SDK client method: chat, conversations, messages, pagination, and tool calls.
- [Streaming](https://docs.reygrid.com/integrations/typescript/streaming.md): Stream ReyGrid chat replies in TypeScript with streamChat and the SSE helpers.
- [Error handling](https://docs.reygrid.com/integrations/typescript/error-handling.md): Error classes thrown by the ReyGrid TypeScript SDK and how to handle them.
- [N8N Node](https://docs.reygrid.com/integrations/n8n/n8n-nodes-reygrid.md): Install the ReyGrid community node in n8n to chat with your RAG agents, run connected AI tools automatically, and cancel tool calls.

## OpenAPI Specs

- [openapi](/openapi.yaml)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.