Convex

aid: convex
url: https://raw.githubusercontent.com/api-evangelist/convex/refs/heads/main/apis.yml
name: Convex
kind: company
description: Convex is a serverless backend platform that provides a real-time database, cloud functions, and infrastructure
  for building modern web and mobile applications. It offers a TypeScript-first developer experience with reactive queries,
  transactional mutations, and integrated file storage, all accessible through a suite of HTTP, management, and deployment
  APIs alongside JavaScript and server SDKs for full-stack application development. The platform is SOC 2 Type II, HIPAA,
  and GDPR compliant.
accessModel:
  pricing: paid
  onboarding: self-serve
  trial: false
  try_now: false
  public: false
  label: Paid · Self-serve signup
  confidence: high
  source:
  - plans
  - authentication
  generated: '2026-07-22'
  method: derived
image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/icons/convex.png
tags:
- Backend
- Database
- Functions
- Real-Time
- Reactive
- Serverless
- TypeScript
created: '2026-03-21'
modified: '2026-05-29'
specificationVersion: '0.19'
apis:
- aid: convex:sync-protocol
  name: Convex Sync Protocol
  tags:
  - Real-Time
  - Reactive
  - Sync
  - WebSocket
  image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/apis-json-logo.jpg
  baseURL: wss://{deployment-name}.convex.cloud/api/{clientVersion}/sync
  humanURL: https://docs.convex.dev/understanding/
  properties:
  - url: https://docs.convex.dev/understanding/
    type: Documentation
  - url: https://github.com/get-convex/convex-js/blob/main/src/browser/sync/protocol.ts
    type: SourceCode
  - url: asyncapi/convex-asyncapi.yml
    type: AsyncAPI
  description: The Convex Sync Protocol is the bidirectional WebSocket protocol spoken between Convex client SDKs and the
    sync worker of a Convex deployment. Clients open a single WebSocket connection to wss://{deployment-name}.convex.cloud/api/{clientVersion}/sync
    and exchange JSON envelopes (discriminated by a `type` field) to authenticate, subscribe to reactive query sets, invoke
    mutations and actions, and receive query transitions, function responses, auth errors, fatal errors, and pings. The protocol
    is implemented in the open source convex-js client (`src/browser/sync/protocol.ts`).
  x-features:
  - Connect / Authenticate session handshake with reconnection state
  - ModifyQuerySet subscriptions with Add and Remove modifications
  - Mutation and Action request/response with requestId correlation
  - Transition and TransitionChunk messages carrying QueryUpdated, QueryFailed, and QueryRemoved state modifications
  - AuthError, FatalError, and Ping server-pushed messages
  - Client-emitted Event telemetry frames (e.g. ClientConnect)
  x-useCases:
  - Building custom Convex clients in languages other than JavaScript
  - Auditing and governing the realtime traffic of Convex deployments
  - Implementing observability and replay tooling for sync sessions
  - Documenting Convex's reactive backend for security and compliance review
- aid: convex:javascript-sdk
  name: Convex JavaScript SDK
  tags:
  - Client Library
  - JavaScript
  - SDK
  - TypeScript
  image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/apis-json-logo.jpg
  humanURL: https://docs.convex.dev/api/
  properties:
  - url: https://docs.convex.dev/api/
    type: Documentation
  - url: https://www.npmjs.com/package/convex
    type: Package
  description: The Convex JavaScript SDK is a collection of TypeScript/JavaScript packages for building applications on the
    Convex backend platform. It includes convex/server for defining backend functions and database schemas, convex/react for
    React hooks and the ConvexReactClient, convex/browser for the ConvexHttpClient in non-React browser environments, convex/values
    for working with Convex-stored data types, and framework integrations for Next.js, React Native, and other environments.
  x-features:
  - ConvexReactClient with reactive useQuery, useMutation hooks
  - ConvexHttpClient for non-React JavaScript runtimes
  - Strongly typed client generated from project schema
  - Authentication helpers for Clerk, Auth0, and custom providers
  - Framework integrations for Next.js, React Native, and Svelte
  x-useCases:
  - Building real-time React applications backed by Convex
  - Embedding Convex queries in Next.js server components
  - Server-rendered apps that read Convex data on the server
  - Cross-platform mobile apps using React Native and Convex
