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

# Listar mídias do Instagram

> Liste os posts ou os stories de uma conta do Instagram para que o gatilho de uma automação possa referenciar uma publicação específica pelo ID da mídia.

Use este endpoint para descobrir os posts ou os stories de uma conta do
Instagram. Informe o UUID da conta no caminho e `surface` na query string. Sua
chave de API precisa do escopo `automations:read` e de acesso a essa conta.

`surface` é obrigatório e aceita `posts` ou `stories`. Cada item traz `id`,
`surface`, `media_type`, `caption`, `thumbnail_url`, `instagram_url`,
`published_at`, `like_count` e `comments_count`. Todos os campos, exceto `id` e
`surface`, podem vir como `null` quando o Instagram não devolve um valor.

## Referencie uma publicação em um gatilho

Um gatilho de comentário pode ser vinculado a um post. Use um `id` retornado
como valor da referência:

```json theme={null}
{
  "publication": {
    "mode": "specific",
    "reference": {
      "type": "id",
      "value": "<INSTAGRAM_MEDIA_ID>"
    }
  }
}
```

Um gatilho de comentário também aceita o endereço público de um post. Envie
`url` como `type` da referência e o endereço como `value`.

Um gatilho de resposta ou de reação a story aceita somente o tipo de referência
`id`, então este endpoint é o caminho para vinculá-lo. Leia
[Atualizar uma automação](/pt-BR/api/v1/automations/update) para conhecer o
formato completo do gatilho.

## Pagine os resultados

Defina `limit` como um inteiro de 1 a 50. Quando `next_cursor` for uma string,
envie o mesmo valor como `cursor` para pedir a próxima página. Um `next_cursor`
igual a `null` indica que a lista terminou.

Esta leitura não altera nenhuma automação, então pode ser repetida com
segurança. Quando o Instagram não pode ser acessado, a API retorna `503` com
`api_instagram_media_unavailable`. Essa resposta é temporária e não significa
que a conta ficou inacessível.

## Exemplo de requisição

```bash theme={null}
curl --get \
  --url "https://levios.app/api/v1/accounts/${LEVIOS_ACCOUNT_ID}/media" \
  --header "Authorization: Bearer ${LEVIOS_API_KEY}" \
  --data-urlencode 'surface=posts' \
  --data-urlencode 'limit=25'
```


## OpenAPI

````yaml openapi/v1.json GET /api/v1/accounts/{accountId}/media
openapi: 3.1.0
info:
  title: levios public API
  version: '1'
servers:
  - url: https://levios.app
security:
  - bearerAuth: []
