> ## Documentation Index
> Fetch the complete documentation index at: https://cerebrium-mintlify-5834c333.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Project

> Retrieve details of a specific project by its ID.



## OpenAPI

````yaml https://s3.eu-west-1.amazonaws.com/www.cerebrium.ai/openapi_spec.json get /v2/projects/{project_id}
openapi: 3.0.0
info:
  title: Cerebrium REST API
  description: >-
    REST API for interacting with Cerebrium. This API is mainly used by the
    Cerebrium CLI client, please run `pip install cerebrium` to install it.
  version: 1.0.0
  license:
    name: Proprietary
    url: https://www.cerebrium.ai/terms-of-service
servers:
  - url: https://rest.cerebrium.ai
security: []
paths:
  /v2/projects/{project_id}:
    get:
      tags:
        - Projects
      summary: Get Project
      description: Retrieve details of a specific project by its ID.
      operationId: getProject
      parameters:
        - name: project_id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Details of the requested project.
          content:
            application/json:
              schema:
                properties:
                  aboutInfo:
                    description: >-
                      Short description of what the project is used for. Omitted
                      when not set.
                    type: string
                  alertAmountDollars:
                    description: >-
                      Monthly spend amount in US dollars at which a usage alert
                      is sent.
                    type: integer
                  basePlanAmountCents:
                    description: Base subscription plan amount in US cents.
                    type: integer
                  createdAt:
                    description: Timestamp when the project was created, in RFC3339 format.
                    type: string
                  createdByUserId:
                    description: ID of the user who created the project.
                    type: string
                  effectiveLimits:
                    description: Resource limits in effect for the project's plan tier.
                    type: object
                  emailAddress:
                    description: Billing contact email address for the project.
                    type: string
                  hardwareCosts:
                    description: >-
                      Compute pricing entries for the project. Each item has
                      billableMetricCode (string), amountPerSecond (number), and
                      type (string) fields.
                    type: array
                  id:
                    description: Unique identifier of the project.
                    type: string
                  name:
                    description: Name of the project.
                    type: string
                  onboarding:
                    description: >-
                      Onboarding answers for the project, with intent,
                      companyWebsite, useCases, and otherUseCaseReason keys.
                      Omitted when the project has none.
                    type: object
                  ownerEmailAddress:
                    description: Email address of the project owner.
                    type: string
                  protected:
                    description: >-
                      Whether the project runs on the protected compute tier.
                      Omitted when false.
                    type: boolean
                  requiresPaymentMethod:
                    description: Whether a payment method must be added before deploying.
                    type: boolean
                  telephoneNumber:
                    description: >-
                      Contact telephone number for the project. Omitted when not
                      set.
                    type: string
                  updatedAt:
                    description: >-
                      Timestamp when the project was last updated, in RFC3339
                      format.
                    type: string
                type: object
        '400':
          description: >-
            Bad request. The request was malformed or contained invalid
            parameters.
          content:
            application/json:
              schema:
                properties:
                  message:
                    description: Human-readable description of the error.
                    type: string
                type: object
        '401':
          description: >-
            Unauthorized. The Authorization header is missing or the token is
            invalid.
          content:
            application/json:
              schema:
                properties:
                  message:
                    description: Human-readable description of the error.
                    type: string
                type: object
      security:
        - BearerAuth: []
components:
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: >-
        Service Account Token authentication. To authenticate API requests:


        1. **Create a Service Account Token:**
           - Go to the [Cerebrium Dashboard](https://dashboard.cerebrium.ai/) and open the **API Keys** page
           - Click **Create Service Account**, name it (e.g., "GitHub Actions CI/CD"), choose an expiry date, and click **Create**
           - **Copy the token** generated for the desired service account

        2. **Use the Token:**
           Include the service account token in the Authorization header of API requests:
           `Authorization: Bearer <your-service-account-token>`

        3. **Best Practices:**
           - Create separate service accounts for different environments (dev, staging, prod)
           - Store tokens securely as secrets in consuming applications or workflows
           - Set appropriate expiry dates and rotate tokens regularly
           - Never commit tokens to source control

        For CI/CD integration examples, see the [CI/CD
        documentation](https://docs.cerebrium.ai/cerebrium/deployments/ci-cd).

````