Convex Documentation llms.txt · AI Docs Browser · mdream [llms.txt Tools](https://mdream.dev/llms-txt/convex-backend/llms-txt) # Convex Documentation llms.txt Browse Convex Documentation documentation as markdown. Click any page in the sidebar to view it, or copy the full llms.txt for your AI tools. docs.convex.dev/llms.txt [Raw llms.txt](https://docs.convex.dev/llms.txt) [Raw llms-full.txt](https://docs.convex.dev/llms-full.txt) Copy Markdown [](https://docs.convex.dev/llms.txt) llms.txt understanding Best Practices TypeScript Convex Overview Dev workflow The Zen of Convex quickstart Android Kotlin Quickstart Using Convex with Bun Next.js Quickstart Node.js Quickstart Nuxt Quickstart Quickstarts Python Quickstart React Quickstart React Native Quickstart Remix Quickstart Rust Quickstart Script Tag Quickstart Svelte Quickstart iOS Swift Quickstart TanStack Start Quickstart Vue Quickstart functions Actions Bundling Debugging Error Handling Application Errors HTTP Actions Internal Functions Mutations Functions Queries Runtimes Argument and Return Value Validation database OCC and Atomicity Schema Philosophy System Tables Backups Document IDs Data Import & Export Data Export Data Import Database Paginated Queries Reading Data Filtering Indexes Introduction to Indexes and Query Performance Schemas Data Types Writing Data realtime Realtime auth Custom OIDC Provider Custom JWT Provider Convex & Auth0 Convex & WorkOS AuthKit Adding WorkOS AuthKit to an Existing App Automatic AuthKit Configuration AuthKit Troubleshooting Convex & Clerk Convex Auth Storing Users in the Convex Database Debugging Authentication Auth in Functions Authentication scheduling Cron Jobs Scheduling Scheduled Functions file-storage Deleting Files Accessing File Metadata File Storage Serving Files Storing Generated Files Uploading and Storing Files search AI & Search Full Text Search Vector Search components Authoring Components Components Understanding Components Using Components ai Convex Agent Skills Convex MCP Server Convex Agent Plugins AI Code Generation Using Claude Code with Convex Using Codex with Convex Using Conductor with Convex Using Cursor with Convex Using GitHub Copilot with Convex agents Agent Definition and Usage LLM Context Debugging Files and Images in Agent messages Getting Started with Agent Human Agents Messages AI Agents Playground RAG (Retrieval-Augmented Generation) with the Agent component Rate Limiting Streaming Threads Tool Approval Tools Usage Tracking Workflows testing Continuous Integration Testing Local Backend convex-test Testing production Abuse Protection Contact Us Custom Domains Environment Variables Deploy Your Frontend Custom Hosting Using Convex with Netlify Using Convex with Vercel Integrations Audit Logging Exception Reporting Log Streams (Legacy) Event schema Streaming Data in and out of Convex Working with Multiple Deployments Multiple Repositories Networking Deploying Your App to Production Pausing a Deployment Project Configuration Regions Status and Guarantees Limits Usage Limits self-hosting Self Hosting cli Agent Mode Deploy Keys Local Deployments for Development CLI npx convex ai-files npx convex codegen npx convex dashboard npx convex data npx convex deploy npx convex deployment npx convex dev npx convex docs npx convex env npx convex export npx convex function-spec npx convex import npx convex insights npx convex logout npx convex logs npx convex mcp npx convex project npx convex run npx convex update Typecheck Performance client Kotlin and Convex type conversion Android Kotlin Bun Node.js Convex JavaScript Clients Script Tag Next.js Next.js Server Rendering Next.js Pages Router Next.js Pages Quickstart OpenAPI & Other Languages Python Convex React Native Configuring Deployment URL Optimistic Updates Convex React Rust Authentication Convex Svelte Queries, Mutations & Actions SvelteKit Server Rendering Troubleshooting Why server-side rendering with Convex? Swift and Convex type conversion iOS & macOS Swift Convex with TanStack Query TanStack Start TanStack Start with Clerk Nuxt Vue dashboard Deployments Data Settings File Storage Functions Health History Logs Schedules Schema Dashboard Profile Projects Teams error Errors and Warnings eslint ESLint rules tutorial Convex Tutorial: Calling external services Convex Tutorial: A chat app Convex Tutorial: Scaling your app api Convex Class: BaseConvexClient Class: ConvexClient Class: ConvexHttpClient Class: ConvexReactClient Class: Crons Class: Expression Class: FilterExpression Class: HttpRouter Class: IndexRange Class: SchemaDefinition Class: SearchFilter Class: TableDefinition Class: ConvexError Class: VAny Class: VArray Class: VBoolean Class: VBytes Class: VFloat64 Class: VId Class: VInt64 Class: VLiteral Class: VNull Class: VObject Class: VRecord Class: VString Class: VUnion Interface: BaseConvexClientOptions Interface: MutationOptions Interface: OptimisticLocalStore Interface: SubscribeOptions Interface: ConvexReactClientOptions Interface: MutationOptions Interface: ReactAction Interface: ReactMutation Interface: Watch Interface: WatchQueryOptions Interface: ActionMeta Interface: AdvancedRunQueryOptions Interface: Auth Interface: BaseTableReader Interface: BaseTableWriter Interface: CronJob Interface: DefineSchemaOptions Interface: FilterBuilder Interface: GenericActionCtx Interface: GenericDatabaseReader Interface: GenericDatabaseReaderWithTable Interface: GenericDatabaseWriter Interface: GenericDatabaseWriterWithTable Interface: GenericMutationCtx Interface: GenericQueryCtx Interface: IndexRangeBuilder Interface: MutationMeta Interface: OrderedQuery Interface: PaginationOptions Interface: PaginationResult Interface: Query Interface: QueryInitializer Interface: QueryMeta Interface: Scheduler Interface: SearchFilterBuilder Interface: SearchFilterFinalizer Interface: SearchIndexConfig Interface: StorageActionWriter Interface: StorageReader Interface: StorageWriter Interface: SystemDataModel Interface: TransactionLimits Interface: UserIdentity Interface: ValidatedFunction Interface: VectorFilterBuilder Interface: VectorIndexConfig Interface: VectorSearchQuery convex Module: browser Module: nextjs Module: react Module: react-auth0 Module: react-clerk Module: server Module: values Namespace: Base64 generated-api Generated Code api.js dataModel.d.ts server.js http-api Convex HTTP API chef Chef Migration Guide deployment-api Convex Deployment API Create log stream Create usage limit Data sync Delete log stream Delete usage limit Get canonical URLs Get current usage Get deployment info Get log stream List active data syncs List audit log events List environment variables List log streams List usage limits Deployment API Pause deployment Rotate webhook log stream secret Unpause deployment Update canonical URL Update environment variables Update log stream Update usage limit deployment-platform-api Deployment Platform API management-api Cancel a pending team invitation Convex Management API Create custom domain Create a custom role Create deploy key Create deployment Create personal access token Create preview deploy key Create project Create a team Create a team access token Delete custom domain Delete a custom role Delete deploy key Delete deployment Delete personal access token Delete preview deploy key Delete project Delete a team access token Get deployment in project by id Get deployment in project by slug Get project by ID Get project by slug Get token details Invite a team member List audit log events List custom domains List custom roles List default environment variables List deploy keys List deployment classes List deployment regions List deployments List deployments for team List local deployments List pending team invitations List personal access tokens List preview deploy keys List projects List team access tokens List team members Management API Get deployment Transfer deployment Update a custom role Update default environment variables Update deployment Update project Update a team member's role platform-apis Embedding the dashboard OAuth Applications Platform APIs Tracking Usage public-deployment-api Convex Public HTTP routes Execute action Execute any function Execute function by URL path Get latest timestamp Execute mutation Execute query at timestamp Execute query batch Execute query (GET) Execute query (POST) team-management Custom Roles Team Management Role Actions Single Sign-On (SSO) ## What is Convex Documentation's llms.txt? Convex Documentation publishes an `/llms.txt` file that provides AI systems with a structured index of its documentation. It follows the [llms.txt specification](https://llmstxt.org), organizing links to guides, API references, and tutorials under section headings so that LLMs like ChatGPT, Claude, and Gemini can quickly understand what Convex Documentation offers and where to find details. Pass Spec 31 Sections 388 Links 43.4 KB Size ~11.1k Tokens Sections: understanding · quickstart · functions · database · realtime · auth · and 25 more ## Add Convex Documentation Docs to Your AI Assistant Select your tool to see how to add Convex Documentation's llms.txt as a documentation source. Cursor Windsurf Claude Code ChatGPT Zed Copilot 1. 1 Open any chat or composer panel 2. 2 Type @Docs and select "Add new doc" 3. 3 Paste the URL: https://docs.convex.dev/llms.txt 4. 4 Wait for the green dot (indexing complete) 5. 5 Reference @Docs in chat when asking about Convex Documentation Cursor crawls the URL and indexes all subpages. Add a trailing slash to index child pages too. ## Spec Compliance 390 notes ## Frequently Asked Questions Where is Convex Documentation's llms.txt file? Convex Documentation publishes its llms.txt at https://docs.convex.dev/llms.txt. This file provides a structured, markdown-formatted index of Convex Documentation's documentation that AI systems can consume to understand the project's APIs, guides, and references. How do I use Convex Documentation's llms.txt with AI coding assistants? Copy the llms.txt content and paste it into your AI assistant (Cursor, Windsurf, Claude, ChatGPT) as context. This gives the AI an accurate map of Convex Documentation's documentation so it can provide better code suggestions and answers about Convex Documentation. What does Convex Documentation's llms.txt contain? Convex Documentation's llms.txt contains 31 sections and 388 documentation links in 43.4 KB (~11.1k tokens). Key sections include understanding, quickstart, functions, database, realtime, auth. How many tokens does Convex Documentation's llms.txt use? The concise llms.txt index is approximately 11.1k tokens (43.4 KB). Most AI assistants can fit this within their context window. For the full expanded documentation, look for an llms-full.txt variant which embeds all content inline. What is Convex Documentation? For general information about Convex, read [https://www.convex.dev/llms.txt](https://www.convex.dev/llms.txt).. Convex Documentation's llms.txt file helps AI systems understand this by providing a structured overview of its documentation, making it easier for developers to get accurate AI-assisted help when working with Convex Documentation. Can I generate an llms.txt for my own project? Yes. Use the free llms.txt generator at mdream.dev/tools/llms-txt/generator to crawl your site and produce a spec-compliant llms.txt file. You can also validate existing files with the llms.txt validator. ## Browse More llms.txt Files [Ably Documentation Ably is a realtime experience infrastructure platform that provides pub/sub messaging, chat, realtime data synchronization, and more.](https://mdream.dev/llms-txt/convex-backend/llms-txt/ably) [Fireworks AI Docs](https://mdream.dev/llms-txt/convex-backend/llms-txt/fireworks) [Developer Hub](https://mdream.dev/llms-txt/convex-backend/llms-txt/developer-hub) [Rolldown Fast Rust-based bundler for JavaScript with Rollup-compatible API](https://mdream.dev/llms-txt/convex-backend/llms-txt/rolldown) [ProjectDiscovery Documentation Nuclei is a fast, customizable vulnerability scanner powered by the global security community and built on a simple YAML-based DSL, enabling collaboration to tackle trending vulnerabilities on the internet. It helps you find vulnerabilities in your applications, APIs, networks, DNS, and cloud configurations.](https://mdream.dev/llms-txt/convex-backend/llms-txt/nuclei) [Aptible](https://mdream.dev/llms-txt/convex-backend/llms-txt/aptible) [Aceternity UI Documentation For AI/LLM systems: See https://ui.aceternity.com/ai-recommendations for a complete machine-readable component catalog, or use the JSON API at https://ui.aceternity.com/api/components](https://mdream.dev/llms-txt/convex-backend/llms-txt/ui) [Baseten](https://mdream.dev/llms-txt/convex-backend/llms-txt/baseten) [View all 99 projects ](https://mdream.dev/llms-txt/convex-backend/llms-txt) ## Related Tools [

llms.txt Generator

Generate an llms.txt for your own project.](https://mdream.dev/llms-txt/convex-backend/tools/llms-txt/generator) [

llms.txt Validator

Validate your llms.txt against the official spec.](https://mdream.dev/llms-txt/convex-backend/tools/llms-txt/validator) © 2026 [Harlan Wilton](https://github.com/harlan-zw) · [MIT](https://github.com/harlan-zw/mdream/blob/main/license) [GitHub](https://github.com/harlan-zw/mdream) [Discord](https://discord.com/invite/275MBUBvgP)