- aid: convex:server-sdk
  name: Convex Server SDK
  tags:
  - Backend
  - Database
  - Serverless Functions
  - TypeScript
  image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/apis-json-logo.jpg
  humanURL: https://docs.convex.dev/functions
  properties:
  - url: https://docs.convex.dev/functions
    type: Documentation
  - url: https://docs.convex.dev/database/schemas
    type: Documentation
  description: The Convex Server SDK (convex/server) is the TypeScript library for defining backend logic deployed on Convex.
    It provides primitives for writing query functions for read-only database access, mutation functions for transactional
    writes, and action functions for general-purpose server-side operations including calling external services. The SDK supports
    schema definition, full-text search indexes, vector search indexes, file storage, scheduled functions, cron jobs, and
    HTTP routing via the HttpRouter class.
  x-features:
  - query, mutation, and action function primitives
  - defineSchema and defineTable for typed database modeling
  - Full-text and vector search indexes
  - Cron jobs and scheduled function execution
  - HttpRouter for custom HTTP endpoints
  - File storage with signed URL generation
  x-useCases:
  - Authoring Convex backend functions in TypeScript
  - Modeling reactive database schemas with type safety
  - Implementing AI workflows with vector search
  - Scheduling recurring background work with cron jobs
  - Building HTTP webhook handlers inside Convex deployments
- aid: convex:convex-accesstokens-api
  name: Convex AccessTokens API
  description: Create and manage Team Access Tokens used for authenticating Management API requests on behalf of a team.
  humanURL: https://docs.convex.dev/http-api/
  baseURL: https://{deployment-name}.convex.cloud
  tags:
  - AccessTokens
  properties:
  - type: OpenAPI
    url: openapi/convex-accesstokens-api-openapi.yml
  - type: Documentation
    url: https://docs.convex.dev/http-api/
  - type: Documentation
    url: https://docs.convex.dev/management-api
  - type: Documentation
    url: https://docs.convex.dev/deployment-platform-api
- aid: convex:convex-actions-api
  name: Convex Actions API
  description: Execute action functions for general-purpose server-side operations, including calling external services, performing
    non-transactional work, and orchestrating other functions.
  humanURL: https://docs.convex.dev/http-api/
  baseURL: https://{deployment-name}.convex.cloud
  tags:
  - Actions
  properties:
  - type: OpenAPI
    url: openapi/convex-actions-api-openapi.yml
  - type: Documentation
    url: https://docs.convex.dev/http-api/
  - type: Documentation
    url: https://docs.convex.dev/management-api
  - type: Documentation
    url: https://docs.convex.dev/deployment-platform-api
- aid: convex:convex-customdomains-api
  name: Convex CustomDomains API
  description: Configure custom domain names for Convex deployments. Supports both convexCloud (function API) and convexSite
    (HTTP actions) request destinations.
  humanURL: https://docs.convex.dev/http-api/
  baseURL: https://{deployment-name}.convex.cloud
  tags:
  - CustomDomains
  properties:
  - type: OpenAPI
    url: openapi/convex-customdomains-api-openapi.yml
  - type: Documentation
    url: https://docs.convex.dev/http-api/
  - type: Documentation
    url: https://docs.convex.dev/management-api
  - type: Documentation
    url: https://docs.convex.dev/deployment-platform-api
- aid: convex:convex-deploykeys-api
  name: Convex DeployKeys API
  description: Create and manage deploy keys for CLI operations and CI/CD pipelines. Deploy keys authenticate the Convex CLI
    when pushing function code to a deployment.
  humanURL: https://docs.convex.dev/http-api/
  baseURL: https://{deployment-name}.convex.cloud
  tags:
  - DeployKeys
  properties:
  - type: OpenAPI
    url: openapi/convex-deploykeys-api-openapi.yml
  - type: Documentation
    url: https://docs.convex.dev/http-api/
  - type: Documentation
    url: https://docs.convex.dev/management-api
  - type: Documentation
    url: https://docs.convex.dev/deployment-platform-api
- aid: convex:convex-deployments-api
  name: Convex Deployments API
  description: Create, list, retrieve, update, and delete Convex cloud and local deployments. Deployments are the runtime
    environments where Convex backend functions execute.
  humanURL: https://docs.convex.dev/http-api/
  baseURL: https://{deployment-name}.convex.cloud
  tags:
  - Deployments
  properties:
  - type: OpenAPI
    url: openapi/convex-deployments-api-openapi.yml
  - type: Documentation
    url: https://docs.convex.dev/http-api/
  - type: Documentation
    url: https://docs.convex.dev/management-api
  - type: Documentation
    url: https://docs.convex.dev/deployment-platform-api
- aid: convex:convex-environmentvariables-api
  name: Convex EnvironmentVariables API
  description: Manage environment variables for a Convex deployment. Environment variables are key-value pairs accessible
    to backend functions at runtime via process.env. Changes to environment variables take effect after the next deployment
    push.
  humanURL: https://docs.convex.dev/http-api/
  baseURL: https://{deployment-name}.convex.cloud
  tags:
  - EnvironmentVariables
  properties:
  - type: OpenAPI
    url: openapi/convex-environmentvariables-api-openapi.yml
  - type: Documentation
    url: https://docs.convex.dev/http-api/
  - type: Documentation
    url: https://docs.convex.dev/management-api
  - type: Documentation
    url: https://docs.convex.dev/deployment-platform-api
