> ## Documentation Index
> Fetch the complete documentation index at: https://docs.tembo.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Retrieve a project

> Retrieve project configuration. Use the project subresources to list snapshots, builds, schedules, and environment variables.



## OpenAPI

````yaml https://api.tembo.io/public-api/openapi/public get /v1/projects/{projectId}
openapi: 3.1.0
info:
  title: Tembo Public API
  description: >-
    Manage agents, sessions, repositories, and organization resources with the
    Tembo API.
  version: 1.0.0
servers:
  - url: https://api.tembo.io
    description: Tembo API
  - url: https://{deployment-origin}/api/public-api
    description: Self-hosted Tembo
    variables:
      deployment-origin:
        default: tembo.example.com
        description: Hostname of your self-hosted Tembo deployment
security: []
paths:
  /v1/projects/{projectId}:
    get:
      tags:
        - Projects
      summary: Retrieve a project
      description: >-
        Retrieve project configuration. Use the project subresources to list
        snapshots, builds, schedules, and environment variables.
      operationId: retrieveProject
      parameters:
        - in: path
          name: projectId
          schema:
            type: string
            minLength: 1
            maxLength: 255
          required: true
      responses:
        '200':
          description: Retrieve a project
          content:
            application/json:
              schema:
                type: object
                properties:
                  createdAt:
                    type: string
                    format: date-time
                    pattern: >-
                      ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
                  description:
                    type:
                      - string
                      - 'null'
                  id:
                    type: string
                    minLength: 1
                    maxLength: 255
                  name:
                    type: string
                  setupScript:
                    type:
                      - string
                      - 'null'
                  updatedAt:
                    type: string
                    format: date-time
                    pattern: >-
                      ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
                  activeSnapshots:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          minLength: 1
                          maxLength: 255
                        size:
                          type: string
                          enum:
                            - nano
                            - micro
                            - small
                            - medium
                            - large
                            - xl
                            - xxl
                            - ultra
                        builtAt:
                          type: string
                          format: date-time
                          pattern: >-
                            ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
                      required:
                        - id
                        - size
                        - builtAt
                      additionalProperties: false
                  resourceSettings:
                    anyOf:
                      - oneOf:
                          - type: object
                            properties:
                              automaticSizing:
                                type: boolean
                                const: true
                              allocation:
                                type: object
                                properties:
                                  cpuMin:
                                    type: integer
                                    exclusiveMinimum: 0
                                    maximum: 9007199254740991
                                  cpuMax:
                                    type: integer
                                    exclusiveMinimum: 0
                                    maximum: 9007199254740991
                                  memoryMinMb:
                                    type: integer
                                    exclusiveMinimum: 0
                                    maximum: 9007199254740991
                                    multipleOf: 1024
                                  memoryMaxMb:
                                    type: integer
                                    exclusiveMinimum: 0
                                    maximum: 9007199254740991
                                    multipleOf: 1024
                                  diskSizeGb:
                                    type: integer
                                    exclusiveMinimum: 0
                                    maximum: 9007199254740991
                                required:
                                  - memoryMinMb
                                  - memoryMaxMb
                                  - diskSizeGb
                                additionalProperties: false
                            required:
                              - automaticSizing
                            additionalProperties: false
                          - type: object
                            properties:
                              automaticSizing:
                                type: boolean
                                const: false
                              allocation:
                                type: object
                                properties:
                                  cpuMin:
                                    type: integer
                                    exclusiveMinimum: 0
                                    maximum: 9007199254740991
                                  cpuMax:
                                    type: integer
                                    exclusiveMinimum: 0
                                    maximum: 9007199254740991
                                  memoryMinMb:
                                    type: integer
                                    exclusiveMinimum: 0
                                    maximum: 9007199254740991
                                    multipleOf: 1024
                                  memoryMaxMb:
                                    type: integer
                                    exclusiveMinimum: 0
                                    maximum: 9007199254740991
                                    multipleOf: 1024
                                  diskSizeGb:
                                    type: integer
                                    exclusiveMinimum: 0
                                    maximum: 9007199254740991
                                required:
                                  - memoryMinMb
                                  - memoryMaxMb
                                  - diskSizeGb
                                additionalProperties: false
                            required:
                              - automaticSizing
                            additionalProperties: false
                      - type: 'null'
                  agentInstructions:
                    anyOf:
                      - type: string
                        maxLength: 20000
                      - type: 'null'
                  codeRepositoryIds:
                    anyOf:
                      - type: array
                        items:
                          type: string
                          minLength: 1
                          maxLength: 255
                      - type: 'null'
                  color:
                    type: string
                    enum:
                      - neutral
                      - red
                      - orange
                      - yellow
                      - green
                      - teal
                      - blue
                      - purple
                      - pink
                  defaultForSizes:
                    type: array
                    items:
                      type: string
                      enum:
                        - nano
                        - micro
                        - small
                        - medium
                        - large
                        - xl
                        - xxl
                        - ultra
                  icon:
                    type: string
                    enum:
                      - folder
                      - code
                      - terminal
                      - book
                      - brain
                      - bug
                      - building
                      - cloud
                      - globe
                      - idea
                      - tools
                      - magic
                      - processor
                      - sandbox
                      - server
                      - tasks
                      - tactics
                      - images
                      - database
                      - api
                      - mobile
                      - package
                  onboardingDefault:
                    type: boolean
                    description: >-
                      True for the project created during onboarding until it is
                      first edited
                  sizes:
                    type: array
                    items:
                      type: string
                      enum:
                        - nano
                        - micro
                        - medium
                        - large
                        - xl
                        - xxl
                        - ultra
                  warmPoolEnabled:
                    type: boolean
                  warmPoolSchedule:
                    anyOf:
                      - type: object
                        properties:
                          timezone:
                            type: string
                            minLength: 1
                            maxLength: 100
                          days:
                            minItems: 1
                            maxItems: 7
                            type: array
                            items:
                              type: integer
                              minimum: 0
                              maximum: 6
                          startTime:
                            type: string
                            pattern: ^([01]\d|2[0-3]):[0-5]\d$
                          endTime:
                            type: string
                            pattern: ^(?:([01]\d|2[0-3]):[0-5]\d|24:00)$
                        required:
                          - timezone
                          - days
                          - startTime
                          - endTime
                        additionalProperties: false
                      - type: 'null'
                required:
                  - createdAt
                  - description
                  - id
                  - name
                  - setupScript
                  - updatedAt
                  - activeSnapshots
                  - resourceSettings
                  - agentInstructions
                  - codeRepositoryIds
                  - color
                  - defaultForSizes
                  - icon
                  - onboardingDefault
                  - sizes
                  - warmPoolEnabled
                  - warmPoolSchedule
                additionalProperties: false
        '400':
          description: >-
            Invalid request or missing required organization or user
            information.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
                additionalProperties: false
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
                additionalProperties: false
        '404':
          description: Project resource not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
                additionalProperties: false
        '409':
          description: Project resource conflict
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
                additionalProperties: false
        '500':
          description: Project operation failed
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
                additionalProperties: false
      security:
        - apiKey: []
      x-codeSamples:
        - lang: typescript
          label: TypeScript SDK
          source: |
            import Tembo from '@tembo-io/sdk';

            const client = new Tembo();

            const project = await client.projects.retrieve('projectId');
        - lang: rust
          label: Rust SDK
          source: |
            use tembo_rs::*;

            let client = Tembo::from_env()?;

            let response = client.projects().retrieve("example").send().await?;
components:
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.