v2

latestOpenAPI 3.1.0LicenseRef-Convex2026-07-264790136.4 KB
Projects

Create project

Create a new project on a team, optionally provisioning a dev or prod deployment.

post/teams/{team_id}/create_project

Path parameters

team_idinteger required

Team ID

Request body

projectNamestring required
deploymentType'dev' | 'prod' | 'preview' | 'custom'
deploymentClassstring nullable

When creating a deployment, the class to use for the deployment. If not provided, the default deployment class for your team will be used.

deploymentRegion'aws-us-east-1' | 'aws-eu-west-1'

Response

projectIdinteger required
idinteger required
slugstring required
deploymentNamestring nullable

The readable identifier for this deployment, something like playful-otter-123. Only present when a deployment was requested.

deploymentUrlstring nullable

Deployment cloud URL, where this deployment lives. Only present when a deployment was requested.

All 47 operations