> ## 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.

# Uma varredura, câmera por câmera

> Uma varredura, câmera por câmera: o veredito de cada uma e a melhor imagem que a
passagem capturou.

`best_frame.snapshot_url` é um endereço assinado e temporário. Vale o de sempre:
quem arquiva, arquiva os bytes.



## OpenAPI

````yaml /api-reference/openapi.json get /api/patrols/runs/{run_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/patrols/runs/{run_id}:
    get:
      tags:
        - patrols
      summary: Uma varredura, câmera por câmera
      description: >-
        Uma varredura, câmera por câmera: o veredito de cada uma e a melhor
        imagem que a

        passagem capturou.


        `best_frame.snapshot_url` é um endereço assinado e temporário. Vale o de
        sempre:

        quem arquiva, arquiva os bytes.
      operationId: get_patrol_run_api_patrols_runs__run_id__get
      parameters:
        - in: path
          name: run_id
          required: true
          schema:
            format: uuid
            title: Run Id
            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:
                $ref: '#/components/schemas/PatrolRunOut'
          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:
    PatrolRunOut:
      properties:
        alarm_id:
          anyOf:
            - format: uuid
              type: string
            - type: 'null'
          title: Alarm Id
        cameras_offline:
          title: Cameras Offline
          type: integer
        cameras_person:
          title: Cameras Person
          type: integer
        cameras_probed:
          title: Cameras Probed
          type: integer
        cameras_total:
          title: Cameras Total
          type: integer
        cameras_vehicle:
          title: Cameras Vehicle
          type: integer
        finished_at:
          anyOf:
            - format: date-time
              type: string
            - type: 'null'
          title: Finished At
        run_id:
          format: uuid
          title: Run Id
          type: string
        started_at:
          format: date-time
          title: Started At
          type: string
        status:
          title: Status
          type: string
        summary:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Summary
        tenant_id:
          format: uuid
          title: Tenant Id
          type: string
        trigger:
          title: Trigger
          type: string
      required:
        - run_id
        - tenant_id
        - started_at
        - status
        - trigger
        - cameras_total
        - cameras_probed
        - cameras_offline
        - cameras_person
        - cameras_vehicle
      title: PatrolRunOut
      type: object
    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

````