# ChatGrid API

## Docs

- [Delete an asset](https://docs.chatgrid.ai/api-reference/assets/delete-an-asset.md): Permanently deletes a file from board storage.
- [Delete Asset](https://docs.chatgrid.ai/api-reference/assets/delete-asset.md): Permanently deletes a file from board storage.
- [List assets](https://docs.chatgrid.ai/api-reference/assets/list-assets.md): Returns all files uploaded to a board.
- [Upload a file](https://docs.chatgrid.ai/api-reference/assets/upload-a-file.md): Uploads a file to a board's asset storage. Accepts `multipart/form-data` with a `file` field. Maximum file size is 50 MB.
- [Upload Asset](https://docs.chatgrid.ai/api-reference/assets/upload-asset.md): Upload a file to a board's asset storage.
- [Create a board](https://docs.chatgrid.ai/api-reference/boards/create-a-board.md): Creates a new board. Defaults to canvas view mode.
- [Create Board](https://docs.chatgrid.ai/api-reference/boards/create-board.md): Creates a new board. Defaults to canvas view mode.
- [Delete a board](https://docs.chatgrid.ai/api-reference/boards/delete-a-board.md): Permanently deletes a board and all of its nested resources (nodes, edges, chats, messages, documents, assets).
- [Delete Board](https://docs.chatgrid.ai/api-reference/boards/delete-board.md): Permanently deletes a board and all nested resources.
- [Duplicate a board](https://docs.chatgrid.ai/api-reference/boards/duplicate-a-board.md): Creates a copy of a board including its full flow state. Works for boards you own and public boards. The copy is always owned by the authenticated user. The name is suffixed with " (Copy)".
- [Duplicate Board](https://docs.chatgrid.ai/api-reference/boards/duplicate-board.md): Creates a copy of a board including its full canvas state.
- [Get a board](https://docs.chatgrid.ai/api-reference/boards/get-a-board.md): Retrieves a board by ID. Returns the full board including `flow_state` for boards you own. Public boards return a lightweight view without `flow_state`.
- [Get Board](https://docs.chatgrid.ai/api-reference/boards/get-board.md): Retrieves a board by ID, including full flow state for boards you own.
- [List boards](https://docs.chatgrid.ai/api-reference/boards/list-boards.md): Returns a paginated list of boards owned by the authenticated user, ordered by creation date.
- [Update a board](https://docs.chatgrid.ai/api-reference/boards/update-a-board.md): Updates a board's name or viewport settings. Only the provided fields are changed.
- [Update Board](https://docs.chatgrid.ai/api-reference/boards/update-board.md): Updates a board's name or viewport settings.
- [Create a chat](https://docs.chatgrid.ai/api-reference/chats/create-a-chat.md): Creates a new chat thread on a board, optionally linked to a node.
- [Create Chat](https://docs.chatgrid.ai/api-reference/chats/create-chat.md): Creates a new chat thread on a board.
- [Delete a chat](https://docs.chatgrid.ai/api-reference/chats/delete-a-chat.md): Permanently deletes a chat thread and all its messages (via database cascade).
- [Delete Chat](https://docs.chatgrid.ai/api-reference/chats/delete-chat.md): Permanently deletes a chat thread and all its messages.
- [Get a chat](https://docs.chatgrid.ai/api-reference/chats/get-a-chat.md): Retrieves a single chat thread including its memory and metadata.
- [Get Chat](https://docs.chatgrid.ai/api-reference/chats/get-chat.md): Retrieves a single chat thread including memory and metadata.
- [List chats](https://docs.chatgrid.ai/api-reference/chats/list-chats.md): Returns a paginated list of chat threads on a board.
- [Update a chat](https://docs.chatgrid.ai/api-reference/chats/update-a-chat.md): Updates a chat thread's title or node association.
- [Update Chat](https://docs.chatgrid.ai/api-reference/chats/update-chat.md): Updates a chat thread's title or node association.
- [Process Document](https://docs.chatgrid.ai/api-reference/documents/process.md): Queue a document for asynchronous processing (parsing, OCR).
- [Process a document](https://docs.chatgrid.ai/api-reference/documents/process-a-document.md): Queues a document for asynchronous processing (parsing, OCR, etc.). Returns a job object you can poll via the Jobs endpoints.
- [Semantic Search](https://docs.chatgrid.ai/api-reference/documents/search.md): Search vectorized document chunks using natural language queries.
- [Semantic search](https://docs.chatgrid.ai/api-reference/documents/semantic-search.md): Performs a semantic similarity search across a board's vectorized document chunks. Returns the most relevant chunks ranked by similarity score.
- [Vectorize Content](https://docs.chatgrid.ai/api-reference/documents/vectorize.md): Chunks text, generates embeddings, and stores vectors for semantic search.
- [Vectorize content](https://docs.chatgrid.ai/api-reference/documents/vectorize-content.md): Chunks text content, generates embeddings, and stores the vectors in the board's document store. Useful for making content searchable via semantic search.
- [Create an edge](https://docs.chatgrid.ai/api-reference/edges/create-an-edge.md): Creates a connection between two nodes on the same board. Both nodes must exist.
- [Create Edge](https://docs.chatgrid.ai/api-reference/edges/create-edge.md): Creates a connection between two nodes on the same board.
- [Delete an edge](https://docs.chatgrid.ai/api-reference/edges/delete-an-edge.md): Permanently deletes an edge from the board.
- [Delete Edge](https://docs.chatgrid.ai/api-reference/edges/delete-edge.md): Permanently deletes an edge from the board.
- [List edges](https://docs.chatgrid.ai/api-reference/edges/list-edges.md): Returns a paginated list of edges on a board. Optionally filter by source or target node.
- [Update an edge](https://docs.chatgrid.ai/api-reference/edges/update-an-edge.md): Updates an edge's type or metadata.
- [Update Edge](https://docs.chatgrid.ai/api-reference/edges/update-edge.md): Updates an edge's type or metadata.
- [Get a job](https://docs.chatgrid.ai/api-reference/jobs/get-a-job.md): Retrieves the status and result of a background job.
- [Get Job](https://docs.chatgrid.ai/api-reference/jobs/get-job.md): Retrieves the status and result of a background job.
- [List jobs](https://docs.chatgrid.ai/api-reference/jobs/list-jobs.md): Returns all background jobs for the authenticated user. Optionally filter by status.
- [Create an API key](https://docs.chatgrid.ai/api-reference/me/create-an-api-key.md): Creates a new API key. The full key is returned **only once** in the `raw_key` field -- store it securely. Requires `admin` scope.
- [Create API Key](https://docs.chatgrid.ai/api-reference/me/create-api-key.md): Creates a new API key. The full key is returned only once.
- [Get credit usage](https://docs.chatgrid.ai/api-reference/me/get-credit-usage.md): Returns the authenticated user's credit balance and usage details.
- [Get current user](https://docs.chatgrid.ai/api-reference/me/get-current-user.md): Returns the authenticated user's profile.
- [Get Profile](https://docs.chatgrid.ai/api-reference/me/get-profile.md): Returns the authenticated user's profile.
- [Get Usage](https://docs.chatgrid.ai/api-reference/me/get-usage.md): Returns the authenticated user's credit balance and usage details.
- [List API keys](https://docs.chatgrid.ai/api-reference/me/list-api-keys.md): Returns all non-revoked API keys for the authenticated user. Requires `admin` scope.
- [Revoke an API key](https://docs.chatgrid.ai/api-reference/me/revoke-an-api-key.md): Revokes an API key, making it permanently unusable. This action cannot be undone. Requires `admin` scope.
- [Revoke API Key](https://docs.chatgrid.ai/api-reference/me/revoke-api-key.md): Permanently revokes an API key.
- [List messages](https://docs.chatgrid.ai/api-reference/messages/list-messages.md): Returns a paginated list of messages in a chat thread. Default order is `asc` (chronological) unlike other list endpoints.
- [Send a message](https://docs.chatgrid.ai/api-reference/messages/send-a-message.md): Sends a user message and receives an AI-generated response. Set `stream: true` to receive the response as Server-Sent Events (SSE).
- [Send Message](https://docs.chatgrid.ai/api-reference/messages/send-message.md): Sends a user message and receives an AI-generated response.
- [Batch node operations](https://docs.chatgrid.ai/api-reference/nodes/batch-node-operations.md): Performs multiple create, update, and delete operations on nodes in a single request. Up to 100 operations per call. Operations are executed sequentially; partial failures are reported in the response.
- [Batch Node Operations](https://docs.chatgrid.ai/api-reference/nodes/batch-nodes.md): Perform multiple create, update, and delete node operations in a single request.
- [Create a node](https://docs.chatgrid.ai/api-reference/nodes/create-a-node.md): Creates a new node on a board at the specified position.
- [Create Node](https://docs.chatgrid.ai/api-reference/nodes/create-node.md): Creates a new node on a board. Nodes represent content on the canvas -- YouTube videos, websites, PDFs, notes, and more.
- [Delete a node](https://docs.chatgrid.ai/api-reference/nodes/delete-a-node.md): Permanently deletes a node from the board.
- [Delete Node](https://docs.chatgrid.ai/api-reference/nodes/delete-node.md): Permanently deletes a node from the board.
- [Get a node](https://docs.chatgrid.ai/api-reference/nodes/get-a-node.md): Retrieves a single node by ID.
- [Get Node](https://docs.chatgrid.ai/api-reference/nodes/get-node.md): Retrieves a single node by ID.
- [List nodes](https://docs.chatgrid.ai/api-reference/nodes/list-nodes.md): Returns a paginated list of nodes on a board. Optionally filter by node type.
- [Update a node](https://docs.chatgrid.ai/api-reference/nodes/update-a-node.md): Updates a node's type, position, or data. Only provided fields are changed.
- [Update Node](https://docs.chatgrid.ai/api-reference/nodes/update-node.md): Updates a node's type, position, or data.
- [Authentication](https://docs.chatgrid.ai/authentication.md): Authenticate with the ChatGrid API using API keys or JWTs.
- [Auto-Generate Client Knowledge Boards](https://docs.chatgrid.ai/cookbooks/client-onboarding.md): Onboard new clients with AI-generated industry overviews, stakeholder maps, and action items. 10 minutes.
- [Build a Competitive Intelligence Board](https://docs.chatgrid.ai/cookbooks/competitive-intel.md): Track competitors, vectorize their content, and ask AI to compare positioning. 10 minutes.
- [Synthesize Multiple Documents into Visual Findings](https://docs.chatgrid.ai/cookbooks/document-synthesis.md): Upload PDFs, vectorize them, extract themes with AI, and map findings to sources. 12 minutes.
- [Add YouTube Videos and PDFs to Your Board](https://docs.chatgrid.ai/cookbooks/knowledge-base.md): Vectorize content and search it. Videos, PDFs, and web pages become searchable knowledge.
- [Using ChatGrid in Claude Code](https://docs.chatgrid.ai/cookbooks/mcp-workflow.md): A real workflow: debugging a production issue with your team's knowledge board.
- [Turn Meeting Notes into Searchable Knowledge](https://docs.chatgrid.ai/cookbooks/meeting-knowledge.md): Extract decisions and action items from meetings, build a searchable knowledge base. 8 minutes.
- [Set Up Your First Project Board](https://docs.chatgrid.ai/cookbooks/quickstart.md): Create a board, add knowledge, search it, and ask AI a question. 5 minutes.
- [Automate a Research Pipeline](https://docs.chatgrid.ai/cookbooks/research-pipeline.md): Batch-ingest sources, vectorize them, and let AI synthesize findings with linked citations. 12 minutes.
- [Build an AI-Powered Sales Deal Room](https://docs.chatgrid.ai/cookbooks/sales-deal-room.md): Create a shared deal room with prospect research, AI-generated briefs, and competitive positioning. 10 minutes.
- [Streaming AI Responses](https://docs.chatgrid.ai/cookbooks/streaming-responses.md): Get real-time AI responses word-by-word using Server-Sent Events (SSE).
- [Build a Team Knowledge Base](https://docs.chatgrid.ai/cookbooks/team-knowledge.md): Three devs, one board. Knowledge that survives Slack, team changes, and bad memory.
- [Errors](https://docs.chatgrid.ai/errors.md): Error response format and common error codes.
- [ChatGrid](https://docs.chatgrid.ai/introduction.md): Your team's project knowledge board. Drop in videos, docs, and links. AI answers from your sources. Works in your IDE.
- [MCP Setup](https://docs.chatgrid.ai/mcp-setup.md): Add ChatGrid to Claude Code in 2 minutes. Search your team's knowledge without leaving the terminal.
- [Pagination](https://docs.chatgrid.ai/pagination.md): Navigate large result sets with cursor-based pagination.
- [Rate Limits](https://docs.chatgrid.ai/rate-limits.md): Understand ChatGrid API rate limits and how to handle them.
- [Use Cases](https://docs.chatgrid.ai/use-cases.md): How teams use ChatGrid to stop losing knowledge.

## OpenAPI Specs

- [openapi](https://docs.chatgrid.ai/openapi.yaml)

## Optional

- [API Status](https://status.chatgrid.ai)