# Convex

Backend-as-a-Service platform with real-time database, serverless functions, and built-in authentication

- **Category:** developer tools
- **Auth:** API_KEY, API_KEY, OAUTH2
- **Composio Managed App Available?** Yes
- **Tools:** 19
- **Triggers:** 0
- **Slug:** `CONVEX`
- **Version:** 00000000_00

## Tools

### Create deploy key

**Slug:** `CONVEX_CREATE_DEPLOY_KEY`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name for the deploy key. This is a human-readable identifier that helps you remember what this key is used for. |
| `deployment_name` | string | Yes | The name of the deployment for which to create the deploy key. This identifies the specific Convex deployment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Deployment

**Slug:** `CONVEX_CREATE_DEPLOYMENT`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `type` | string ("dev" | "prod" | "custom") | Yes | The type of deployment to create: 'dev' for development, 'prod' for production, or 'custom' for custom deployment |
| `class` | string | No | The class to use for this deployment. If not provided, the default deployment class for your team will be used |
| `region` | string | No | The region where the deployment should be created |
| `reference` | string | No | 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 |
| `project_id` | integer | Yes | The ID of the project to create the deployment in |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Project

**Slug:** `CONVEX_CREATE_PROJECT`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `team_id` | integer | Yes | Team ID where the project will be created |
| `projectName` | string | Yes | Name of the project to create |
| `deploymentType` | string | No | Type of deployment to create (e.g., 'dev' or 'prod'). If not provided, no deployment will be created initially. |
| `deploymentClass` | string | No | Class to use for the deployment. If not provided, the default deployment class for your team will be used. |
| `deploymentRegion` | string | No | Region where the deployment should be hosted. If not provided, uses the default region for your team. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Custom Domain

**Slug:** `CONVEX_DELETE_CUSTOM_DOMAIN`

Tool to remove a custom domain from a Convex deployment. Use when you need to delete a previously configured custom domain.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `domain` | string | Yes | The custom domain name to delete (e.g., 'test-domain.example.com') |
| `deployment_name` | string | Yes | The name of the deployment to delete the custom domain from (e.g., 'quiet-llama-744') |
| `requestDestination` | string ("convexCloud" | "convexSite") | Yes | The destination type for this custom domain: 'convexCloud' for Convex Cloud deployments or 'convexSite' for Convex Site deployments |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Deployment

**Slug:** `CONVEX_DELETE_DEPLOYMENT`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `deployment_name` | string | Yes | The name of the deployment to delete. This will permanently delete all data and files in the deployment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete project

**Slug:** `CONVEX_DELETE_PROJECT`

Deletes 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | integer | Yes | The unique identifier of the project to delete. This will delete the project and all its deployments permanently. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Execute Query Batch

**Slug:** `CONVEX_EXECUTE_QUERY_BATCH`

Tool to execute multiple Convex query functions in a single batch request. Use when you need to fetch data from multiple queries efficiently in one API call.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `queries` | array | Yes | Array of query items to execute in the batch. Each item specifies a query function path and its arguments. |
| `deployment_url` | string | No | Full deployment URL (e.g., 'https://quiet-llama-744.convex.cloud'). If not provided, uses the base_url from auth metadata. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Deployment Details

**Slug:** `CONVEX_GET_DEPLOYMENT`

Tool to retrieve details about a Convex cloud deployment. Use when you need to get information about a specific deployment including its configuration, region, creation time, and status.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `deployment_name` | string | Yes | The name of the deployment to retrieve (e.g., 'quiet-llama-744') |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Project by ID

**Slug:** `CONVEX_GET_PROJECT_BY_ID`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | integer | Yes | The unique identifier of the project to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Project by Slug

**Slug:** `CONVEX_GET_PROJECT_BY_SLUG`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_slug` | string | Yes | Project slug (unique identifier within the team) to retrieve |
| `team_id_or_slug` | string | Yes | Team ID (numeric) or team slug (string identifier) to scope the project lookup |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Query Timestamp

**Slug:** `CONVEX_GET_QUERY_TIMESTAMP`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `deployment_name` | string | Yes | The name of the deployment to get the query timestamp for (e.g., 'quiet-llama-744') |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get token details

**Slug:** `CONVEX_GET_TOKEN_DETAILS`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Deploy Keys

**Slug:** `CONVEX_LIST_DEPLOY_KEYS`

Tool to list all deploy keys for a specified Convex deployment. Use when you need to view all authentication tokens that can be used to deploy to this deployment.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `deployment_name` | string | Yes | The name of the deployment to list deploy keys for. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List deployment classes

**Slug:** `CONVEX_LIST_DEPLOYMENT_CLASSES`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `team_id` | string | Yes | The unique identifier of the team to list deployment classes for. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List deployment regions

**Slug:** `CONVEX_LIST_DEPLOYMENT_REGIONS`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `team_id` | string | Yes | The unique identifier for the team whose available deployment regions you want to list. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Deployments

**Slug:** `CONVEX_LIST_DEPLOYMENTS`

Tool to list all deployments for a Convex project. Use when you need to see all deployments (production, preview, or local) for a specific project.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `isDefault` | boolean | No | If true, only include default deployments. If false, only include non-default deployments. |
| `project_id` | integer | Yes | Project ID to list deployments for. |
| `includeLocal` | boolean | No | If true, include local deployments in the response (filtered to only show local deployments created by the requesting team member). |
| `deploymentType` | string | No | Only include deployments of the given deployment type. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Log Streams

**Slug:** `CONVEX_LIST_LOG_STREAMS`

Tool to list all existing log stream configurations in a deployment. Use when you need to view configured log streaming destinations like Datadog, Webhook, Axiom, or Sentry.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Projects

**Slug:** `CONVEX_LIST_PROJECTS`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `team_id` | integer | Yes | The unique identifier of the team to list projects for. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Deployment

**Slug:** `CONVEX_UPDATE_DEPLOYMENT`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `reference` | string | No | 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. |
| `deployment_name` | string | Yes | The name of the deployment to update (e.g., 'quiet-llama-744'). This is the unique identifier for the deployment. |
| `dashboard_edit_confirmation` | boolean | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |