Skip to main content
POST
/
v1
/
projects
cURL
curl --request POST \
  --url https://{deployment}.convex.site/v1/projects \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "My App",
  "sourceLocale": "en",
  "targetLocales": [
    "nl-NL",
    "fr-FR"
  ]
}
'
{
  "projectId": "<string>"
}

Body

application/json
​
name
string
required
Minimum string length: 1
Example:

"My App"

​
sourceLocale
string
required
Required string length: 2 - 10
Pattern: ^[a-z]{2,3}(-[A-Z]{2,3})?$/i
Example:

"en"

​
targetLocales
string[]
required
Minimum array length: 1
Required string length: 2 - 10
Pattern: ^[a-z]{2,3}(-[A-Z]{2,3})?$/i
Example:
["nl-NL", "fr-FR"]

Response

201 - application/json

Project created successfully

​
projectId
string
required