paths:
  /api/v1/accounts/{accountId}/media:
    get:
      tags:
        - account_media
      summary: List Instagram media
      description: >-
        Returns a cursor-paginated list of posts or stories for one Instagram
        account.
      operationId: accounts.media.list
      parameters:
        - name: accountId
          in: path
          required: true
          schema:
            type: string
            format: uuid
        - name: cursor
          in: query
          required: false
          schema:
            type: string
        - name: limit
          in: query
          required: false
          schema:
            type: string
        - name: surface
          in: query
          required: true
          schema:
            type: string
            enum:
              - posts
              - stories
      responses:
        '200':
          description: Successful response.
          headers:
            X-Correlation-ID:
              description: Correlation identifier for this request.
              schema:
                type: string
                pattern: ^[0-9A-HJKMNP-TV-Z]{26}$
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicInstagramMediaPageV1'
        '400':
          description: Error response.
          headers:
            X-Correlation-ID:
              description: Correlation identifier for this request.
              schema:
                type: string
                pattern: ^[0-9A-HJKMNP-TV-Z]{26}$
          content:
            application/json:
              schema:
                oneOf:
                  - type: object
                    properties:
                      error:
                        type: object
                        properties:
                          code:
                            type: string
                            enum:
                              - api_invalid_content_length
                          correlation_id:
                            type: string
                          message:
                            type: string
                            enum:
                              - Invalid Content-Length.
                        required:
                          - code
                          - message
                        additionalProperties: false
                    required:
                      - error
                    additionalProperties: false
                  - type: object
                    properties:
                      error:
                        type: object
                        properties:
                          code:
                            type: string
                            enum:
                              - api_invalid_json
                          correlation_id:
                            type: string
                          message:
                            type: string
                            enum:
                              - The request body is not valid JSON.
                        required:
                          - code
                          - message
                        additionalProperties: false
                    required:
                      - error
                    additionalProperties: false
                  - type: object
                    properties:
                      error:
                        type: object
                        properties:
                          code:
                            type: string
                            enum:
                              - api_invalid_request_url
                          correlation_id:
                            type: string
                          message:
                            type: string
                            enum:
                              - The request URL is invalid.
                        required:
                          - code
                          - message
                        additionalProperties: false
                    required:
                      - error
                    additionalProperties: false
                  - type: object
                    properties:
                      error:
                        type: object
                        properties:
                          code:
                            type: string
                            enum:
                              - api_invalid_utf8
                          correlation_id:
                            type: string
                          message:
                            type: string
                            enum:
                              - The request body is not valid UTF-8.
                        required:
                          - code
                          - message
                        additionalProperties: false
                    required:
                      - error
                    additionalProperties: false
        '401':
          description: Error response.
          headers:
            X-Correlation-ID:
              description: Correlation identifier for this request.
              schema:
                type: string
                pattern: ^[0-9A-HJKMNP-TV-Z]{26}$
            WWW-Authenticate:
              description: API key Bearer challenge.
              schema:
                type: string
                enum:
                  - Bearer
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        enum:
                          - api_unauthorized
                      correlation_id:
                        type: string
                      message:
                        type: string
                        enum:
                          - Authentication required.
                    required:
                      - code
                      - message
                    additionalProperties: false
                required:
                  - error
                additionalProperties: false
        '403':
          description: Error response.
          headers:
            X-Correlation-ID:
              description: Correlation identifier for this request.
              schema:
                type: string
                pattern: ^[0-9A-HJKMNP-TV-Z]{26}$
          content:
            application/json:
              schema:
                oneOf:
                  - type: object
                    properties:
                      error:
                        type: object
                        properties:
                          code:
                            type: string
                            enum:
                              - api_account_not_granted
                          correlation_id:
                            type: string
                          message:
                            type: string
                            enum:
                              - >-
                                This credential is not authorized for the
                                request.
                        required:
                          - code
                          - message
                        additionalProperties: false
                    required:
                      - error
                    additionalProperties: false
                  - type: object
                    properties:
                      error:
                        type: object
                        properties:
                          code:
                            type: string
                            enum:
                              - api_forbidden
                          correlation_id:
                            type: string
                          message:
                            type: string
                            enum:
                              - >-
                                This credential is not authorized for the
                                request.
                        required:
                          - code
                          - message
                        additionalProperties: false
                    required:
                      - error
                    additionalProperties: false
                  - type: object
                    properties:
                      error:
                        type: object
                        properties:
                          code:
                            type: string
                            enum:
                              - api_scope_denied
                          correlation_id:
                            type: string
                          message:
                            type: string
                            enum:
                              - >-
                                This credential is not authorized for the
                                request.
                        required:
                          - code
                          - message
                        additionalProperties: false
                    required:
                      - error
                    additionalProperties: false
        '404':
          description: Error response.
          headers:
            X-Correlation-ID:
              description: Correlation identifier for this request.
              schema:
                type: string
                pattern: ^[0-9A-HJKMNP-TV-Z]{26}$
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        enum:
                          - api_automation_media_not_found
                      correlation_id:
                        type: string
                      message:
                        type: string
                        enum:
                          - The referenced Instagram media was not found.
                    required:
                      - code
                      - message
                    additionalProperties: false
                required:
                  - error
                additionalProperties: false
        '413':
          description: Error response.
          headers:
            X-Correlation-ID:
              description: Correlation identifier for this request.
              schema:
                type: string
                pattern: ^[0-9A-HJKMNP-TV-Z]{26}$
          content:
            application/json:
              schema:
                oneOf:
                  - type: object
                    properties:
                      error:
                        type: object
                        properties:
                          code:
                            type: string
                            enum:
                              - api_body_too_large
                          correlation_id:
                            type: string
                          message:
                            type: string
                            enum:
                              - The JSON request body exceeds 1 MiB.
                        required:
                          - code
                          - message
                        additionalProperties: false
                    required:
                      - error
                    additionalProperties: false
                  - type: object
                    properties:
                      error:
                        type: object
                        properties:
                          code:
                            type: string
                            enum:
                              - api_json_too_deep
                          correlation_id:
                            type: string
                          message:
                            type: string
                            enum:
                              - The JSON request body exceeds maximum depth.
                        required:
                          - code
                          - message
                        additionalProperties: false
                    required:
                      - error
                    additionalProperties: false
        '415':
          description: Error response.
          headers:
            X-Correlation-ID:
              description: Correlation identifier for this request.
              schema:
                type: string
                pattern: ^[0-9A-HJKMNP-TV-Z]{26}$
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        enum:
                          - api_unsupported_media_type
                      correlation_id:
                        type: string
                      message:
                        type: string
                        enum:
                          - Content-Type must be application/json.
                    required:
                      - code
                      - message
                    additionalProperties: false
                required:
                  - error
                additionalProperties: false
        '422':
          description: Error response.
          headers:
            X-Correlation-ID:
              description: Correlation identifier for this request.
              schema:
                type: string
                pattern: ^[0-9A-HJKMNP-TV-Z]{26}$
          content:
            application/json:
              schema:
                oneOf:
                  - type: object
                    properties:
                      error:
                        type: object
                        properties:
                          code:
                            type: string
                            enum:
                              - api_automation_invalid_configuration
                          correlation_id:
                            type: string
                          message:
                            type: string
                            enum:
                              - >-
                                Configuration fields do not match the public
                                automation contract.
                        required:
                          - code
                          - message
                        additionalProperties: false
                    required:
                      - error
                    additionalProperties: false
                  - type: object
                    properties:
                      error:
                        type: object
                        properties:
                          code:
                            type: string
                            enum:
                              - api_invalid_cursor
                          correlation_id:
                            type: string
                          message:
                            type: string
                            enum:
                              - >-
                                The projection cursor is invalid for this
                                resource.
                        required:
                          - code
                          - message
                        additionalProperties: false
                    required:
                      - error
                    additionalProperties: false
                  - type: object
                    properties:
                      error:
                        type: object
                        properties:
                          code:
                            type: string
                            enum:
                              - api_invalid_limit
                          correlation_id:
                            type: string
                          message:
                            type: string
                            enum:
                              - >-
                                The page limit must be an integer between 1 and
                                50.
                        required:
                          - code
                          - message
                        additionalProperties: false
                    required:
                      - error
                    additionalProperties: false
                  - type: object
                    properties:
                      error:
                        type: object
                        properties:
                          code:
                            type: string
                            enum:
                              - api_validation_error
                          correlation_id:
                            type: string
                          details:
                            type: object
                            properties:
                              issues:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    code:
                                      type: string
                                      minLength: 1
                                      maxLength: 64
                                    path:
                                      type: array
                                      items:
                                        type: integer
                                        minimum: 0
                                      maxItems: 16
                                  required:
                                    - code
                                    - path
                                  additionalProperties: false
                                maxItems: 32
                            required:
                              - issues
                            additionalProperties: false
                          message:
                            type: string
                            enum:
                              - The request does not match the declared schema.
                        required:
                          - code
                          - message
                        additionalProperties: false
                    required:
                      - error
                    additionalProperties: false
        '429':
          description: Error response.
          headers:
            X-Correlation-ID:
              description: Correlation identifier for this request.
              schema:
                type: string
                pattern: ^[0-9A-HJKMNP-TV-Z]{26}$
            Retry-After:
              description: Seconds to wait before retrying.
              schema:
                type: integer
                minimum: 1
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        enum:
                          - rate_limited
                      correlation_id:
                        type: string
                      message:
                        type: string
                        enum:
                          - Rate limit exceeded.
                    required:
                      - code
                      - message
                    additionalProperties: false
                required:
                  - error
                additionalProperties: false
        '500':
          description: Error response.
          headers:
            X-Correlation-ID:
              description: Correlation identifier for this request.
              schema:
                type: string
                pattern: ^[0-9A-HJKMNP-TV-Z]{26}$
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        enum:
                          - api_internal_error
                      correlation_id:
                        type: string
                      message:
                        type: string
                        enum:
                          - The request could not be completed.
                    required:
                      - code
                      - message
                    additionalProperties: false
                required:
                  - error
                additionalProperties: false
        '503':
          description: Error response.
          headers:
            X-Correlation-ID:
              description: Correlation identifier for this request.
              schema:
                type: string
                pattern: ^[0-9A-HJKMNP-TV-Z]{26}$
          content:
            application/json:
              schema:
                oneOf:
                  - type: object
                    properties:
                      error:
                        type: object
                        properties:
                          code:
                            type: string
                            enum:
                              - api_account_resolution_unavailable
                          correlation_id:
                            type: string
                          message:
                            type: string
                            enum:
                              - The reachable account set could not be read.
                        required:
                          - code
                          - message
                        additionalProperties: false
                    required:
                      - error
                    additionalProperties: false
                  - type: object
                    properties:
                      error:
                        type: object
                        properties:
                          code:
                            type: string
                            enum:
                              - api_instagram_media_unavailable
                          correlation_id:
                            type: string
                          message:
                            type: string
                            enum:
                              - Instagram media is temporarily unavailable.
                        required:
                          - code
                          - message
                        additionalProperties: false
                    required:
                      - error
                    additionalProperties: false
                  - type: object
                    properties:
                      error:
                        type: object
                        properties:
                          code:
                            type: string
                            enum:
                              - rate_limiter_unavailable
                          correlation_id:
                            type: string
                          message:
                            type: string
                            enum:
                              - Rate limiter unavailable.
                        required:
                          - code
                          - message
                        additionalProperties: false
                    required:
                      - error
                    additionalProperties: false
