Convex

Convex integration (Developer Tools). Imported from open-connector.

OAuth19 toolshttps://{trimmed}.convex.cloud

GET

convex_get_token_details

Return the current Convex token details so you can discover the authorized team or project context.

/token_details

GET

convex_list_projects

List all Convex projects for a team.

/list_projects

1 parameter

Param	Type	Required	Description
team_id	integer	required	The Convex team ID.

POST

convex_create_project

Create a Convex project on a team, optionally provisioning an initial dev or prod deployment.

/create_project

5 parameters

Param	Type	Required	Description
team_id	integer	required	The Convex team ID.
projectName	string	required	The project name.
deploymentType	string	optional	The initial deployment type.
deploymentClass	string	optional	The deployment class.
deploymentRegion	string	optional	The deployment region.

GET

convex_get_project_by_id

Get a Convex project by numeric project ID.

/projects/{projectId}

2 parameters

Param	Type	Required	Description
project_id	integer	required	The Convex project ID.
projectId	string	required	Path parameter: projectId

GET

convex_get_project_by_slug

Get a Convex project by team identifier or slug plus project slug.

/teams/{teamIdOrSlug}/projects/{projectSlug}

4 parameters

Param	Type	Required	Description
team_id_or_slug	string	required	The Convex team ID or slug.
project_slug	string	required	The project slug.
teamIdOrSlug	string	required	Path parameter: teamIdOrSlug
projectSlug	string	required	Path parameter: projectSlug

GET

convex_list_deployments

List deployments for a Convex project.

/list_deployments

4 parameters

Param	Type	Required	Description
project_id	integer	required	The Convex project ID.
includeLocal	boolean	optional	Whether to include local deployments.
isDefault	boolean	optional	Whether to filter to default deployments.
deploymentType	string	optional	Deployment type filter.

GET

convex_get_deployment

Get a cloud deployment by deployment name.

/deployments/{deploymentName}

2 parameters

Param	Type	Required	Description
deployment_name	string	required	The deployment name.
deploymentName	string	required	Path parameter: deploymentName

POST

convex_delete_deployment

Delete a Convex deployment and all of its data.

/deployments/{deploymentName}/delete

2 parameters

Param	Type	Required	Description
deployment_name	string	required	The deployment name.
deploymentName	string	required	Path parameter: deploymentName

GET

convex_list_deployment_classes

List available deployment classes for a Convex team.

/teams/{teamId}/list_deployment_classes

2 parameters

Param	Type	Required	Description
team_id	integer	required	The Convex team ID.
teamId	string	required	Path parameter: teamId

GET

convex_list_deployment_regions

List available deployment regions for a Convex team.

/teams/{teamId}/list_deployment_regions

2 parameters

Param	Type	Required	Description
team_id	integer	required	The Convex team ID.
teamId	string	required	Path parameter: teamId

POST

convex_create_deploy_key

Create a deploy key for a Convex deployment.

/deployments/{deploymentName}/create_deploy_key

3 parameters

Param	Type	Required	Description
deployment_name	string	required	The deployment name.
name	string	required	The deploy key name.
deploymentName	string	required	Path parameter: deploymentName

GET

convex_list_deploy_keys

List deploy keys for a Convex deployment.

/deployments/{deploymentName}/list_deploy_keys

2 parameters

Param	Type	Required	Description
deployment_name	string	required	The deployment name.
deploymentName	string	required	Path parameter: deploymentName

POST

convex_delete_deploy_key

Delete a deploy key for a Convex deployment.

/deployments/{deploymentName}/delete_deploy_key

3 parameters

Param	Type	Required	Description
deployment_name	string	required	The deployment name.
id	string	required	The deploy key ID.
deploymentName	string	required	Path parameter: deploymentName

GET

convex_list_custom_domains

List custom domains configured for a Convex deployment.

/deployments/{deploymentName}/custom_domains

2 parameters

Param	Type	Required	Description
deployment_name	string	required	The deployment name.
deploymentName	string	required	Path parameter: deploymentName

POST

convex_delete_custom_domain

Remove a custom domain from a Convex deployment.

/deployments/{deploymentName}/delete_custom_domain

3 parameters

Param	Type	Required	Description
deployment_name	string	required	The deployment name.
domain	string	required	The custom domain.
deploymentName	string	required	Path parameter: deploymentName

POST

convex_run_query

Execute a Convex query through the deployment HTTP API.

/api/query

4 parameters

Param	Type	Required	Description
path	string	required	The Convex function path.
args	object	optional	Convex function arguments.
format	string	optional	Request JSON result format.
deployment_url	string	optional	The hosted *.convex.cloud deployment URL or deployment name prefix for the quer…

POST

convex_run_mutation

Execute a Convex mutation through the deployment HTTP API.

/api/mutation

4 parameters

Param	Type	Required	Description
path	string	required	The Convex function path.
args	object	optional	Convex function arguments.
format	string	optional	Request JSON result format.
deployment_url	string	optional	The hosted *.convex.cloud deployment URL or deployment name prefix for the muta…

POST

convex_run_action

Execute a Convex action through the deployment HTTP API.

/api/action

4 parameters

Param	Type	Required	Description
path	string	required	The Convex function path.
args	object	optional	Convex function arguments.
format	string	optional	Request JSON result format.
deployment_url	string	optional	The hosted *.convex.cloud deployment URL or deployment name prefix for the acti…

POST

convex_run_function

Execute an arbitrary Convex function through `/api/run/{functionIdentifier}`.

/api/run/{functionIdentifier}

4 parameters

Param	Type	Required	Description
functionIdentifier	string	required	The slash or colon separated function identifier.
args	object	optional	Convex function arguments.
format	string	optional	—
deployment_url	string	optional	The hosted *.convex.cloud deployment URL or deployment name prefix.