NagentArtefacts
Dev & Technology
Enterprise and White Glove
Company
Convex connects to a Nagent workspace with an API key. Once it is connected, agents can call 19 Convex actions, such as "Create deploy key", "Create Deployment" and "Create Project". Nothing is enabled on connect: each action is allowed one at a time, and an action with side effects runs or waits for a person according to the agent's level.
Every operation an agent can call against Convex, with input parameters and output schema.
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
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
The region where the deployment should be created
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
The ID of the project to create the deployment in
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Team ID where the project will be created
Name of the project to create
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
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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 custom domain name to delete (e.g., 'test-domain.example.com')
The name of the deployment to delete the custom domain from (e.g., 'quiet-llama-744')
The destination type for this custom domain: 'convexCloud' for Convex Cloud deployments or 'convexSite' for Convex Site deployments
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
CONVEX_EXECUTE_QUERY_BATCHTool 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
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
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
CONVEX_GET_DEPLOYMENTTool 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
The name of the deployment to retrieve (e.g., 'quiet-llama-744')
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
The unique identifier of the project to retrieve
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Project slug (unique identifier within the team) to retrieve
Team ID (numeric) or team slug (string identifier) to scope the project lookup
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
The name of the deployment to get the query timestamp for (e.g., 'quiet-llama-744')
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
CONVEX_LIST_DEPLOY_KEYSTool 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
The name of the deployment to list deploy keys for.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
The unique identifier of the team to list deployment classes for.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
The unique identifier for the team whose available deployment regions you want to list.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
CONVEX_LIST_DEPLOYMENTSTool 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
If true, only include default deployments. If false, only include non-default deployments.
Project ID to list deployments for.
If true, include local deployments in the response (filtered to only show local deployments created by the requesting team member).
Only include deployments of the given deployment type.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
CONVEX_LIST_LOG_STREAMSTool 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
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
The unique identifier of the team to list projects for.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
Agents can call 19 Convex actions on Nagent, including "Create deploy key", "Create Deployment" and "Create Project". Create deploy key: Create a deploy key for use with the Convex CLI. Each action is listed on this page with its input parameters and its output.
Convex connects with an API key, under your workspace's own connection. Nothing is enabled on connect: each action is allowed one at a time and can be scoped to the agents that need it.
Create deploy key takes 2 required inputs: name and deployment_name. It returns data, error and successful.