Sign in
Projects

Create a new project

Changed on

Creates a project for the authenticated user. Each user can create up to 1,000 projects. Requests over this cap return 403.

post/projects

Request

  • Base URL: https://api.volcano.dev
  • URL: https://api.volcano.dev/projects
  • Auth: HTTP bearer

Request body

namestring required

Project name (must be unique). Can only contain letters, numbers, underscores, and hyphens.

template_id'pixel-board' | 'trellini' | 'collab-pad' | 'official-starter'

Optional trusted starter template identifier. The server resolves immutable source and database initialization artifacts. Callers cannot supply artifact locations or database credentials. Creation accepts an asynchronous installation; poll the individual project until template_installation.status is ready before using the app. Use pixel-board, trellini, or collab-pad for the configured starter bundles. The official-starter legacy identifier has environment-specific availability. Cannot be combined with initialPrompt.

initialPromptstring

Optional initial builder prompt. Cannot be combined with template_id.

all_regionsboolean

Optional region policy.

  • true (default): project functions deploy to all configured regions
  • false: project deploys only to selected_regions
selected_regionsstring[]

Optional region subset. Requires all_regions=false. Region names must be a subset of platform AWS_REGIONS.

Example request

{
  "name": "my-awesome-app",
  "template_id": "pixel-board",
  "selected_regions": [
    "us-east-1",
    "us-west-2"
  ]
}

Response

Project created

idstring uuid required
namestring required
status'active' | 'deleting' | 'failed' required
plan'HOBBY' | 'SUPERAGENT'

Plan name applied to the project when available.

all_regionsboolean required

Region policy for function deployment.

  • true: deploy functions to all configured platform regions
  • false: deploy only to selected_regions
selected_regionsstring[] required

Effective region set for this project (normalized and deduplicated)

last_invoked_atstring date-time

Most recent activity timestamp across project resources

logo_urlstring

Relative API path that serves the project logo when one has been uploaded. The path is versioned with a ?v= cache-busting query param that changes on each upload. Absent when the project has no logo. The logo image is stored in the project's storage folder.

created_atstring date-time required
updated_atstring date-time required

Example response

{
  "logo_url": "/projects/3fa85f64-5717-4562-b3fc-2c963f66afa6/logo?v=1718524800"
}

Changes

  • 23e7875e7c4cRevision changes
    • ●

      removed the optional property from the response with the status

    • ○

      added the new optional request property

    • ○

      added the new optional request property

    • ○

      added the non-success response with the status

    • ○

      added the optional property to the response with the status

  • e4c43efdab33Revision changes
    • ○

      removed the FREE enum value from the response property for the response status

    • ○

      removed the PRO enum value from the response property for the response status