Convex HTTP API

Name: Convex HTTP API API
Brand: Convex HTTP API
Availability: InStock

★ Only Publicly Available OpenAPI DocumentStorageDatabasebearer, apiKey4 EndpointsREST

For Agents

Invoke Convex query, mutation, and action functions on a deployment from any HTTP client. Agents authenticate with a deployment Bearer token or Convex admin key.

Quickstart

Get started with Convex HTTP API in minutes using your preferred integration method.

# Add to your MCP client config (Claude Desktop, Cursor, Windsurf)
{
  "jentic": {
    "url": "https://api.jentic.com/mcp",
    "auth": "oauth"
  }
}

# Then ask your agent:
"call a convex function over http"

# → Jentic returns the GET /events tool with parameter schema, agent executes.

Capabilities

What an agent can do with Convex HTTP API API.

Call a Convex query function and read deployment data via POST /api/query

Run a Convex mutation function to write or update records via POST /api/mutation

Trigger a Convex action function for external side effects via POST /api/action

Invoke any Convex function by path with POST /api/run/{functionIdentifier}

GET STARTED

Start building with Convex HTTP API API

Explore with Jentic

View OpenAPI Document

Jentic publishes the only available OpenAPI document for Convex HTTP API, keeping it validated and agent-ready.

Jentic publishes the only available OpenAPI specification for Convex HTTP API, keeping it validated and agent-ready. The Convex HTTP API lets external clients invoke query, mutation, and action functions defined on a Convex deployment without using the Convex SDK. Functions are addressed either by category-specific endpoints (/api/query, /api/mutation, /api/action) or by arbitrary path through /api/run/{functionIdentifier}. Authentication accepts either a deployment Bearer token or the 'Convex {access_key}' admin key in the Authorization header.

Use Cases

Patterns agents use Convex HTTP API API for, with concrete tasks.

★ External Service Calls Into Convex

Let an external backend (Node, Python, Go) read or mutate Convex deployment state without bundling the Convex SDK. POST /api/query and /api/mutation accept the function name and arguments and return the result, so existing services can integrate Convex over plain HTTP. Suited to teams running Convex alongside legacy backends that already speak REST.

POST /api/query with path 'messages:list' and arguments {channelId: 'general'} and return the result

Cron-Triggered Convex Mutations

Wire a scheduler such as cron-job.org or a CI cron to POST a Convex mutation on a recurring schedule, for example to expire stale records or refresh aggregates. The single POST /api/mutation call slots into any HTTP scheduler and the function runs inside the deployment. Useful when scheduled work needs to live in Convex code but be triggered externally.

Call POST /api/mutation with function 'cleanup:expireRecords' every hour and log the result

Webhook Endpoints That Run Convex Actions

Have an upstream system (Stripe, GitHub, Sentry) post webhooks to a thin proxy that forwards them to /api/action on a Convex deployment. Actions can perform side effects (email, third-party calls) as part of the deployment logic. Useful when teams want webhook handling colocated with their Convex code rather than living in a separate function service.

On a Stripe payment_succeeded webhook, POST /api/action with function 'payments:onSucceeded' and the event payload

Agent-Driven Convex Operations via Jentic

An AI agent calls Convex query, mutation, and action functions through Jentic without holding the deployment key. The agent searches Jentic for a function intent, loads the schema, and executes the appropriate POST. Through Jentic the deployment Bearer or admin key is injected from the vault so agent automation runs without secret exposure.

Search Jentic for 'call a convex function', load the schema, then run the messages:list query and return results

Key Endpoints

4 endpoints — jentic publishes the only available openapi specification for convex http api, keeping it validated and agent-ready.

METHOD

PATH

DESCRIPTION

POST

/api/query

Call a Convex query function

POST

/api/mutation

Call a Convex mutation function

POST

/api/action

Call a Convex action function

POST

/api/run/{functionIdentifier}

Call any Convex function by identifier

POST

/api/query

Call a Convex query function

POST

/api/mutation

Call a Convex mutation function

POST

/api/action

Call a Convex action function

POST

/api/run/{functionIdentifier}

Call any Convex function by identifier

Why though Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

Convex deployment Bearer tokens and admin keys are stored encrypted in the Jentic vault. Agents receive scoped access at execution time and the credential is injected into the Authorization header — raw keys never enter the agent's context window.

Intent-based discovery

Agents search Jentic by intent (e.g., 'call a convex query function') and Jentic returns the matching POST /api/query, /api/mutation, or /api/action operation with its input schema.

Time to first call

Direct Convex HTTP integration: a few hours for auth, function path serialisation, and error mapping. Through Jentic: under 30 minutes — search, load, execute.

Related APIs

Alternatives and complements available in the Jentic catalogue.

Alternative

Hasura API

GraphQL backend that auto-generates an API over a Postgres database, similar full-stack scope.

Choose Hasura when teams want SQL plus GraphQL; pick Convex when functions and reactivity are written in TypeScript inside the deployment.

Alternative

Appwrite Server API

Self-hostable backend with database, auth, and functions, similar developer scope to Convex.

Choose Appwrite when self-hosting matters or the team wants prebuilt auth and storage; pick Convex for hosted reactivity-first functions.

Complementary

Neon API

Serverless Postgres that pairs with Convex when relational storage is needed alongside Convex functions.

Pair with Convex when actions need to hit a Postgres analytical store rather than the Convex document database.

FAQs

Specific to using Convex HTTP API API through Jentic.

Why is there no official OpenAPI spec for Convex HTTP API?

Convex does not publish an OpenAPI specification for its HTTP surface. Jentic generates and maintains this spec so that AI agents and developers can call Convex HTTP API via structured tooling. It is validated against the live API and kept up to date. Get started at https://app.jentic.com/sign-up.

What authentication does the Convex HTTP API use?

Two schemes are supported: HTTP Bearer with a deployment access token in the Authorization header, and the apiKey scheme using 'Convex {access_key}' (admin key) also in the Authorization header. Through Jentic both options are stored in the vault and injected at execution time so they never enter the agent's prompt.

How do I call a Convex query function over HTTP?

POST to /api/query with a JSON body containing the function path (e.g. 'messages:list') and an args object. The deployment runs the function and returns the result inline. Use /api/mutation for write operations and /api/action for side-effect functions.

Can I call any Convex function with a single endpoint?

Yes. POST /api/run/{functionIdentifier} dispatches to whichever query, mutation, or action lives at the supplied identifier. This is useful when the caller does not statically know which function category will be invoked.

What is the base URL for the Convex HTTP API?

Each Convex deployment has its own URL of the form https://{deployment}.convex.cloud. Substitute your deployment identifier (e.g. happy-fox-123) for {deployment} when making calls.

How do I invoke a Convex function through Jentic?

Run jentic search for 'call a convex function', load the POST /api/query, /api/mutation, /api/action, or /api/run operation, then execute it with the function path and arguments. Jentic injects the deployment Bearer or admin key from the vault and returns the function output.

What are the rate limits for the Convex HTTP API?

Rate limits depend on the deployment plan and are not declared in the OpenAPI spec. Treat the function endpoints as soft-limited per deployment and back off on HTTP 429 responses. Consult Convex's pricing page for plan-level concurrency and request limits.