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

# Platform status roll-up

> Public status of the Protoface platform. Polled by the status page and operator dashboards. Unauthenticated.



## OpenAPI

````yaml /openapi.json get /v1/status
openapi: 3.1.0
info:
  description: >
    Create realtime avatar sessions.


    ### Authentication

    All `/v1/*` endpoints require a live API key:


    ```

    Authorization: Bearer sk_live_...

    ```


    Keys are minted in the dashboard and are scoped to a single environment

    (staging or prod).


    ### Idempotency

    `POST /v1/sessions` may include an `Idempotency-Key` header (any opaque
    string,

    <= 255 chars). Retries with the same key inside 24 hours return the first

    response. The header is optional.


    ### Errors

    Every non-2xx response is a JSON body of the form:


    ```json

    {
      "error": {
        "type": "invalid_request",
        "code": "transport.unsupported",
        "message": "transport.type=pipecat is not supported",
        "param": "transport.type",
        "request_id": "req_01HXY..."
      }
    }

    ```


    Switch on `error.code` (stable lower_snake_case), not `error.message`.


    ### Pagination

    List endpoints use cursor pagination:


    ```

    GET /v1/sessions?limit=20&starting_after=sess_01HXY...

    ```


    Response shape:


    ```json

    {
      "object": "list",
      "data": [...],
      "has_more": true,
      "next_cursor": "sess_01HXY..."
    }

    ```
  summary: Protoface — realtime avatar API for developers.
  title: Protoface API
  version: 0.1.0
servers: []
security: []
tags:
  - description: >-
      Create, retrieve, list, and end realtime avatar sessions. Sessions stream
      audio in and video out; their lifecycle drives billing.
    name: sessions
  - description: >-
      Avatar definitions. Includes platform stock avatars and customer-uploaded
      avatars.
    name: avatars
  - description: Blocking talking-avatar video generation from uploaded audio.
    name: videos
  - description: Aggregate usage for billing reconciliation.
    name: usage
  - description: >-
      Public platform metadata — currently just status. Unauthenticated.
      Internal load-balancer and task health probes exist on this host but are
      not part of the documented surface.
    name: platform
  - description: Direct media sessions for the `pipecat-protoface` avatar video service.
    name: pipecat
  - description: Public billing plan metadata for signup and pricing UI.
    name: billing
paths:
  /v1/status:
    get:
      tags:
        - platform
      summary: Platform status roll-up
      description: >-
        Public status of the Protoface platform. Polled by the status page and
        operator dashboards. Unauthenticated.
      operationId: get_status
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StatusResponse'
          description: Successful Response
components:
  schemas:
    StatusResponse:
      additionalProperties: false
      description: '`GET /v1/status` response.'
      properties:
        components:
          items:
            $ref: '#/components/schemas/StatusComponent'
          type: array
        status:
          description: Roll-up of all components.
          enum:
            - operational
            - degraded
            - outage
          type: string
        updated_at:
          format: date-time
          type: string
      required:
        - status
        - components
        - updated_at
      title: StatusResponse
      type: object
    StatusComponent:
      additionalProperties: false
      properties:
        name:
          type: string
        status:
          enum:
            - operational
            - degraded
            - outage
          type: string
      required:
        - name
        - status
      title: StatusComponent
      type: object

````