components:
  schemas:
    PublicInstagramMediaPageV1:
      $ref: 3ba73f4a-fdb6-46f1-8f12-bd09040a5db6
      $defs:
        PublicInstagramMediaPageV1:
          additionalProperties: false
          properties:
            items:
              items:
                additionalProperties: false
                properties:
                  caption:
                    anyOf:
                      - pattern: ^(?![\s\S]*[\u0000\uD800-\uDFFF])[\s\S]{1,2200}$
                        type: string
                      - type: 'null'
                  comments_count:
                    anyOf:
                      - maximum: 9007199254740991
                        minimum: 0
                        type: integer
                      - type: 'null'
                  id:
                    pattern: ^[!-~]{1,256}$
                    type: string
                  instagram_url:
                    anyOf:
                      - format: uri
                        maxLength: 2048
                        type: string
                      - type: 'null'
                  like_count:
                    anyOf:
                      - maximum: 9007199254740991
                        minimum: 0
                        type: integer
                      - type: 'null'
                  media_type:
                    anyOf:
                      - enum:
                          - image
                          - video
                          - carousel
                        type: string
                      - type: 'null'
                  published_at:
                    anyOf:
                      - format: date-time
                        type: string
                      - type: 'null'
                  surface:
                    enum:
                      - posts
                      - stories
                    type: string
                  thumbnail_url:
                    anyOf:
                      - format: uri
                        maxLength: 2048
                        type: string
                      - type: 'null'
                required:
                  - id
                  - surface
                  - media_type
                  - caption
                  - thumbnail_url
                  - instagram_url
                  - published_at
                  - like_count
                  - comments_count
                type: object
              maxItems: 50
              type: array
            next_cursor:
              anyOf:
                - maxLength: 1024
                  minLength: 1
                  type: string
                - type: 'null'
          required:
            - items
            - next_cursor
          type: object
      $id: https://levios.app/schemas/public-instagram-media-page-v1
      $schema: https://json-schema.org/draft/2019-09/schema#
      title: PublicInstagramMediaPageV1
      x-levios-max-serialized-bytes: 65536
      x-levios-schema-version: 1
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Levios API key sent as a Bearer token.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.