Projects

Create project

Changed on

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

post/teams/{team_id}/create_project

Request

  • Base URL: https://api.convex.dev/v1
  • URL: https://api.convex.dev/v1/teams/{team_id}/create_project
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer

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' | 'aws-ca-central-1' | 'aws-ap-southeast-2'

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.

Changes

  • f687660da499Revision changes
    • info

      added the new aws-ap-southeast-2 enum value to the request property ////

    • info

      added the new aws-ca-central-1 enum value to the request property ////