Documentation page llms.txt Best Practices TypeScript Convex Overview Dev workflow The Zen of Convex 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 Actions Bundling Debugging Error Handling Application Errors HTTP Actions Internal Functions Mutations Functions Queries Runtimes Argument and Return Value Validation Commit Timestamp 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 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 Cron Jobs Scheduling Scheduled Functions Deleting Files Accessing File Metadata File Storage Serving Files Storing Generated Files Uploading and Storing Files AI & Search Full Text Search Vector Search Authoring Components Components Understanding Components Using Components 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 HTTP API Models AI Gateway Getting started Usage and Billing 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 Continuous Integration Testing Local Backend convex-test Testing 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 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 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 Deployments Data Settings File Storage Functions Health History Logs Schedules Schema Dashboard Profile Projects Teams Errors and Warnings ESLint rules Convex Tutorial: Calling external services Convex Tutorial: A chat app Convex Tutorial: Scaling your app Convex Class: BaseConvexClient Class: ConvexClient Class: ConvexHttpClient Class: ConvexReactClient Class: Crons Class: Expression<T> Class: FilterExpression<T> Class: HttpRouter Class: IndexRange Class: SchemaDefinition<Schema, StrictTableTypes> Class: SearchFilter Class: TableDefinition<DocumentType, Indexes, SearchIndexes, VectorIndexes> Class: CommitTsPlaceholder Class: ConvexError<TData> Class: VAny<Type, IsOptional, FieldPaths> Class: VArray<Type, Element, IsOptional> Class: VBoolean<Type, IsOptional> Class: VBytes<Type, IsOptional> Class: VCommitTs<Type, IsOptional> Class: VFloat64<Type, IsOptional> Class: VId<Type, IsOptional> Class: VInt64<Type, IsOptional> Class: VLiteral<Type, IsOptional> Class: VNull<Type, IsOptional> Class: VObject<Type, Fields, IsOptional, FieldPaths> Class: VRecord<Type, Key, Value, IsOptional, FieldPaths> Class: VString<Type, IsOptional> Class: VUnion<Type, T, IsOptional, FieldPaths> Interface: BaseConvexClientOptions Interface: MutationOptions Interface: OptimisticLocalStore Interface: SubscribeOptions Interface: ConvexReactClientOptions Interface: MutationOptions<Args> Interface: ReactAction<Action> Interface: ReactMutation<Mutation> Interface: Watch<T> Interface: WatchQueryOptions Interface: ActionMeta Interface: AdvancedRunQueryOptions Interface: Auth Interface: BaseTableReader<DataModel, TableName> Interface: BaseTableWriter<DataModel, TableName> Interface: CronJob Interface: DefineSchemaOptions<StrictTableNameTypes> Interface: FilterBuilder<TableInfo> Interface: GenericActionCtx<DataModel> Interface: GenericDatabaseReader<DataModel> Interface: GenericDatabaseReaderWithTable<DataModel> Interface: GenericDatabaseWriter<DataModel> Interface: GenericDatabaseWriterWithTable<DataModel> Interface: GenericMutationCtx<DataModel> Interface: GenericQueryCtx<DataModel> Interface: IndexRangeBuilder<Document, IndexFields, FieldNum> Interface: MutationMeta Interface: OrderedQuery<TableInfo> Interface: PaginationOptions Interface: PaginationResult<T> Interface: Query<TableInfo> Interface: QueryInitializer<TableInfo> Interface: QueryMeta Interface: Scheduler Interface: SearchFilterBuilder<Document, SearchIndexConfig> Interface: SearchFilterFinalizer<Document, SearchIndexConfig> Interface: SearchIndexConfig<SearchField, FilterFields> Interface: StorageActionWriter Interface: StorageReader Interface: StorageWriter Interface: SystemDataModel Interface: TransactionLimits Interface: UserIdentity Interface: ValidatedFunction<Ctx, ArgsValidator, Returns> Interface: VectorFilterBuilder<Document, VectorIndexConfig> Interface: VectorIndexConfig<VectorField, FilterFields> Interface: VectorSearchQuery<TableInfo, IndexName> convex Module: browser Module: nextjs Module: react Module: react-auth0 Module: react-clerk Module: server Module: values Namespace: Base64 Generated Code api.js dataModel.d.ts server.js Convex HTTP API Chef Migration Guide 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 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 Embedding the dashboard OAuth Applications platforms@convex.dev ↗ Tracking Usage 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) Custom Roles Team Management Role Actions Single Sign-On (SSO)
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
Commit Timestamp 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 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 ai-gateway
HTTP API Models AI Gateway Getting started Usage and Billing 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 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 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<T> Class: FilterExpression<T> Class: HttpRouter Class: IndexRange Class: SchemaDefinition<Schema, StrictTableTypes> Class: SearchFilter Class: TableDefinition<DocumentType, Indexes, SearchIndexes, VectorIndexes> Class: CommitTsPlaceholder Class: ConvexError<TData> Class: VAny<Type, IsOptional, FieldPaths> Class: VArray<Type, Element, IsOptional> Class: VBoolean<Type, IsOptional> Class: VBytes<Type, IsOptional> Class: VCommitTs<Type, IsOptional> Class: VFloat64<Type, IsOptional> Class: VId<Type, IsOptional> Class: VInt64<Type, IsOptional> Class: VLiteral<Type, IsOptional> Class: VNull<Type, IsOptional> Class: VObject<Type, Fields, IsOptional, FieldPaths> Class: VRecord<Type, Key, Value, IsOptional, FieldPaths> Class: VString<Type, IsOptional> Class: VUnion<Type, T, IsOptional, FieldPaths> Interface: BaseConvexClientOptions Interface: MutationOptions Interface: OptimisticLocalStore Interface: SubscribeOptions Interface: ConvexReactClientOptions Interface: MutationOptions<Args> Interface: ReactAction<Action> Interface: ReactMutation<Mutation> Interface: Watch<T> Interface: WatchQueryOptions Interface: ActionMeta Interface: AdvancedRunQueryOptions Interface: Auth Interface: BaseTableReader<DataModel, TableName> Interface: BaseTableWriter<DataModel, TableName> Interface: CronJob Interface: DefineSchemaOptions<StrictTableNameTypes> Interface: FilterBuilder<TableInfo> Interface: GenericActionCtx<DataModel> Interface: GenericDatabaseReader<DataModel> Interface: GenericDatabaseReaderWithTable<DataModel> Interface: GenericDatabaseWriter<DataModel> Interface: GenericDatabaseWriterWithTable<DataModel> Interface: GenericMutationCtx<DataModel> Interface: GenericQueryCtx<DataModel> Interface: IndexRangeBuilder<Document, IndexFields, FieldNum> Interface: MutationMeta Interface: OrderedQuery<TableInfo> Interface: PaginationOptions Interface: PaginationResult<T> Interface: Query<TableInfo> Interface: QueryInitializer<TableInfo> Interface: QueryMeta Interface: Scheduler Interface: SearchFilterBuilder<Document, SearchIndexConfig> Interface: SearchFilterFinalizer<Document, SearchIndexConfig> Interface: SearchIndexConfig<SearchField, FilterFields> Interface: StorageActionWriter Interface: StorageReader Interface: StorageWriter Interface: SystemDataModel Interface: TransactionLimits Interface: UserIdentity Interface: ValidatedFunction<Ctx, ArgsValidator, Returns> Interface: VectorFilterBuilder<Document, VectorIndexConfig> Interface: VectorIndexConfig<VectorField, FilterFields> Interface: VectorSearchQuery<TableInfo, IndexName> 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 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 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)