- Category: developer tools
- Auth: API_KEY, BEARER_TOKEN
- Composio-managed OAuth available? N/A
- Tools: 19
- Triggers: 0
- Slug:
CONVEX - Version: 20261101_00
Tools
Create deploy key
Create deploy key
Slug:
CONVEX_CREATE_DEPLOY_KEYTool to create a deploy key for use with the Convex CLI. Use when you need to generate credentials for CLI-based development or deployment workflows. The generated key provides administrative access to the specified deployment.Input Parameters
Name for the deploy key. This is a human-readable identifier that helps you remember what this key is used for.
The name of the deployment for which to create the deploy key. This identifies the specific Convex deployment.
Output
Create Deployment
Create Deployment
Slug:
CONVEX_CREATE_DEPLOYMENTTool to create a new deployment for a Convex project. Use when you need to create a development, production, or custom deployment. Specify the deployment type and optional configuration like class, reference, and region.Input Parameters
The type of deployment to create: ‘dev’ for development, ‘prod’ for production, or ‘custom’ for custom deployment
The class to use for this deployment. If not provided, the default deployment class for your team will be used
An identifier that uniquely identifies this deployment within the project. By providing a reference, you can create multiple dev and prod deployments in the project. If not provided, a reference will be automatically generated
Output
Create Project
Create Project
Slug:
CONVEX_CREATE_PROJECTTool to create a new project on a Convex team, optionally provisioning a dev or prod deployment. Use when you need to initialize a new Convex project in a team.Input Parameters
Type of deployment to create (e.g., ‘dev’ or ‘prod’). If not provided, no deployment will be created initially.
Class to use for the deployment. If not provided, the default deployment class for your team will be used.
Region where the deployment should be hosted. If not provided, uses the default region for your team.
Output
Delete Custom Domain
Delete Custom Domain
Slug:
CONVEX_DELETE_CUSTOM_DOMAINTool to remove a custom domain from a Convex deployment. Use when you need to delete a previously configured custom domain.Input Parameters
The destination type for this custom domain: ‘convexCloud’ for Convex Cloud deployments or ‘convexSite’ for Convex Site deployments
Output
Delete Deployment
Delete Deployment
Slug:
CONVEX_DELETE_DEPLOYMENTTool to delete a Convex deployment. Use when you need to permanently remove a deployment and all its data. WARNING: This action will delete all data and files in the deployment and cannot be undone.Input Parameters
The name of the deployment to delete. This will permanently delete all data and files in the deployment.
Output
Delete project
Delete project
Slug:
CONVEX_DELETE_PROJECTDeletes a Convex project and all its deployments permanently. Use when you need to permanently remove a project and all associated data. This operation cannot be undone.Input Parameters
The unique identifier of the project to delete. This will delete the project and all its deployments permanently.
Output
Execute Query Batch
Execute Query Batch
Slug:
CONVEX_EXECUTE_QUERY_BATCHSubmit multiple Convex query functions in a single batch request to retrieve their results. Queries can be public or authorized with a Convex deploy key; bearer-token user authorization is not available for this operation.Input Parameters
Array of query items to execute in the batch. Each item specifies a query function path and its arguments.
Full deployment URL (e.g., ‘https://quiet-llama-744.convex.cloud’). If not provided, uses the base_url from auth metadata.
Output
Get Deployment Details
Get Deployment Details
Get Project by ID
Get Project by ID
Get Project by Slug
Get Project by Slug
Get Query Timestamp
Get Query Timestamp
Get token details
Get token details
List Deploy Keys
List Deploy Keys
List deployment classes
List deployment classes
List deployment regions
List deployment regions
List Deployments
List Deployments
Slug:
CONVEX_LIST_DEPLOYMENTSLists deployments for a Convex project, with optional filters for deployment type and default status. Local deployments can be requested, but are limited to those created by the requesting team member.Input Parameters
If true, include local deployments in the response (filtered to only show local deployments created by the requesting team member).
Output
List Log Streams
List Log Streams
List Projects
List Projects
Update Deployment
Update Deployment
Slug:
CONVEX_UPDATE_DEPLOYMENTTool to update properties of an existing Convex deployment. Use when you need to modify deployment settings such as dashboard edit confirmation or deployment reference. Only the fields provided in the request are modified.Input Parameters
The reference of the deployment. Must be unique across deployment references in the project. Requirements: 3-100 characters, only lowercase letters, numbers, ’-’ and ’/’, cannot follow deployment name format [a-z]+-[a-z]+-[0-9]+, cannot start with ‘local-’, cannot be reserved keywords: ‘prod’, ‘dev’, ‘cloud’, ‘local’, ‘default’, ‘name’, ‘new’, ‘existing’, ‘deployment’, ‘preview’. Set to null to clear the reference.
The name of the deployment to update (e.g., ‘quiet-llama-744’). This is the unique identifier for the deployment.
Controls whether the dashboard requires confirmation before allowing edits during a browser session. Set to null to reset to default behavior (true for prod deployments, false for dev and preview). Set to true or false to explicitly override the setting.