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

# Create Pod



## OpenAPI

````yaml https://api.primeintellect.ai/openapi.json post /api/v1/pods/
openapi: 3.1.0
info:
  title: PI API
  version: 0.1.0
servers:
  - url: https://api.primeintellect.ai
security: []
paths:
  /api/v1/pods/:
    post:
      tags:
        - Pods
      summary: Create Pod
      operationId: create_pod_api_v1_pods__post
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Body_create_pod_api_v1_pods__post'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIPodConfig'
        '401':
          description: Authorization failed
        '422':
          description: Invalid request data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - HTTPBearer: []
components:
  schemas:
    Body_create_pod_api_v1_pods__post:
      properties:
        pod:
          $ref: '#/components/schemas/PodRequestConfig'
        provider:
          $ref: '#/components/schemas/ProviderConfig'
        disks:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Disks
        team:
          anyOf:
            - $ref: '#/components/schemas/TeamConfig'
            - type: 'null'
        team_member_ids:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Team Member Ids
        shared_with_team:
          type: boolean
          title: Shared With Team
          default: false
      type: object
      required:
        - pod
        - provider
      title: Body_create_pod_api_v1_pods__post
    APIPodConfig:
      properties:
        id:
          type: string
          title: Id
          description: Unique identifier for the pod, generated as a UUID.
        userId:
          type: string
          title: Userid
          description: ID of the user associated with this pod, if applicable.
        teamId:
          anyOf:
            - type: string
            - type: 'null'
          title: Teamid
          description: ID of the team owning this pod, if applicable.
        walletId:
          anyOf:
            - type: string
            - type: 'null'
          title: Walletid
          description: >-
            ID of the wallet associated with this pod for billing or resource
            tracking.
        name:
          type: string
          title: Name
          description: Name of the pod.
        type:
          $ref: '#/components/schemas/PodTypeEnum'
          description: Type of the pod, based on PodTypeEnum.
          default: HOSTED
          deprecated: true
        providerType:
          $ref: '#/components/schemas/ProviderTypeEnum'
          description: Type of provider associated with the pod, based on ProviderTypeEnum.
        status:
          $ref: '#/components/schemas/PodStatusEnum'
          description: Current status of the pod, based on PodStatusEnum.
          default: PROVISIONING
        installationStatus:
          $ref: '#/components/schemas/InstallationStatusEnum'
          description: Installation status of the pod, based on InstallationStatusEnum.
          default: PENDING
        installationFailure:
          anyOf:
            - type: string
            - type: 'null'
          title: Installationfailure
          description: >-
            Details about any installation failures that occurred, if
            applicable.
        installationProgress:
          anyOf:
            - type: integer
            - type: 'null'
          title: Installationprogress
          description: Percentage of the installation process completed.
        createdAt:
          type: string
          format: date-time
          title: Createdat
          description: Timestamp when the pod was created.
        updatedAt:
          type: string
          format: date-time
          title: Updatedat
          description: Timestamp when the pod was last updated.
        terminatedAt:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Terminatedat
          description: Timestamp when the pod was terminated.
        gpuName:
          $ref: '#/components/schemas/GPUType'
          description: Model of the GPU allocated.
        gpuCount:
          type: integer
          title: Gpucount
          description: Number of GPUs allocated to the node.
          examples:
            - 1
        socket:
          $ref: '#/components/schemas/GPUSocket'
          description: Type of socket used by the GPU.
        priceHr:
          type: number
          title: Pricehr
          description: Hourly price for running the pod.
          examples:
            - 1.23
        stoppedPriceHr:
          anyOf:
            - type: number
            - type: 'null'
          title: Stoppedpricehr
          description: >-
            Hourly price when the pod is stopped. If empty then `priceHr` is
            used.
          examples:
            - 0.005
        provisioningPriceHr:
          anyOf:
            - type: number
            - type: 'null'
          title: Provisioningpricehr
          description: >-
            Hourly price during the provisioning process. If empty then
            `priceHr` is used.
          default: 0
        environmentType:
          $ref: '#/components/schemas/EnvironmentTypeEnum'
          description: Type of image selected for the pod.
          default: ubuntu_22_cuda_12
        customTemplateId:
          anyOf:
            - type: string
            - type: 'null'
          title: Customtemplateid
          description: ID of the custom template applied to the pod, if applicable.
        clusterId:
          anyOf:
            - type: string
            - type: 'null'
          title: Clusterid
          description: ID of the cluster to which the pod belongs.
        primePortMapping:
          anyOf:
            - items:
                $ref: '#/components/schemas/PortMapping'
              type: array
            - type: 'null'
          title: Primeportmapping
          description: Port mapping.
          default: []
        sshConnection:
          anyOf:
            - type: string
            - items:
                anyOf:
                  - type: string
                  - type: 'null'
              type: array
            - type: 'null'
          title: Sshconnection
          description: SSH connection/connections details.
        ip:
          anyOf:
            - type: string
            - items:
                anyOf:
                  - type: string
                  - type: 'null'
              type: array
            - type: 'null'
          title: Ip
          description: IP address/addresses of the instance.
        resources:
          anyOf:
            - $ref: '#/components/schemas/InstanceResources'
            - type: 'null'
          description: Instance resources.
        attachedResources:
          anyOf:
            - items:
                $ref: '#/components/schemas/AttachedResources'
              type: array
            - type: 'null'
          title: Attachedresources
          description: Instance attached resources.
          default: []
        isSpot:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Isspot
          description: Whether the instance is spot.
        autoRestart:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Autorestart
          description: Automatically restart the instance.
      type: object
      required:
        - userId
        - name
        - providerType
        - gpuName
        - gpuCount
        - socket
        - priceHr
      title: APIPodConfig
    ErrorResponse:
      properties:
        errors:
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type: array
          title: Errors
      type: object
      required:
        - errors
      title: ErrorResponse
    PodRequestConfig:
      properties:
        name:
          type: string
          title: Name
        cloudId:
          type: string
          title: Cloudid
        gpuType:
          $ref: '#/components/schemas/GPUType'
          description: Model of the GPU allocated.
        socket:
          $ref: '#/components/schemas/GPUSocket'
          description: Type of socket used by the GPU.
        gpuCount:
          type: integer
          exclusiveMinimum: 0
          title: Gpucount
        diskSize:
          anyOf:
            - type: integer
              exclusiveMinimum: 0
            - type: 'null'
          title: Disksize
        vcpus:
          anyOf:
            - type: integer
              exclusiveMinimum: 0
            - type: 'null'
          title: Vcpus
        memory:
          anyOf:
            - type: integer
              exclusiveMinimum: 0
            - type: 'null'
          title: Memory
        maxPrice:
          anyOf:
            - type: number
            - type: 'null'
          title: Maxprice
        image:
          $ref: '#/components/schemas/EnvironmentTypeEnum'
          default: ubuntu_22_cuda_12
        customTemplateId:
          anyOf:
            - type: string
            - type: 'null'
          title: Customtemplateid
        dataCenterId:
          anyOf:
            - type: string
            - type: 'null'
          title: Datacenterid
        country:
          anyOf:
            - type: string
            - type: 'null'
          title: Country
        security:
          anyOf:
            - $ref: '#/components/schemas/SecurityType'
            - type: 'null'
        envVars:
          anyOf:
            - items:
                $ref: '#/components/schemas/EnvVar'
              type: array
            - type: 'null'
          title: Envvars
        jupyterPassword:
          anyOf:
            - type: string
            - type: 'null'
          title: Jupyterpassword
        sshKeyId:
          anyOf:
            - type: string
            - type: 'null'
          title: Sshkeyid
        autoRestart:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Autorestart
          default: false
        prepaidForHr:
          anyOf:
            - type: number
              exclusiveMinimum: 0
            - type: 'null'
          title: Prepaidforhr
          description: Number of hours to prepay for (used for reserved instances)
      additionalProperties: false
      type: object
      required:
        - cloudId
        - gpuType
        - socket
        - gpuCount
      title: PodRequestConfig
    ProviderConfig:
      properties:
        type:
          $ref: '#/components/schemas/ProviderTypeEnum'
      type: object
      required:
        - type
      title: ProviderConfig
    TeamConfig:
      properties:
        teamId:
          type: string
          title: Teamid
      type: object
      required:
        - teamId
      title: TeamConfig
    PodTypeEnum:
      type: string
      enum:
        - HOSTED
        - EXTERNAL
      title: PodTypeEnum
    ProviderTypeEnum:
      type: string
      enum:
        - runpod
        - fluidstack
        - lambdalabs
        - hyperstack
        - oblivus
        - cudocompute
        - scaleway
        - tensordock
        - datacrunch
        - latitude
        - crusoecloud
        - massedcompute
        - akash
        - primeintellect
        - primecompute
        - dc_impala
        - dc_kudu
        - dc_roan
        - nebius
        - dc_eland
        - dc_wildebeest
        - vultr
        - dc_gnu
        - denvr
      title: ProviderTypeEnum
    PodStatusEnum:
      type: string
      enum:
        - PROVISIONING
        - PENDING
        - ACTIVE
        - STOPPED
        - ERROR
        - DELETING
        - UNKNOWN
        - TERMINATED
      title: PodStatusEnum
    InstallationStatusEnum:
      type: string
      enum:
        - PENDING
        - ACTIVE
        - FINISHED
        - ERROR
        - TERMINATED
      title: InstallationStatusEnum
    GPUType:
      type: string
      enum:
        - CPU_NODE
        - A10_24GB
        - A100_80GB
        - A100_40GB
        - A30_24GB
        - A40_48GB
        - B200_180GB
        - B300_262GB
        - GB200
        - GB300
        - RTX3070_8GB
        - RTX3070_8GB
        - RTX3080_10GB
        - RTX3080Ti_12GB
        - RTX3090_24GB
        - RTX3090Ti_24GB
        - RTX4070Ti_12GB
        - RTX4080_16GB
        - RTX4080Ti_16GB
        - RTX4090_24GB
        - RTX5090_32GB
        - H100_80GB
        - H200_96GB
        - GH200_96GB
        - H200_141GB
        - GH200_480GB
        - GH200_624GB
        - L4_24GB
        - L40_48GB
        - L40S_48GB
        - RTX4000_8GB
        - RTX5000_16GB
        - RTX6000_24GB
        - RTX8000_48GB
        - RTX2000Ada_16GB
        - RTX4000Ada_20GB
        - RTX5000Ada_32GB
        - RTX6000Ada_48GB
        - A2000_6GB
        - A4000_16GB
        - A4500_20GB
        - A5000_24GB
        - A6000_48GB
        - V100_16GB
        - V100_32GB
        - P100_16GB
        - T4_16GB
        - P4_8GB
        - P40_24GB
        - RTX_PRO_6000B_96GB
      title: GPUType
    GPUSocket:
      type: string
      enum:
        - PCIe
        - SXM2
        - SXM3
        - SXM4
        - SXM5
        - SXM6
      title: GPUSocket
    EnvironmentTypeEnum:
      type: string
      enum:
        - ubuntu_22_cuda_12
        - cuda_12_1_pytorch_2_2
        - cuda_11_8_pytorch_2_1
        - cuda_12_1_pytorch_2_3
        - cuda_12_1_pytorch_2_4
        - cuda_12_4_pytorch_2_4
        - cuda_12_4_pytorch_2_5
        - cuda_12_4_pytorch_2_6
        - cuda_12_6_pytorch_2_7
        - stable_diffusion
        - axolotl
        - bittensor
        - hivemind
        - petals_llama
        - vllm_llama_8b
        - vllm_llama_70b
        - vllm_llama_405b
        - custom_template
        - flux
        - prime_rl
      title: EnvironmentTypeEnum
    PortMapping:
      properties:
        internal:
          type: string
          title: Internal
          examples:
            - '8080'
        external:
          type: string
          title: External
          examples:
            - '1234'
        protocol:
          $ref: '#/components/schemas/ProtocolEnum'
        usedBy:
          anyOf:
            - $ref: '#/components/schemas/UsedByEnum'
            - type: 'null'
        description:
          anyOf:
            - type: string
            - type: 'null'
          title: Description
      type: object
      required:
        - internal
        - external
        - protocol
      title: PortMapping
    InstanceResources:
      properties:
        memory:
          anyOf:
            - type: integer
            - type: 'null'
          title: Memory
          description: RAM available (in GB)
          examples:
            - '128'
        disk:
          anyOf:
            - type: integer
            - type: 'null'
          title: Disk
          description: Total disk space (in GB)
          examples:
            - '1000'
        shared_disk:
          anyOf:
            - type: integer
            - type: 'null'
          title: Shared Disk
          description: Total external shared disk space (in GB)
          examples:
            - '1000'
        vcpus:
          anyOf:
            - type: integer
            - type: 'null'
          title: Vcpus
          description: vCPUs available
          examples:
            - '32'
      type: object
      title: InstanceResources
    AttachedResources:
      properties:
        resourceType:
          $ref: '#/components/schemas/AttachableResourceType'
          description: Type of resource.
          examples:
            - DISK
        id:
          anyOf:
            - type: string
            - type: integer
          title: Id
          description: Unique identifier for the resource.
        status:
          $ref: '#/components/schemas/AttachableResourceStatus'
          description: Resource status.
          default: UNATTACHED
        isDetachable:
          type: boolean
          title: Isdetachable
          description: Whether the resource is detachable.
          default: true
        mountPath:
          type: string
          title: Mountpath
          description: Path to the mount point.
          default: /workspace
        resourcePath:
          anyOf:
            - type: string
            - type: 'null'
          title: Resourcepath
          description: Path to the resource.
        size:
          anyOf:
            - type: string
            - type: integer
            - type: 'null'
          title: Size
          description: Size of the resource.
        isShared:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Isshared
          description: Whether the resource is shared.
          default: false
      type: object
      required:
        - resourceType
        - id
      title: AttachedResources
    ErrorDetail:
      properties:
        param:
          type: string
          title: Param
        details:
          type: string
          title: Details
      type: object
      required:
        - param
        - details
      title: ErrorDetail
    SecurityType:
      type: string
      enum:
        - secure_cloud
        - community_cloud
      title: SecurityType
    EnvVar:
      properties:
        key:
          type: string
          title: Key
          description: Environment variable key
        value:
          type: string
          title: Value
          description: Environment variable value
      type: object
      required:
        - key
        - value
      title: EnvVar
    ProtocolEnum:
      type: string
      enum:
        - TCP
        - UDP
      title: ProtocolEnum
    UsedByEnum:
      type: string
      enum:
        - SSH
        - JUPYTER_NOTEBOOK
        - WEB_SERVER
      title: UsedByEnum
    AttachableResourceType:
      type: string
      enum:
        - DISK
      const: DISK
      title: AttachableResourceType
    AttachableResourceStatus:
      type: string
      enum:
        - UNATTACHED
        - ATTACHED
        - MOUNTED
      title: AttachableResourceStatus
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer

````