How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Convex Queries API

Execute read-only query functions deployed on the Convex backend. Queries run in a transactional, reactive context and return data from the Convex database.

Convex Queries API is one of 14 APIs that Convex publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Query. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 1 operation across 1 path, and defines 3 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against a single base URL, https://{deploymentName}.convex.cloud.

1 operations 1 paths 3 schemas 1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://{deployment-name}.convex.cloud
Authentication
HTTP Bearer, API Key
Terms of Service
Resource Areas
1

Authentication & Security 2

Convex Queries API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). An API key is passed in the header as Authorization (convexAuth). By default, every request must be authenticated.

  • bearerAuth — Bearer token from the application's configured authentication provider (e.g. Auth0, Clerk). Used for user-level authorization of function calls.
  • convexAuth — Deploy key obtained from the Convex dashboard, formatted as "Convex {deployKey}". Required for admin-level operations and streaming endpoints.

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.

Queries 1

Execute read-only query functions deployed on the Convex backend. Queries run in a transactional, reactive context and return data from the Convex database.

POST
/api/query
Execute a query function
executeQuery body → 200400401404

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are FunctionErrorResponse (4 properties), FunctionRequest (3 properties), FunctionSuccessResponse (3 properties). Each schema is shown below with its type and property counts.

FunctionSuccessResponse
object
3 properties 3 required
FunctionRequest
object
3 properties 2 required
FunctionErrorResponse
object
4 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

convex-queries-api-openapi.yml Raw ↑

Other APIs Convex publishes across the network.

Convex Sync Protocol
Convex JavaScript SDK
Convex Server SDK
Convex AccessTokens API
Convex Actions API
Convex CustomDomains API
Convex DeployKeys API
Convex Deployments API
Convex EnvironmentVariables API
Convex Functions API
Convex Mutations API
Convex Projects API
Where this information came from

This is an independent, third-party profile of Convex Queries API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.