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

# A linha do tempo contínua, como HLS

> A linha do tempo contínua desta câmera, como playlist HLS — o "volta para as
3h12".

Passe a janela em `start` e `end` (ISO 8601, com fuso) e receba um `.m3u8`
pronto para tocar. Vale para câmera que grava sem parar; sem vídeo guardado na
janela pedida, `404`.

**Não confunda com `/api/recording-segments`.** Aqui é a linha contínua; lá é o
que um alarme mandou guardar. São dois acervos diferentes, e uma câmera pode
estar em um e não no outro — a mesma pergunta ("o que aconteceu às 3h12") pode
ter resposta em um e não em outro.

Aceita o identificador do equipamento ou o identificador único.



## OpenAPI

````yaml /api-reference/openapi.json get /api/playback/{video_id}
openapi: 3.1.0
info:
  description: >

    API de leitura do Pictor Cloud para integração de parceiro.


    ## Autenticação


    Toda chamada leva a chave no cabeçalho `Authorization`:


    ```

    Authorization: Bearer pct_1a2b3c4d_<segredo>

    ```


    A chave é emitida por um **administrador da conta** no console (Integrações
    →

    Chaves de API) e **aparece uma única vez**, no momento da criação. O
    servidor

    guarda apenas o resumo criptográfico dela: não existe "mostrar de novo". Se

    perder, emita outra e revogue a antiga.


    ## O que a chave enxerga


    A chave carrega o mesmo par permissão/alcance de um usuário:


    | Campo | Valores | Efeito |

    |---|---|---|

    | `role` | `viewer`, `operator`, `admin` | `viewer` basta para tudo que está
    documentado aqui |

    | `scope` | `tenant`, `client`, `video_wall` | recorta o que a chave vê
    dentro da conta |


    Uma chave com `scope=client` só devolve as câmeras (e os eventos, e o

    diagnóstico) daquele cliente. Uma chave nunca atravessa a fronteira da conta
    que

    a emitiu: não existe chave que enxergue duas contas.


    ## Validade


    Toda chave tem prazo — "nunca expira" não é um estado que exista. Quando ela

    vence, as chamadas passam a responder `401`; a cura é emitir outra no
    console.


    ## Cabeçalhos que não se aplicam


    - `X-Tenant-ID`: opcional. Se vier, precisa ser a conta da própria chave;
      divergente responde `403`. A chave decide a conta, o cabeçalho nunca a troca.
    - `X-Membership-ID`: responde `403`. Uma chave não troca de workspace.


    ## Limites


    Há um teto de requisições por chave por minuto. Ao estourar, a resposta é
    `429`

    com `Retry-After`. A emissão de URL de mídia tem teto próprio, bem menor:
    cada

    sessão de vídeo custa CPU no servidor de mídia.


    ## Erros


    | Código | Significado |

    |---|---|

    | `401` | chave ausente, malformada, revogada ou expirada (o motivo não é
    detalhado, de propósito) |

    | `403` | chave válida, sem permissão para o recurso — ou cabeçalho que
    contradiz a chave |

    | `404` | o recurso não existe **ou** não é desta chave (não distinguimos:
    dizer qual seria contar o que existe) |

    | `429` | teto de requisições estourado |
  title: Pictor Cloud — API de parceiro
  version: 1.0.0
servers:
  - description: Pictor Cloud
    url: https://api.pictor.cloud
security: []
paths:
  /api/playback/{video_id}:
    get:
      tags:
        - Playback
      summary: A linha do tempo contínua, como HLS
      description: >-
        A linha do tempo contínua desta câmera, como playlist HLS — o "volta
        para as

        3h12".


        Passe a janela em `start` e `end` (ISO 8601, com fuso) e receba um
        `.m3u8`

        pronto para tocar. Vale para câmera que grava sem parar; sem vídeo
        guardado na

        janela pedida, `404`.


        **Não confunda com `/api/recording-segments`.** Aqui é a linha contínua;
        lá é o

        que um alarme mandou guardar. São dois acervos diferentes, e uma câmera
        pode

        estar em um e não no outro — a mesma pergunta ("o que aconteceu às
        3h12") pode

        ter resposta em um e não em outro.


        Aceita o identificador do equipamento ou o identificador único.
      operationId: stream_playback_api_playback__video_id__get
      parameters:
        - in: path
          name: video_id
          required: true
          schema:
            title: Video Id
            type: string
        - description: Início da janela (ISO 8601, com fuso).
          in: query
          name: start
          required: true
          schema:
            description: Início da janela (ISO 8601, com fuso).
            format: date-time
            title: Start
            type: string
        - description: Fim da janela (ISO 8601, com fuso).
          in: query
          name: end
          required: true
          schema:
            description: Fim da janela (ISO 8601, com fuso).
            format: date-time
            title: End
            type: string
        - in: header
          name: X-Membership-ID
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: X-Membership-Id
        - in: header
          name: X-Tenant-ID
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: X-Tenant-Id
      responses:
        '200':
          content:
            application/json:
              schema: {}
          description: Successful Response
        '401':
          description: Chave ausente, invalida, revogada ou expirada.
        '403':
          description: Chave valida, sem permissao para o recurso.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
        '429':
          description: Teto de requisicoes desta chave excedido.
      security:
        - HTTPBearer: []
components:
  schemas:
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          title: Detail
          type: array
      title: HTTPValidationError
      type: object
    ValidationError:
      properties:
        ctx:
          title: Context
          type: object
        input:
          title: Input
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          title: Location
          type: array
        msg:
          title: Message
          type: string
        type:
          title: Error Type
          type: string
      required:
        - loc
        - msg
        - type
      title: ValidationError
      type: object
  securitySchemes:
    HTTPBearer:
      description: Chave de API da conta, no formato `pct_<prefixo>_<segredo>`.
      scheme: bearer
      type: http

````