# Get a project ## `GET /v1/projects/{projectId}` Returns details for a specific project, including its configuration. ### Path parameters - `projectId` (integer, required): The ID of the project ### Header parameters - `Authorization` (string, required): `Bearer `. [Authentication](https://spice.ai/docs/cloud/api/management#authentication) lists the tokens it accepts. - `X-Org-Name` (string, optional): 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). Pattern: `^[A-Za-z0-9._-]{1,255}$`. ### Example request ```bash curl "https://api.spice.ai/v1/projects/" \ -H "Authorization: Bearer " ``` ```http GET /v1/projects/ HTTP/1.1 Host: api.spice.ai Authorization: Bearer ``` ### Responses **200 OK** Project details with configuration Content type: `application/json` - `id` (integer) - `name` (string) - `kind` (string): Resolved project hosting model. Allowed values: `managed`, `standalone`, `byoc`. - `description` (string) - `visibility` (string): Allowed values: `public`, `private`. - `created_at` (string (date-time)) - `cluster_name` (string | null): Resolved dedicated cluster name; null for projects not assigned to a dedicated cluster. - `endpoint` (string | null): The data-plane endpoint the project connects to, or null before a standalone instance is attached. - `production_branch` (string) - `api_key` (string, deprecated): Deprecated. Use the API Keys endpoints instead. - `tags` (map of string) - `forked_from` (object | null): The project this project was forked from, while that project is live in the same organization. Null for a project that was not created as a fork. - `id` (integer, required): ID of the source project - `name` (string, required): Name of the source project - `paused_at` (string (date-time) | null): Timestamp when the project was paused; null while running - `config` (object) - `spicepod` (object) - `image_tag` (string): Runtime image tag - `update_channel` (string | null): Update channel for the runtime, or null when Spice operates this project's runtime updates. Allowed values: `stable`, `preview`, `nightly`. - `version` (string): Semver range for the runtime version (e.g. 1.x, 2.x) - `replicas` (integer) - `resources` (object | null): Resource requests and limits for the project container - `limits` (object) - `cpu` (string): Whole-number vCPU limit, or '-' for no CPU limit - `memory` (string): Memory limit in Gi (for example, 16Gi) - `ephemeral-storage` (string) - `requests` (object) - `cpu` (string): CPU request. Minimum 100 millicores (for example, 100m or 0.1). - `memory` (string): Memory request. Minimum 192Mi. - `executor` (object | null): Executor container configuration - `replicas` (integer): Number of executor replicas - `resources` (object): Resource requests and limits for the executor container - `limits` (object) - `cpu` (string): Whole-number vCPU limit, or '-' for no CPU limit - `memory` (string): Memory limit in Gi (for example, 16Gi) - `ephemeral-storage` (string) - `requests` (object) - `cpu` (string): CPU request. Minimum 100 millicores (for example, 100m or 0.1). - `memory` (string): Memory request. Minimum 192Mi. - `storage_size_gb` (number | null) - `region` (string | null): Server-resolved region; null before a standalone instance is attached. - `storage_size_gb` (number | null) - `storage_claim_size_gb` (number, deprecated): Deprecated. Use storage\_size\_gb instead. **401 Unauthorized** Unauthorized **403 Forbidden** Insufficient scope **404 Not Found** Project not found **500 Internal Server Error** Internal server error ## `GET /v1/orgs/{orgId}/projects/{projectId}` The org is `orgId` in the path. Returns details for a specific project, including its configuration. ### Path parameters - `orgId` (integer, required): The org id from GET /v1/orgs. Minimum: `1`. - `projectId` (integer, required): The ID of the project ### Header parameters - `Authorization` (string, required): `Bearer `. [Authentication](https://spice.ai/docs/cloud/api/management#authentication) lists the tokens it accepts. - `X-Org-Name` (string, optional): When present, X-Org-Name must name the same org as orgId. Otherwise the request returns org\_path\_mismatch (400). Pattern: `^[A-Za-z0-9._-]{1,255}$`. ### Example request ```bash curl "https://api.spice.ai/v1/orgs//projects/" \ -H "Authorization: Bearer " ``` ```http GET /v1/orgs//projects/ HTTP/1.1 Host: api.spice.ai Authorization: Bearer ``` ### Responses **200 OK** Project details with configuration Content type: `application/json` - `id` (integer) - `name` (string) - `kind` (string): Resolved project hosting model. Allowed values: `managed`, `standalone`, `byoc`. - `description` (string) - `visibility` (string): Allowed values: `public`, `private`. - `created_at` (string (date-time)) - `cluster_name` (string | null): Resolved dedicated cluster name; null for projects not assigned to a dedicated cluster. - `endpoint` (string | null): The data-plane endpoint the project connects to, or null before a standalone instance is attached. - `production_branch` (string) - `api_key` (string, deprecated): Deprecated. Use the API Keys endpoints instead. - `tags` (map of string) - `forked_from` (object | null): The project this project was forked from, while that project is live in the same organization. Null for a project that was not created as a fork. - `id` (integer, required): ID of the source project - `name` (string, required): Name of the source project - `paused_at` (string (date-time) | null): Timestamp when the project was paused; null while running - `config` (object) - `spicepod` (object) - `image_tag` (string): Runtime image tag - `update_channel` (string | null): Update channel for the runtime, or null when Spice operates this project's runtime updates. Allowed values: `stable`, `preview`, `nightly`. - `version` (string): Semver range for the runtime version (e.g. 1.x, 2.x) - `replicas` (integer) - `resources` (object | null): Resource requests and limits for the project container - `limits` (object) - `cpu` (string): Whole-number vCPU limit, or '-' for no CPU limit - `memory` (string): Memory limit in Gi (for example, 16Gi) - `ephemeral-storage` (string) - `requests` (object) - `cpu` (string): CPU request. Minimum 100 millicores (for example, 100m or 0.1). - `memory` (string): Memory request. Minimum 192Mi. - `executor` (object | null): Executor container configuration - `replicas` (integer): Number of executor replicas - `resources` (object): Resource requests and limits for the executor container - `limits` (object) - `cpu` (string): Whole-number vCPU limit, or '-' for no CPU limit - `memory` (string): Memory limit in Gi (for example, 16Gi) - `ephemeral-storage` (string) - `requests` (object) - `cpu` (string): CPU request. Minimum 100 millicores (for example, 100m or 0.1). - `memory` (string): Memory request. Minimum 192Mi. - `storage_size_gb` (number | null) - `region` (string | null): Server-resolved region; null before a standalone instance is attached. - `storage_size_gb` (number | null) - `storage_claim_size_gb` (number, deprecated): Deprecated. Use storage\_size\_gb instead. **400 Bad Request** orgId is not a valid org id (`invalid_org_id`), or X-Org-Name does not name that org (`org_path_mismatch`). **401 Unauthorized** Unauthorized **403 Forbidden** Insufficient scope. The caller is not a member of the org (`org_forbidden`). A machine credential named a different org (`org_assertion_mismatch`). The org is deleted (`org_deleted`). **404 Not Found** Project not found **500 Internal Server Error** Internal server error ## `GET /v1/apps/{appId}` (deprecated) Legacy alias of `/v1/projects/{projectId}` — projects were previously called apps. Returns details for a specific project, including its configuration. ### Path parameters - `appId` (integer, required): The ID of the project ### Header parameters - `Authorization` (string, required): `Bearer `. [Authentication](https://spice.ai/docs/cloud/api/management#authentication) lists the tokens it accepts. - `X-Org-Name` (string, optional): 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). Pattern: `^[A-Za-z0-9._-]{1,255}$`. ### Example request ```bash curl "https://api.spice.ai/v1/apps/" \ -H "Authorization: Bearer " ``` ```http GET /v1/apps/ HTTP/1.1 Host: api.spice.ai Authorization: Bearer ``` ### Responses **200 OK** Project details with configuration Content type: `application/json` - `id` (integer) - `name` (string) - `kind` (string): Resolved project hosting model. Allowed values: `managed`, `standalone`, `byoc`. - `description` (string) - `visibility` (string): Allowed values: `public`, `private`. - `created_at` (string (date-time)) - `cluster_name` (string | null): Resolved dedicated cluster name; null for projects not assigned to a dedicated cluster. - `endpoint` (string | null): The data-plane endpoint the project connects to, or null before a standalone instance is attached. - `production_branch` (string) - `api_key` (string, deprecated): Deprecated. Use the API Keys endpoints instead. - `tags` (map of string) - `forked_from` (object | null): The project this project was forked from, while that project is live in the same organization. Null for a project that was not created as a fork. - `id` (integer, required): ID of the source project - `name` (string, required): Name of the source project - `paused_at` (string (date-time) | null): Timestamp when the project was paused; null while running - `config` (object) - `spicepod` (object) - `image_tag` (string): Runtime image tag - `update_channel` (string | null): Update channel for the runtime, or null when Spice operates this project's runtime updates. Allowed values: `stable`, `preview`, `nightly`. - `version` (string): Semver range for the runtime version (e.g. 1.x, 2.x) - `replicas` (integer) - `resources` (object | null): Resource requests and limits for the project container - `limits` (object) - `cpu` (string): Whole-number vCPU limit, or '-' for no CPU limit - `memory` (string): Memory limit in Gi (for example, 16Gi) - `ephemeral-storage` (string) - `requests` (object) - `cpu` (string): CPU request. Minimum 100 millicores (for example, 100m or 0.1). - `memory` (string): Memory request. Minimum 192Mi. - `executor` (object | null): Executor container configuration - `replicas` (integer): Number of executor replicas - `resources` (object): Resource requests and limits for the executor container - `limits` (object) - `cpu` (string): Whole-number vCPU limit, or '-' for no CPU limit - `memory` (string): Memory limit in Gi (for example, 16Gi) - `ephemeral-storage` (string) - `requests` (object) - `cpu` (string): CPU request. Minimum 100 millicores (for example, 100m or 0.1). - `memory` (string): Memory request. Minimum 192Mi. - `storage_size_gb` (number | null) - `region` (string | null): Server-resolved region; null before a standalone instance is attached. - `storage_size_gb` (number | null) - `storage_claim_size_gb` (number, deprecated): Deprecated. Use storage\_size\_gb instead. **401 Unauthorized** Unauthorized **403 Forbidden** Insufficient scope **404 Not Found** Project not found **500 Internal Server Error** Internal server error OpenAPI: [api.spice.ai/openapi.json](https://api.spice.ai/openapi.json)