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

# Status da API

> Endpoint público — não requer autenticação.



## OpenAPI

````yaml /openapi.yaml get /health
openapi: 3.1.0
info:
  title: Shappire Media API
  version: 1.0.0
  description: >
    API pública para resolver metadados de mídia e enfileirar downloads
    assíncronos.


    - Base URL produção: `https://api.shappire.tools/v1`

    - Autenticação: `X-API-Key` (recomendado) ou `Authorization: Bearer`

    - Envelope de sucesso: `{ "data": ... }`

    - Envelope de erro: `{ "error": { "code", "message", "request_id" } }`

    - YouTube não é suportado (bloqueio de IP de servidor)
servers:
  - url: https://api.shappire.tools/v1
    description: Production
  - url: http://localhost:8080/v1
    description: Local development
security:
  - ApiKeyAuth: []
  - BearerAuth: []
tags:
  - name: Health
    description: Status da API
  - name: Platforms
    description: Plataformas suportadas
  - name: Media
    description: Resolução e download de mídia
  - name: Jobs
    description: Consulta de jobs assíncronos
paths:
  /health:
    get:
      tags:
        - Health
      summary: Status da API
      description: Endpoint público — não requer autenticação.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthResponse'
      security: []
components:
  schemas:
    HealthResponse:
      type: object
      properties:
        data:
          type: object
          properties:
            status:
              type: string
              example: ok
            version:
              type: string
              example: v1
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: >-
        Chave de API no formato shp_live_... (produção) ou shp_test_...
        (desenvolvimento)
    BearerAuth:
      type: http
      scheme: bearer
      description: Alternativa compatível — envie a chave como Bearer token

````