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

# Get Endpoint



## OpenAPI

````yaml api-reference/gpus-v2-spec/get-endpoint.json GET /gpus/v2/endpoints/{endpoint_id}
openapi: 3.0.0
info:
  title: Novita GPU API v2
  version: 2.0.0
servers:
  - url: https://api.novita.ai
security: []
paths:
  /gpus/v2/endpoints/{endpoint_id}:
    get:
      summary: Get Endpoint
      parameters:
        - name: Authorization
          in: header
          required: true
          schema:
            type: string
          description: 'Bearer authentication format, e.g.: `Bearer {{API_KEY}}`.'
        - name: endpoint_id
          in: path
          required: true
          schema:
            type: string
          description: 'Endpoint ID. String, length: 1-255 characters.'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    description: Endpoint ID
                    example: endpoint-id
                  type:
                    type: string
                    enum:
                      - sync
                      - async
                    description: 'Endpoint type. Allowed values: `sync`, `async`'
                  name:
                    type: string
                    description: Endpoint name
                    example: example-endpoint
                  app_name:
                    type: string
                    description: Application name
                    example: example-app
                  status:
                    type: object
                    description: Endpoint status
                    properties:
                      status:
                        type: string
                        description: Status value
                        example: running
                      error:
                        type: string
                        description: Error code or error type
                        example: ''
                      message:
                        type: string
                        description: Status note or error message
                        example: ''
                  url:
                    type: string
                    description: Access URL
                    example: https://endpoint.example.com/endpoint-id
                  product_id:
                    type: string
                    description: Serverless product ID
                  worker_config:
                    type: object
                    description: Worker configuration
                    example:
                      min_replicas: 0
                      max_replicas: 2
                      idle_timeout: 300
                      max_concurrent_per_worker: 10
                      gpu_num: 1
                      rootfs_size_gb: 20
                      min_cuda_version: '12.4'
                      request_timeout: 60
                  policy:
                    type: object
                    description: Policy configuration
                    example:
                      type: queue
                      value: 100
                  image:
                    type: string
                    description: Image address
                    example: registry.example.com/namespace/image:tag
                  registry_auth_id:
                    type: string
                    description: Registry authentication ID
                    example: registry-auth-id
                  entrypoint:
                    type: string
                    description: Container entrypoint
                    example: ''
                  command:
                    type: string
                    description: Startup command
                    example: cargo run
                  volumes:
                    type: array
                    description: Mount list
                    items:
                      type: object
                    example:
                      - id: storage-id
                        type: network
                        mount_point: /data
                  envs:
                    type: array
                    description: Environment variable list
                    items:
                      type: object
                    example:
                      - key: ENV_NAME
                        value: ENV_VALUE
                  ports:
                    type: array
                    items:
                      type: integer
                    description: Port list
                    example:
                      - 8080
                  workers:
                    type: array
                    description: Worker list
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          description: Worker ID
                          example: worker-id
                        status:
                          type: object
                          description: Worker status
                          properties:
                            status:
                              type: string
                              description: Status value
                              example: ready
                            error:
                              type: string
                              description: Error code or error type
                              example: ''
                            message:
                              type: string
                              description: Status note or error message
                              example: ''
                        log:
                          type: string
                          description: Worker log endpoint
                          example: https://logs.example.com/worker-id
                        health:
                          type: boolean
                          description: Whether the worker is healthy
                          example: true
                        drain:
                          type: boolean
                          description: Whether the worker stopped accepting requests
                          example: false
                  health_check:
                    type: object
                    description: Health check configuration
                    example:
                      path: /healthz
                      port: 8080
                  region_id:
                    type: string
                    description: Region ID
                    example: region-id
                  member_id:
                    type: string
                    description: Member ID
                    example: member-id
                  owner_id:
                    type: string
                    description: Owner ID
                    example: 550e8400-e29b-41d4-a716-446655440000
                  created_at:
                    type: integer
                    description: Creation time. Unix timestamp
                    example: 1710000000

````