Skip to main content
Convex logo
  • Category: developer tools
  • Auth: API_KEY, BEARER_TOKEN
  • Composio-managed OAuth available? N/A
  • Tools: 19
  • Triggers: 0
  • Slug: CONVEX
  • Version: 20261101_00

Tools

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

string
required
Name for the deploy key. This is a human-readable identifier that helps you remember what this key is used for.
string
required
The name of the deployment for which to create the deploy key. This identifies the specific Convex deployment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
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

string ("dev" | "prod" | "custom")
required
The type of deployment to create: ‘dev’ for development, ‘prod’ for production, or ‘custom’ for custom deployment
string
The class to use for this deployment. If not provided, the default deployment class for your team will be used
string
The region where the deployment should be created
string
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
integer
required
The ID of the project to create the deployment in

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
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

integer
required
Team ID where the project will be created
string
required
Name of the project to create
string
Type of deployment to create (e.g., ‘dev’ or ‘prod’). If not provided, no deployment will be created initially.
string
Class to use for the deployment. If not provided, the default deployment class for your team will be used.
string
Region where the deployment should be hosted. If not provided, uses the default region for your team.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
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

string
required
The custom domain name to delete (e.g., ‘test-domain.example.com’)
string
required
The name of the deployment to delete the custom domain from (e.g., ‘quiet-llama-744’)
string ("convexCloud" | "convexSite")
required
The destination type for this custom domain: ‘convexCloud’ for Convex Cloud deployments or ‘convexSite’ for Convex Site deployments

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
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

string
required
The name of the deployment to delete. This will permanently delete all data and files in the deployment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
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

integer
required
The unique identifier of the project to delete. This will delete the project and all its deployments permanently.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
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
required
Array of query items to execute in the batch. Each item specifies a query function path and its arguments.
string
Full deployment URL (e.g., ‘https://quiet-llama-744.convex.cloud’). If not provided, uses the base_url from auth metadata.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONVEX_GET_DEPLOYMENTRetrieves details for a named Convex deployment, including cloud or local deployment information such as creation time and configuration. Available fields depend on the deployment kind.

Input Parameters

string
required
The name of the deployment to retrieve (e.g., ‘quiet-llama-744’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONVEX_GET_PROJECT_BY_IDTool to retrieve detailed information about a specific Convex project by its ID. Use when you need to fetch project metadata including name, slug, team association, and creation time.

Input Parameters

integer
required
The unique identifier of the project to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONVEX_GET_PROJECT_BY_SLUGTool to retrieve a Convex project by its slug within a team. Use when you need to fetch project details using human-readable identifiers instead of numeric IDs.

Input Parameters

string
required
Project slug (unique identifier within the team) to retrieve
string
required
Team ID (numeric) or team slug (string identifier) to scope the project lookup

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONVEX_GET_QUERY_TIMESTAMPTool to get the latest timestamp for queries from Convex deployment. Use when you need to retrieve the current query timestamp from the Convex API.

Input Parameters

string
required
The name of the deployment to get the query timestamp for (e.g., ‘quiet-llama-744’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONVEX_GET_TOKEN_DETAILSTool to retrieve token details for the authenticated token. Returns the team ID for team tokens or project ID for project tokens. Especially useful after receiving a token from an OAuth flow to identify which team or project it belongs to.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONVEX_LIST_DEPLOY_KEYSLists deploy key metadata for a specified Convex deployment, including names, creation times, and available creator and last-used information. It does not return the key values.

Input Parameters

string
required
The name of the deployment to list deploy keys for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONVEX_LIST_DEPLOYMENT_CLASSESTool to list available deployment classes for a Convex team. Use when you need to check which deployment classes are available for a specific team.

Input Parameters

string
required
The unique identifier of the team to list deployment classes for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONVEX_LIST_DEPLOYMENT_REGIONSTool to list available deployment regions for a Convex team. Use when you need to check which regions are available for deploying a team’s backend.

Input Parameters

string
required
The unique identifier for the team whose available deployment regions you want to list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
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

boolean
If true, only include default deployments. If false, only include non-default deployments.
integer
required
Project ID to list deployments for.
boolean
If true, include local deployments in the response (filtered to only show local deployments created by the requesting team member).
string
Only include deployments of the given deployment type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONVEX_LIST_LOG_STREAMSLists log stream configurations for a deployment so you can view configured destinations and their statuses. An empty result does not necessarily mean that no streams are configured.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONVEX_LIST_PROJECTSTool to list all projects for a specific Convex team. Use when you need to retrieve all projects associated with a team by team ID.

Input Parameters

integer
required
The unique identifier of the team to list projects for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
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

string
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.
string
required
The name of the deployment to update (e.g., ‘quiet-llama-744’). This is the unique identifier for the deployment.
boolean
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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not