SPspice
Projects

Create a project

The org is orgId in the path. Creates a new project in the authenticated organization.

post/v1/orgs/{orgId}/projects

Request

  • Base URL
    https://api.spice.ai
  • Auth
    HTTP bearer

Path parameters

orgIdinteger required

The org id from GET /v1/orgs

Headers

X-Org-Namestring

When present, X-Org-Name must name the same org as orgId. Otherwise the request returns org_path_mismatch (400).

Request body

namestring required

Project name (letters, numbers, hyphens only)

region'us-east-1' | 'us-west-2'

Cloud region where a managed project will be deployed (e.g. us-east-1). Omit this, cname, and cluster_name to create an unattached standalone project whose placement is resolved when linked.

cnamestring

Deprecated. Internal region CNAME (e.g. us-east-1-prod-aws-data). Use region instead. Accepted for backwards compatibility when region is omitted. Omit all region sources to create an unattached standalone project.

cluster_namestring

Name of the dedicated cluster to deploy to, as listed by GET /v1/clusters. Provide exactly one of region or cluster_name. When set, the region/routing are derived from the cluster; if region is also provided it must match the cluster's region. Omit all region sources to create an unattached standalone project.

descriptionstring

Project description

visibility'public' | 'private'
default_alertsboolean

Create default monitoring alerts for the new managed project. False skips initial setup. Manual alert creation remains available.

tagsobject

Key-value tags for the project

update_channel'stable' | 'preview' | 'nightly'

Update channel for a managed project deployment. A standalone project has no spicepod until linking, so configure its channel after linking.

replicasinteger

Number of replicas for a managed project. Rejected for standalone projects.

Response

Project created successfully. The response may include a warning field if initial configuration could not be applied.

idinteger

Unique identifier for the project

namestring

Name of the project

kind'managed' | 'standalone' | 'byoc'

Resolved project hosting model

descriptionstring nullable

Description of the project

visibility'public' | 'private'

Visibility setting for the project

created_atstring date-time

Timestamp when the project was created

cnamestring nullable

Region identifier

cluster_namestring nullable

Resolved dedicated cluster name; null for projects not assigned to a dedicated cluster.

endpointstring nullable

The data-plane endpoint the project connects to, or null before a standalone instance is attached.

production_branchstring nullable

Production branch for the project

api_keystring

Deprecated. Use the API Keys endpoints instead.

tagsobject nullable

Key-value tags for the project

paused_atstring date-time nullable

Timestamp when the project was paused; null while running

warningstring nullable

Present when the project was created but initial configuration could not be applied

Changes

No recorded changes to this operation across all 1 revision of this API.