- aid: convex:convex-functions-api
  name: Convex Functions API
  description: Execute any deployed function by its identifier using the unified run endpoint, which accepts the function
    type implicitly based on the deployed function definition.
  humanURL: https://docs.convex.dev/http-api/
  baseURL: https://{deployment-name}.convex.cloud
  tags:
  - Functions
  properties:
  - type: OpenAPI
    url: openapi/convex-functions-api-openapi.yml
  - type: Documentation
    url: https://docs.convex.dev/http-api/
  - type: Documentation
    url: https://docs.convex.dev/management-api
  - type: Documentation
    url: https://docs.convex.dev/deployment-platform-api
- aid: convex:convex-mutations-api
  name: Convex Mutations API
  description: Execute mutation functions that perform transactional writes to the Convex database. Mutations are strongly
    consistent and run with ACID guarantees.
  humanURL: https://docs.convex.dev/http-api/
  baseURL: https://{deployment-name}.convex.cloud
  tags:
  - Mutations
  properties:
  - type: OpenAPI
    url: openapi/convex-mutations-api-openapi.yml
  - type: Documentation
    url: https://docs.convex.dev/http-api/
  - type: Documentation
    url: https://docs.convex.dev/management-api
  - type: Documentation
    url: https://docs.convex.dev/deployment-platform-api
- aid: convex:convex-projects-api
  name: Convex Projects API
  description: Create, list, retrieve, and delete Convex projects within a team. Projects group deployments and serve as the
    top-level organizational unit for Convex applications.
  humanURL: https://docs.convex.dev/http-api/
  baseURL: https://{deployment-name}.convex.cloud
  tags:
  - Projects
  properties:
  - type: OpenAPI
    url: openapi/convex-projects-api-openapi.yml
  - type: Documentation
    url: https://docs.convex.dev/http-api/
  - type: Documentation
    url: https://docs.convex.dev/management-api
  - type: Documentation
    url: https://docs.convex.dev/deployment-platform-api
- aid: convex:convex-queries-api
  name: Convex Queries API
  description: Execute read-only query functions deployed on the Convex backend. Queries run in a transactional, reactive
    context and return data from the Convex database.
  humanURL: https://docs.convex.dev/http-api/
  baseURL: https://{deployment-name}.convex.cloud
  tags:
  - Queries
  properties:
  - type: OpenAPI
    url: openapi/convex-queries-api-openapi.yml
  - type: Documentation
    url: https://docs.convex.dev/http-api/
  - type: Documentation
    url: https://docs.convex.dev/management-api
  - type: Documentation
    url: https://docs.convex.dev/deployment-platform-api
- aid: convex:convex-teams-api
  name: Convex Teams API
  description: Manage Convex teams, team members, and team-level access tokens. Teams are the billing and administrative unit
    that owns projects.
  humanURL: https://docs.convex.dev/http-api/
  baseURL: https://{deployment-name}.convex.cloud
  tags:
  - Teams
  properties:
  - type: OpenAPI
    url: openapi/convex-teams-api-openapi.yml
  - type: Documentation
    url: https://docs.convex.dev/http-api/
  - type: Documentation
    url: https://docs.convex.dev/management-api
  - type: Documentation
    url: https://docs.convex.dev/deployment-platform-api
common:
- type: PostmanWorkspace
  url: https://www.postman.com/kinlaneapi/convex/overview
- type: AgenticAccess
  url: agentic-access/convex-agentic-access.yml
- type: TrustCenter
  url: security/convex-trust-center.yml
- type: VulnerabilityDisclosure
  url: security/convex-vulnerability-disclosure.yml
- type: DomainSecurity
  url: security/convex-domain-security.yml
- type: Authentication
  url: authentication/convex-authentication.yml
- type: LinkedIn
  url: https://www.linkedin.com/company/convex-dev
- type: Portal
  url: https://www.convex.dev/developers
- type: Documentation
  url: https://docs.convex.dev/
- type: Website
  url: https://www.convex.dev
- type: Login
  url: https://dashboard.convex.dev/
- type: Blog
  url: https://stack.convex.dev/
- type: GitHub
  url: https://github.com/get-convex
- type: Discord
  url: https://convex.dev/community
- type: TermsOfService
  url: https://www.convex.dev/legal/terms
- type: PrivacyPolicy
  url: https://www.convex.dev/legal/privacy
- type: JSONSchema
  url: json-schema/convex-function-schema.json
- type: JSONSchema
  url: json-schema/convex-deployment-schema.json
- type: JSONLD
  url: json-ld/convex-context.jsonld
- type: Vocabulary
  url: vocabulary/convex-vocabulary.yml
- type: Integrations
  url: https://www.convex.dev/partners
- name: MCP Server
  url: https://stack.convex.dev/convex-mcp-server
  type: MCPServer
- type: LlmsText
  url: https://docs.convex.dev/llms.txt
integrations:
- name: Apply to join our partner network
maintainers:
- FN: API Evangelist
  email: info@apievangelist.com