SPspice
Projects

Get a project

Returns details for a specific project, including its configuration.

get/v1/projects/{projectId}

Request

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

Path parameters

projectIdinteger required

The ID of the project

Headers

X-Org-Namestring

The organization to act on, by handle. Omit it to act on the organization the credential is bound to; sending it blank is a 400, not the same as omitting it. A user credential may name any organization its owner belongs to; a machine credential is pinned to its own. A portal session token is bound to none, so it must send this header on every route but GET /v1/orgs (400 org_assertion_required otherwise).

Response

Project details with configuration

idinteger
namestring
kind'managed' | 'standalone' | 'byoc'

Resolved project hosting model

descriptionstring
visibility'public' | 'private'
created_atstring date-time
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
api_keystring

Deprecated. Use the API Keys endpoints instead.

tagsobject
paused_atstring date-time nullable

Timestamp when the project was paused; null while running

Changes

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