Convex integration: operations for AI agents
Convex connects to Type.com as an integration. This page lists the 48 operations documented for Claude and Codex in Type.com: 22 read, 12 write, 14 destructive.
About Convex
Convex Platform Management API reference operations, subject to Type setup and account permissions.
Categories: Developer Tools & IT
How to connect Convex to Type.com
- Connect
- Configure provider-specific API target and authentication setup.
- Access
- Organization connection: one shared account for the workspace.
To add the connection, follow the steps in Space connections.
Documented operations
48 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.
48 operations listed.
Projects
- Read
Get project by ID
Get a project by its ID.
GET /projects/{project_id} - Read
List projects
List a page of projects for a team, ordered by descending project ID. Pass `limit` to set the page size and the `nextCursor` from the previous response as `cursor` to fetch the next page.
GET /teams/{team_id}/projects - Read
Get project by slug
Get a project by its slug.
GET /teams/{team_id_or_slug}/projects/{project_slug} - Write
Create project
Create a new project on a team, optionally provisioning a dev or prod deployment.
POST /teams/{team_id}/create_project - Destructive
Update project
Update a project's name, slug, and/or tags. Returns the updated project.
PATCH /projects/{project_id} - Destructive
Delete project
Delete a project. Deletes all deployments in the project as well.
POST /projects/{project_id}/delete
Deployments
- Read
List deployments
List deployments for a projects.
GET /projects/{project_id}/list_deployments - Read
Get deployment in project by id
Get a deployment within a project by reference, default production deployment, or default dev deployment for the calling user.
GET /projects/{project_id}/deployment - Read
Get deployment in project by slug
Get a deployment within a project identified by team and project slug, by reference, default production deployment, or default dev deployment for the calling user.
GET /teams/{team_id_or_slug}/projects/{project_slug}/deployment - Read
Get deployment
Get details about a cloud deployment.
GET /deployments/{deployment_name} - Read
List deployment classes
Lists the available deployment classes for a team.
GET /teams/{team_id}/list_deployment_classes - Read
List deployment regions
Lists the available deployment regions for a team.
GET /teams/{team_id}/list_deployment_regions - Read
List deployments for team
Lists deployments for a team with pagination, sorting, and filtering.
GET /teams/{team_id}/list_deployments - Read
List local deployments
Lists the local deployments for a team.
GET /teams/{team_id}/list_local_deployments - Write
Create deployment
Create a new deployment for a project.
POST /projects/{project_id}/create_deployment - Write
Transfer deployment
Transfer a deployment from its current project to another project within the same team. For production deployments, the caller must be a project admin on both the source and destination projects. For other deployment types, any team member can transfer deployments they created, or project admins can transfer any deployment.
POST /deployments/{deployment_name}/transfer - Write
Mint an AI gateway JWT
Mints a short-lived AI gateway JWT for a local deployment.
POST /deployments/{deployment_name}/mint_ai_gateway_jwt - Destructive
Delete deployment
Delete a deployment. This will delete all data and files in the deployment, so we recommend creating and downloading a backup before calling this endpoint. This does not delete the project itself.
POST /deployments/{deployment_name}/delete - Destructive
Update deployment
Updates properties of an existing deployment. Only the fields provided in the request body are modified; omitted fields are left unchanged.
PATCH /deployments/{deployment_name}
Deploy Keys
- Read
List deploy keys
Lists all deploy keys for the specified deployment.
GET /deployments/{deployment_name}/list_deploy_keys - Read
List preview deploy keys
Lists all preview deploy keys for the specified project.
GET /projects/{project_id}/list_preview_deploy_keys - Write
Create deploy key
Create a deploy key like "dev:happy-animal-123|ey..." which can be used with the Convex CLI to develop against or deploy code. When access to the deployment is granted through an OAuth token this deploy key will use the same OAuth-granted token. When access to the deployment is granted any other way a new token will be created which grants access only to this deployment.
POST /deployments/{deployment_name}/create_deploy_key - Write
Create preview deploy key
Create a preview deploy key like "preview:team-slug:project-slug|ey..." which can be used with the Convex CLI to create and manage preview deployments within the project. When access to the project is granted through an OAuth token this preview deploy key will use the same OAuth-granted token. When access to the project is granted any other way a new token scoped to preview deployments in this project will be created.
POST /projects/{project_id}/create_preview_deploy_key - Destructive
Delete deploy key
Deletes a deploy key for the specified deployment. The `id` in the request body can be the full deploy key (with prefix), encoded token, or the name of the deploy key.
POST /deployments/{deployment_name}/delete_deploy_key - Destructive
Delete preview deploy key
Deletes a preview deploy key for the specified project. The `id` in the request body can be the full preview deploy key (with prefix), encoded token, or the name of the preview deploy key.
POST /projects/{project_id}/delete_preview_deploy_key
Access Tokens
- Read
List personal access tokens
Lists all personal access tokens for the authenticated user.
GET /list_personal_access_tokens - Read
List team access tokens
Lists the team access tokens created by the authenticated member for the given team.
GET /teams/{team_id}/list_access_tokens - Read
Get token details
Returns the team ID for team tokens. Especially useful after receiving a team token from an OAuth flow since most endpoints require team ID.
GET /token_details - Write
Create personal access token
Creates a new personal access token for the authenticated user.
POST /create_personal_access_token - Write
Create a team access token
POST /teams/{team_id}/create_access_token
POST /teams/{team_id}/create_access_token - Destructive
Delete personal access token
Deletes a personal access token for the authenticated user. The `id` in the request body can be the encoded token secret or the name of the token.
POST /delete_personal_access_token - Destructive
Delete a team access token
Deletes a team access token, identified by its secret value or name.
POST /teams/{team_id}/delete_access_token
Custom Domains
- Read
List custom domains
Get all custom domains configured for a deployment.
GET /deployments/{deployment_name}/custom_domains - Write
Create custom domain
POST /deployments/{deployment_name}/create_custom_domain
POST /deployments/{deployment_name}/create_custom_domain - Destructive
Delete custom domain
Remove a custom domain from a deployment.
POST /deployments/{deployment_name}/delete_custom_domain
Teams
- Read
List team members
List the members of the given team.
GET /teams/{team_id}/list_members - Read
List audit log events
List a team's audit log events within a time range, with optional filters.
GET /teams/{team_id}/list_audit_log_events - Read
List pending team invitations
List the pending invitations for the given team.
GET /teams/{team_id}/list_pending_invites - Write
Create a team
This endpoint is not publicly accessible. It is reserved for specific integrations that have been granted permission to create teams on behalf of users. To request access, contact platforms@convex.dev.
POST /teams/create_team - Write
Invite a team member
Invite a member to the given team by email. `role` is required and must be one of `admin`, `developer`, or `custom`. Pass `custom` together with a non-empty `customRoles` list to invite a member into a custom role; for `admin` and `developer`, `customRoles` must be omitted.
POST /teams/{team_id}/invite_team_member - Destructive
Cancel a pending team invitation
POST /teams/{team_id}/cancel_team_member_invite
POST /teams/{team_id}/cancel_team_member_invite - Destructive
Update a team member's role
Sets either the member's built-in `role` (admin/developer) or their `customRoles`. The two fields are mutually exclusive: setting `role` clears `customRoles`, and setting `customRoles` (must be non-empty) puts the member in the `custom` role.
POST /teams/{team_id}/update_team_member_role
Environment Variables
- Read
List default environment variables
Lists all default environment variables for the specified project, with optional filtering by name and deployment type.
GET /projects/{project_id}/list_default_environment_variables - Destructive
Update default environment variables
Creates, updates, or deletes default environment variables for the specified project. When `value` is a string, the variable is upserted. When `value` is null, the variable is deleted.
POST /projects/{project_id}/update_default_environment_variables
Custom Roles
- Read
List custom roles
Lists all custom roles for the team with cursor-based pagination.
GET /teams/{team_id}/list_custom_roles - Write
Create a custom role
Creates a new custom role for the team with the specified name, description, and permission statements.
POST /teams/{team_id}/create_custom_role - Destructive
Update a custom role
Updates an existing custom role's name, description, and permission statements.
POST /teams/{team_id}/update_custom_role - Destructive
Delete a custom role
Deletes a custom role from the team. Fails with `CustomRoleInUse` if the role is still attached to any team members; reassign those members (e.g. via `update_team_member_role`) before retrying.
POST /teams/{team_id}/delete_custom_role
No operations match.
See How connections work for access and permissions, or browse all integrations.