# Datagrid AI ## Docs - [Quickstart](https://developers.datagrid.com/introduction/quickstart.md): Start using Datagrid in under 5 minutes - [Connecting Agents to Apps](https://developers.datagrid.com/introduction/connections.md): Learn how to embed Datagrid's connection creation flow in your application - [Creating Data Views](https://developers.datagrid.com/introduction/data-views.md): Learn how to share knowledge with Data Views and Service Accounts - [Rate Limits](https://developers.datagrid.com/api-reference/rate-limits.md): Understand Datagrid API rate limits, response headers, and best practices for handling 429 responses - [Getting started with Converse](https://developers.datagrid.com/api-reference/converse/converse-getting-started.md): Make your first Converse call, then add modes, knowledge, streaming, structured outputs, file inputs, and MCP servers. - [Converse](https://developers.datagrid.com/api-reference/converse/converse.md): Converse with an AI Agent - [Converse Modes](https://developers.datagrid.com/api-reference/converse/modes.md): Map in-app Ask / Extended / Execute to config.agent_model and chat_mode on Converse. - [Knowledge and corpus](https://developers.datagrid.com/api-reference/converse/knowledge-and-corpus.md): Control which knowledge your agent uses when answering questions. - [Streaming](https://developers.datagrid.com/api-reference/converse/streaming.md): Stream a conversation with an AI Agent - [Structured Outputs](https://developers.datagrid.com/api-reference/converse/structured-outputs.md): Ensure responses adhere to a JSON schema. - [File Inputs](https://developers.datagrid.com/api-reference/converse/file-inputs.md): Learn how to use and files as inputs to the converse API. - [MCP Servers (Beta)](https://developers.datagrid.com/api-reference/converse/mcp-servers.md): Connect external tools to your agent using the Model Context Protocol. - [Voice Conversations](https://developers.datagrid.com/api-reference/voice/voice.md): Real-time voice conversations with AI Agents using WebSockets - [iOS / Swift Integration](https://developers.datagrid.com/api-reference/voice/ios-integration.md): Build a real-time voice assistant in an iOS app using the Datagrid Voice WebSocket API - [Start voice session](https://developers.datagrid.com/api-reference/voice/start-voice-session.md): Prepare a real-time voice conversation with an AI Agent. - [Retrieve voice orchestrator task](https://developers.datagrid.com/api-reference/voice/retrieve-voice-orchestrator-task.md) - [List voice orchestrator tasks](https://developers.datagrid.com/api-reference/voice/list-voice-orchestrator-tasks.md): List delegated voice tasks for the authenticated user. By default this returns active, non-expired queued or running tasks plus unacknowledged terminal tasks and omits task result content from list views. Pass an explicit status filter to request a specific task state. A `cancelled` status marks tas… - [Acknowledge voice orchestrator task](https://developers.datagrid.com/api-reference/voice/acknowledge-voice-orchestrator-task.md) - [Cancel voice orchestrator task](https://developers.datagrid.com/api-reference/voice/cancel-voice-orchestrator-task.md) - [Retrieve current identity](https://developers.datagrid.com/api-reference/identity/retrieve-current-identity.md): Returns the identity of the authenticated caller — the user ID, current teamspace, and all teamspace memberships that the API key or JWT resolves to. - [Getting started with Agents](https://developers.datagrid.com/api-reference/agents/agents.md): Create, configure, and run AI agents with the Datagrid API. - [Getting the most out of agents](https://developers.datagrid.com/api-reference/agents/agent-best-practices.md): Practical guidance on instruction writing, mode selection, knowledge scoping, tool choice, and cost/latency trade-offs. - [Create agent](https://developers.datagrid.com/api-reference/agents/create-agent.md): Create a new agent - [Retrieve agent](https://developers.datagrid.com/api-reference/agents/retrieve-agent.md): Get details of a specific agent - [List agents](https://developers.datagrid.com/api-reference/agents/list-agents.md): List all agents for the authenticated organization - [Update agent](https://developers.datagrid.com/api-reference/agents/update-agent.md): Update an agent configuration - [Delete agent](https://developers.datagrid.com/api-reference/agents/delete-agent.md): Delete an agent - [Generate agent from natural language](https://developers.datagrid.com/api-reference/agents/generate-agent-from-natural-language.md): Generate an AI agent configuration from a natural language description. Uses the same LLM-powered generation as the in-product agent builder. This is a public endpoint that does not require authentication. Rate limited to 5 requests per day per IP address. The response includes a `claim_token` that… - [Claim a generated agent template](https://developers.datagrid.com/api-reference/agents/claim-a-generated-agent-template.md): Redeem a `claim_token` from a prior `POST /agents/generate` call to retrieve the generated agent template. The token is consumed (single-use). Use the returned template to pre-populate the agent creation dialog. - [Create automation](https://developers.datagrid.com/api-reference/automations/create-automation.md): Create a new `runAgent` automation for the specified agent. The automation will fire on the provided cron schedule (in the given IANA timezone) and run the agent with the supplied prompt. Schedules must fire at most once every 15 minutes — finer-grained expressions are rejected with a 400 error. - [Retrieve automation](https://developers.datagrid.com/api-reference/automations/retrieve-automation.md): Get details of a specific automation belonging to an agent. - [List automations](https://developers.datagrid.com/api-reference/automations/list-automations.md): List all `runAgent` automations that belong to the specified agent. Returns automations in reverse-chronological order (newest first). Use the cursor pagination parameters (`limit`, `after`, `before`) to page through large result sets. - [Update automation](https://developers.datagrid.com/api-reference/automations/update-automation.md): Update an existing automation. All fields are optional — only supplied fields are changed. Updating `cron` or `timezone` triggers the same 15-minute minimum-interval validation as creation. - [Delete automation](https://developers.datagrid.com/api-reference/automations/delete-automation.md): Delete an automation. The automation is soft-deleted: it stops firing and no longer appears in list or retrieve responses, but its past run history is retained. The agent and its other automations are not affected. Scheduled runs that are already queued may still execute before the deletion propagat… - [Create knowledge](https://developers.datagrid.com/api-reference/knowledge/create-knowledge.md): Create knowledge which will be learned and leveraged by agents. Processing continues asynchronously after the request returns. If the background processing run later fails, subsequent retrievals surface that terminal state through `status` and `last_error`. - [Create knowledge from connection](https://developers.datagrid.com/api-reference/knowledge/create-knowledge-from-connection.md): Initiates knowledge creation from a connection by returning a redirect URL. The organization must have enough credits to start this flow. The downstream ingestion and indexing that follow still run asynchronously, and the actual credit consumption remains variable based on the volume of data process… - [Retrieve knowledge](https://developers.datagrid.com/api-reference/knowledge/retrieve-knowledge.md): Retrieves knowledge by id. - [List knowledge](https://developers.datagrid.com/api-reference/knowledge/list-knowledge.md): Returns a list of knowledge. - [Update knowledge](https://developers.datagrid.com/api-reference/knowledge/update-knowledge.md): Update a knowledge's attributes. Each request can include either `files` or `sync`, but not both. When `files` are provided, all existing data is replaced and a re-processing pipeline runs asynchronously — this consumes credits based on the volume of data processed. Metadata-only and sync-only updat… - [Delete knowledge](https://developers.datagrid.com/api-reference/knowledge/delete-knowledge.md): Delete knowledge. - [Reindex knowledge](https://developers.datagrid.com/api-reference/knowledge/reindex-knowledge.md): Manually trigger a full re-indexing of the knowledge. The reindex runs **asynchronously**: the API returns as soon as the job is enqueued. Re-indexing is not performed immediately. This endpoint consumes credits — the actual credit cost is variable, based on the volume of data being re-indexed, and… - [Knowledge upload limits](https://developers.datagrid.com/knowledge/upload-limits.md): File size limits for the Knowledge API, how uploads are handled, and strategies for working with large documents. - [Retrieve table](https://developers.datagrid.com/api-reference/tables/retrieve-table.md): Retrieves a table by id. - [List tables](https://developers.datagrid.com/api-reference/tables/list-tables.md): Returns a list of tables. - [List records](https://developers.datagrid.com/api-reference/tables/list-records.md): Returns a list of records for a table. - [List summaries](https://developers.datagrid.com/api-reference/tables/list-summaries.md): Returns a list of AI-generated summary records for a knowledge table. Use `record_type=row` (the default) for per-row summaries, or `record_type=table` for the single table-level summary. This endpoint reflects the current index state and does not consume AI credits. - [Replicating Tables](https://developers.datagrid.com/api-reference/tables/replicating-tables.md): Incrementally replicate table records to your destination system - [Create data view](https://developers.datagrid.com/api-reference/data-views/create-data-view.md): Creates a new data view for a knowledge source, providing controlled access through a service account. This endpoint requires credits and meters setup work based on the number of warehouse operations performed for the request. - [List data views](https://developers.datagrid.com/api-reference/data-views/list-data-views.md): Returns the list of data views for a service account. - [Delete data view](https://developers.datagrid.com/api-reference/data-views/delete-data-view.md): Removes a data view. - [Create service account](https://developers.datagrid.com/api-reference/data-views/create-service-account.md): Creates a service account for accessing data views. Only one service account per teamspace is allowed. - [List service accounts](https://developers.datagrid.com/api-reference/data-views/list-service-accounts.md): Returns the list of service accounts for your teamspace. Only one service account per teamspace is allowed at this time. - [Delete service account](https://developers.datagrid.com/api-reference/data-views/delete-service-account.md): Removes a service account and all associated data views. - [Get service account credentials](https://developers.datagrid.com/api-reference/data-views/get-service-account-credentials.md): Retrieves the credentials (private key) for a service account. - [Search](https://developers.datagrid.com/api-reference/search/search.md): [DEPRECATED] Search across knowledge. Use /search/ai for AI-powered generative search or /search/tree for merged context tree results. - [Search Tree](https://developers.datagrid.com/api-reference/search/search-tree.md): Search across your teamspace's indexed knowledge and return results as a hierarchical context tree. Results are grouped by source (datasets, files, pages) with navigation items for quick access. Supports pagination via cursor-based `next` parameter. This endpoint is the foundation for the AI Search… - [AI Search](https://developers.datagrid.com/api-reference/search/ai-search.md): AI-powered search that retrieves relevant knowledge from your teamspace, builds a merged context, and generates a natural language answer with numbered source citations. The response includes the generated answer, the sources cited (with links and metadata), and the full search tree results for refe… - [Create conversation](https://developers.datagrid.com/api-reference/conversations/create-conversation.md): Creates a new conversation. - [Retrieve conversation](https://developers.datagrid.com/api-reference/conversations/retrieve-conversation.md): Retrieves a conversation by id. - [List conversations](https://developers.datagrid.com/api-reference/conversations/list-conversations.md): Returns the list of conversations. - [Delete conversation](https://developers.datagrid.com/api-reference/conversations/delete-conversation.md): Delete conversation. - [Update conversation](https://developers.datagrid.com/api-reference/conversations/update-conversation.md): Update a conversation's properties, such as assigned agents or name. - [Retrieve message](https://developers.datagrid.com/api-reference/conversations/retrieve-message.md): Retrieves a message by id. - [List messages](https://developers.datagrid.com/api-reference/conversations/list-messages.md): Returns the list of messages in a conversation. - [Create connection](https://developers.datagrid.com/api-reference/connections/create-connection.md): Creates a new connection to authenticate with a third-party service (like Google Drive, Hubspot, Dropbox, etc.) and returns a redirect URL for the connection authentication flow. - [Retrieve connection](https://developers.datagrid.com/api-reference/connections/retrieve-connection.md): Retrieves details about an authenticated connection by id. - [List connections](https://developers.datagrid.com/api-reference/connections/list-connections.md): Returns the list of authenticated connections to third-party services. - [Update connection](https://developers.datagrid.com/api-reference/connections/update-connection.md): Update a connection's attributes. - [Delete connection](https://developers.datagrid.com/api-reference/connections/delete-connection.md): Delete an authenticated connection to a third-party service. - [Create connection provider](https://developers.datagrid.com/api-reference/connection-providers/create-connection-provider.md): Create a new connection provider that specifies custom OAuth credentials for a connector. Verify that your OAuth app meets the connector's OAuth app settings requirements. - [Retrieve connection provider](https://developers.datagrid.com/api-reference/connection-providers/retrieve-connection-provider.md): Retrieve a specific connection provider by ID. - [List connection providers](https://developers.datagrid.com/api-reference/connection-providers/list-connection-providers.md): Returns the list of connection providers. - [Update connection provider](https://developers.datagrid.com/api-reference/connection-providers/update-connection-provider.md): Update a connection provider. - [Delete connection provider](https://developers.datagrid.com/api-reference/connection-providers/delete-connection-provider.md): Delete a connection provider. - [List connectors](https://developers.datagrid.com/api-reference/connectors/list-connectors.md): Returns the list of available connectors that can be used to connect to third-party services. - [Get connector health](https://developers.datagrid.com/api-reference/connectors/get-connector-health.md): Returns health status for connectors configured in the current teamspace. - [Create files](https://developers.datagrid.com/api-reference/files/create-files.md): Create files which can be passed as input to agents. This endpoint consumes a flat credit charge per upload. The response includes a `credits` field with the amount consumed, or `null` if the billing write fails — the upload still succeeds in that case. - [Retrieve file](https://developers.datagrid.com/api-reference/files/retrieve-file.md): Retrieves a file by id. - [List files](https://developers.datagrid.com/api-reference/files/list-files.md): Returns the list of files. - [Delete file](https://developers.datagrid.com/api-reference/files/delete-file.md): Delete file. - [Retrieve file content](https://developers.datagrid.com/api-reference/files/retrieve-file-content.md): Returns the content of a file. - [Update file](https://developers.datagrid.com/api-reference/files/update-file.md): Update file metadata. - [Retrieve tool](https://developers.datagrid.com/api-reference/tools/retrieve-tool.md): Retrieves a specific tool by its identifier. - [List tools](https://developers.datagrid.com/api-reference/tools/list-tools.md): Returns the list of available tools that can be used by agents. - [Create secret](https://developers.datagrid.com/api-reference/secrets/create-secret.md): Create a new secret that can be referenced in converse API calls. - [Retrieve secret](https://developers.datagrid.com/api-reference/secrets/retrieve-secret.md): Retrieve a specific secret by ID. - [List secrets](https://developers.datagrid.com/api-reference/secrets/list-secrets.md): Returns the list of user-created secrets. - [Delete secret](https://developers.datagrid.com/api-reference/secrets/delete-secret.md): Delete a secret. - [Webhooks overview](https://developers.datagrid.com/api-reference/webhooks/overview.md): Subscribe to Datagrid events and receive signed HTTPS callbacks. - [Create webhook](https://developers.datagrid.com/api-reference/webhooks/create-webhook.md): Create an HTTPS webhook subscription for your teamspace. Datagrid returns the signing secret only in this response; store it securely and use it to verify future `Datagrid-Signature` headers. - [Retrieve webhook](https://developers.datagrid.com/api-reference/webhooks/retrieve-webhook.md): Retrieve a specific webhook subscription by ID. - [List webhooks](https://developers.datagrid.com/api-reference/webhooks/list-webhooks.md): Returns a cursor-paginated list of webhook subscriptions. - [Update webhook](https://developers.datagrid.com/api-reference/webhooks/update-webhook.md): Update webhook configuration. You can modify the URL, subscribed events, and enabled status. - [Delete webhook](https://developers.datagrid.com/api-reference/webhooks/delete-webhook.md): Delete a webhook subscription. - [List active webhooks for event](https://developers.datagrid.com/api-reference/webhooks/list-active-webhooks-for-event.md): Returns enabled webhook subscriptions for a specific event type. - [Create User Memory](https://developers.datagrid.com/api-reference/memory/create-user-memory.md): Create a user memory. This endpoint requires credits and meters the actual embedding work performed for the request. The response includes `credits.consumed` with the billed amount, or `null` if the billing write fails after the memory is successfully created. - [List User Memory](https://developers.datagrid.com/api-reference/memory/list-user-memory.md): List the memories for a given user and agent that the user has access to - [Delete User Memory](https://developers.datagrid.com/api-reference/memory/delete-user-memory.md): Delete a user memory - [Create page](https://developers.datagrid.com/api-reference/pages/create-page.md): Create a new page - [Retrieve page](https://developers.datagrid.com/api-reference/pages/retrieve-page.md): Get details of a specific page - [List pages](https://developers.datagrid.com/api-reference/pages/list-pages.md): List all pages for the authenticated organization - [Update page](https://developers.datagrid.com/api-reference/pages/update-page.md): Update a page's attributes - [Delete page](https://developers.datagrid.com/api-reference/pages/delete-page.md): Delete a page. The page must have no children or all its children must have been deleted before invoking this API. - [Overview](https://developers.datagrid.com/api-reference/mcp-servers/overview.md): Register and manage MCP servers at teamspace scope for use in converse. - [Create MCP server](https://developers.datagrid.com/api-reference/mcp-servers/create-mcp-server.md): Register a new MCP server in the current teamspace. Each teamspace can have at most 30 registered MCP servers. - [Retrieve MCP server](https://developers.datagrid.com/api-reference/mcp-servers/retrieve-mcp-server.md): Retrieve a registered MCP server. - [List MCP servers](https://developers.datagrid.com/api-reference/mcp-servers/list-mcp-servers.md): List registered MCP servers for the current teamspace. - [Update MCP server](https://developers.datagrid.com/api-reference/mcp-servers/update-mcp-server.md): Update a registered MCP server. - [Delete MCP server](https://developers.datagrid.com/api-reference/mcp-servers/delete-mcp-server.md): Delete a registered MCP server. - [Batch Predictions overview](https://developers.datagrid.com/api-reference/batch-predictions/overview.md): Create asynchronous batch extraction jobs, poll lifecycle state, and stream NDJSON results. - [Create batch prediction](https://developers.datagrid.com/api-reference/batch-predictions/create-batch-prediction.md): Create a new asynchronous batch prediction job. The response returns immediately with a `validating` batch while Datagrid validates files and starts background processing. Supply an `Idempotency-Key` header to safely retry the same create request. The requested model must be available for the authen… - [Retrieve batch prediction](https://developers.datagrid.com/api-reference/batch-predictions/retrieve-batch-prediction.md): Retrieves a batch prediction by id. Terminal batches include a `results_url` until retained result lines are cleaned up. - [List batch predictions](https://developers.datagrid.com/api-reference/batch-predictions/list-batch-predictions.md): Returns batch predictions for the authenticated teamspace in reverse chronological order. Use `after` with `next_cursor` from the previous response to paginate. - [Cancel batch prediction](https://developers.datagrid.com/api-reference/batch-predictions/cancel-batch-prediction.md): Requests cancellation for a batch prediction that is still validating or in progress. A batch that is already `cancelling` or `cancelled` is returned unchanged. - [Retrieve batch prediction results](https://developers.datagrid.com/api-reference/batch-predictions/retrieve-batch-prediction-results.md): Streams newline-delimited JSON (NDJSON) result lines for a terminal batch prediction. Read the response body line-by-line and JSON parse each non-empty line. Results are retained for a limited window after batch creation; after cleanup, this endpoint returns `410 Gone`. - [Batch prediction errors](https://developers.datagrid.com/api-reference/batch-predictions/errors.md): Problem detail types returned by batch prediction endpoints and streamed result lines. - [Event Triggers overview](https://developers.datagrid.com/api-reference/event-triggers/overview.md): Run an agent automatically when an external provider event fires, such as a Procore webhook. - [Create event trigger](https://developers.datagrid.com/api-reference/event-triggers/create-event-trigger.md): Create an event trigger for the specified agent so it runs automatically when the configured provider event fires. Prerequisite gaps that do not prevent the trigger from being saved (e.g. a missing Procore company/project mapping or credentials) are returned in the `warnings` array on the response r… - [List event triggers](https://developers.datagrid.com/api-reference/event-triggers/list-event-triggers.md): List the App Event automations (event triggers) configured for the specified agent. An event trigger fires the agent in response to an external provider event (e.g. a Procore webhook such as `Tasks:create`). An agent has at most one event trigger, so the returned list contains zero or one item and `… - [Update event trigger](https://developers.datagrid.com/api-reference/event-triggers/update-event-trigger.md): Update an existing event trigger on the specified agent. Only the fields supplied in the request body are changed; omitted fields keep their current value. Use `enabled` to pause (`false`) or resume (`true`) the trigger. As with creation, non-fatal prerequisite gaps are returned in the `warnings` ar… - [Delete event trigger](https://developers.datagrid.com/api-reference/event-triggers/delete-event-trigger.md): Delete an event trigger from the specified agent. This unregisters the underlying provider webhook subscription and stops the agent from running in response to the event. - [Get credits](https://developers.datagrid.com/api-reference/credits/get-credits.md): Summarise the credits in your account for the current billing period. - [Retrieve user](https://developers.datagrid.com/api-reference/users/retrieve-user.md): Retrieve details of a specific user in the organization. - [List users](https://developers.datagrid.com/api-reference/users/list-users.md): Retrieve a list of users in the specified organization. - [Update user](https://developers.datagrid.com/api-reference/users/update-user.md): Update user permissions in the organization. - [Create teamspace](https://developers.datagrid.com/api-reference/teamspaces/create-teamspace.md): Create a new teamspace within your organization. - [Retrieve teamspace](https://developers.datagrid.com/api-reference/teamspaces/retrieve-teamspace.md): Retrieve a specific teamspace by ID. - [List teamspaces](https://developers.datagrid.com/api-reference/teamspaces/list-teamspaces.md): Returns the list of teamspaces within your organization. - [Update teamspace](https://developers.datagrid.com/api-reference/teamspaces/update-teamspace.md): Update the name and/or access settings of a teamspace. - [Scope Requests to a Teamspace](https://developers.datagrid.com/api-reference/teamspaces/scope-to-teamspace.md): Learn how to scope API requests to a different teamspace within your account - [Invite user to a teamspace](https://developers.datagrid.com/api-reference/teamspace-invites/invite-user-to-a-teamspace.md): Invite a user to join the teamspace. This will send an invitation email. If the user already exists, the invite will be automatically accepted. - [Retrieve teamspace invite](https://developers.datagrid.com/api-reference/teamspace-invites/retrieve-teamspace-invite.md): Get a pending invite for in a teamspace. - [List teamspace invites](https://developers.datagrid.com/api-reference/teamspace-invites/list-teamspace-invites.md): List all pending invites for a teamspace. - [Delete teamspace invite](https://developers.datagrid.com/api-reference/teamspace-invites/delete-teamspace-invite.md): Delete a pending invite for a user in a teamspace. - [Retrieve teamspace user](https://developers.datagrid.com/api-reference/teamspace-users/retrieve-teamspace-user.md): Retrieve details of a specific user in the teamspace. - [List teamspace users](https://developers.datagrid.com/api-reference/teamspace-users/list-teamspace-users.md): Retrieve a list of users in the specified teamspace. - [Update teamspace user](https://developers.datagrid.com/api-reference/teamspace-users/update-teamspace-user.md): Update user permissions in the teamspace. - [Delete teamspace user](https://developers.datagrid.com/api-reference/teamspace-users/delete-teamspace-user.md): Revoke a user's permissions from the teamspace. - [All Connectors](https://developers.datagrid.com/connectors/all-connectors.md): Complete list of all available connectors in Datagrid AI - [July 2026](https://developers.datagrid.com/changelog/2026-07.md): API and SDK changes released in July 2026. - [June 2026](https://developers.datagrid.com/changelog/2026-06.md): API and SDK changes released in June 2026. ## OpenAPI Specs - [datagrid-ai-open-api](https://developers.datagrid.com/datagrid-ai-open-api.yaml) - [openapi](https://developers.datagrid.com/api-reference/openapi.json) ## Optional - [Get your API Key](https://app.datagrid.com/chats?at=chats&st=api_keys&redirect_url=chats?at=chats%26st=api_keys) - [Join us on Slack](https://join.slack.com/t/datagrid-users/shared_invite/zt-2tl2omd78-qO8zHN5_sK39_lRsyZA4Dg)