Connect to Convex with a deployment URL and deploy key from that deployment's settings. Grant the key the function and data access required by your operations.
Use Run Query, Run Mutation, or Run Action to call a function with JSON arguments; Run Function lets Convex resolve its type. List Tables returns document schemas. List Documents pages a consistent snapshot, and Document Deltas retrieves subsequent changes, including deletions, for incremental synchronization.
Function calls are available across plans. List Tables, List Documents, and Document Deltas use streaming export, which Convex documents as requiring a Pro plan. Its deploy key needs deployment:data:view; confirm that your current plan includes streaming export.
Use the block
Run query, mutation, and action functions on your deployment, list tables with their schemas, and export documents with snapshot pagination and change deltas.
Actions
Convex Run Query
Run a Convex query function and return its result
Convex Run Mutation
Run a Convex mutation function to write data and return its result
Convex Run Action
Run a Convex action function and return its result
Convex Run Function
Run any Convex function (query, mutation, or action) by path without specifying its type
Convex List Tables
List all tables in a Convex deployment along with their JSON schemas. Requires streaming export, available on Convex paid plans.
Convex List Documents
List documents from a Convex table via a paginated snapshot. Pass the returned snapshot and page cursor back in to fetch the next page. Requires streaming export, available on Convex paid plans.
Convex Document Deltas
List documents that changed after a snapshot or previous delta cursor. Deleted documents are returned with a _deleted flag. Requires streaming export, available on Convex paid plans.