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

# Criar uma fila

> O tipo vem do nome: `.fifo` cria FIFO; qualquer outro nome cria uma fila padrão. Não há sinalizador separado que possa divergir.

<Info>
  Exige a ação IAM **`queue:CreateQueue`**. Veja [QUEUE permissões](/pt/queue/permissions) para a lista completa, o escopo de cada ação e um exemplo de política.
</Info>


## OpenAPI

````yaml /pt/api-reference/specs/queue.yaml post /v1/queues
openapi: 3.0.3
info:
  title: API Basaltic Queue
  version: 1.0.0
  description: >-
    Filas duráveis com entrega ao menos uma vez. Receber uma mensagem concede
    uma reserva temporária: `ReceiveMessage` a oculta pelo timeout de
    visibilidade e retorna um recibo. Exclua a mensagem com esse recibo antes do
    vencimento para evitar a reentrega. Cada recebimento gera um recibo novo;
    recibos vencidos retornam `QUEUE_RECEIPT_HANDLE_EXPIRED`.


    Filas padrão têm ordenação de melhor esforço. Filas FIFO terminam em
    `.fifo`, mantêm a ordem por `message_group_id` e deduplicam
    `message_deduplication_id` por cinco minutos. Grupos diferentes podem ser
    processados em paralelo. O tipo é imutável. `wait_time_seconds` permite
    aguardar até 20 segundos por mensagens.


    Os corpos são criptografados em repouso. `kms_key` aceita UUID, nome na
    conta ou CRN completo de uma chave simétrica habilitada na mesma conta e
    região. Referências inválidas retornam 400; chaves inexistentes retornam
    404. Leituras de metadados preservam ID e CRN de uma vinculação excluída. A
    chave de dados permanece em cache por `kms_data_key_reuse_period_seconds`;
    envios e recebimentos podem continuar nessa janela após desativar a chave.
    Reduzir o período aumenta as chamadas ao KMS.
  contact:
    name: Basaltic Support
    email: ping@basaltic.sh
  license:
    name: Proprietary
    url: https://basaltic.sh/terms
servers:
  - url: https://queue.{region}.basaltic.sh
    description: Endpoint de API regional
    variables:
      region:
        default: sa-saopaulo-1
        description: Código de região
security:
  - BearerAuth: []
tags:
  - name: Queues
    description: Ciclo de vida e atributos das filas
  - name: Messages
    description: Envio, recebimento e confirmação de mensagens
paths:
  /v1/queues:
    post:
      tags:
        - Queues
      summary: Criar uma fila
      description: >-
        O tipo vem do nome: `.fifo` cria FIFO; qualquer outro nome cria uma fila
        padrão. Não há sinalizador separado que possa divergir.
      operationId: createQueue
      parameters:
        - $ref: '#/components/parameters/IdempotencyKey'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateQueueRequest'
      responses:
        '201':
          description: Fila criada.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueueResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          description: Já existe uma fila com este nome na conta.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '422':
          $ref: '#/components/responses/UnprocessableEntity'
components:
  parameters:
    IdempotencyKey:
      name: Idempotency-Key
      in: header
      description: >-
        Chave opcional gerada pelo cliente que torna uma criação segura para
        reprodução. A reintentar uma solicitação com a mesma chave retorna o
        resultado original literalmente em vez de criar um recurso duplicado. A
        reutilização de uma chave com um corpo de solicitação diferente é
        rejeitada (422); uma solicitação cuja chave ainda está sendo processada
        retorna 409. Os registros são honrados por 24 horas. Use um UUID ou
        token exclusivo semelhante.
      required: false
      schema:
        type: string
        maxLength: 255
      example: 550e8400-e29b-41d4-a716-446655440000
  schemas:
    CreateQueueRequest:
      type: object
      required:
        - name
      properties:
        name:
          type: string
          maxLength: 80
          description: >-
            Letras, dígitos, ponto, hífen ou sublinhado, começando com letra ou
            dígito. O sufixo `.fifo` cria uma fila FIFO. Nomes não podem começar
            com crn: nem ser UUIDs em formato canônico, compacto, entre chaves
            ou urn:uuid:, independentemente de maiúsculas.
          example: orders
        visibility_timeout_seconds:
          type: integer
          minimum: 0
          maximum: 43200
          example: 30
        message_retention_seconds:
          type: integer
          minimum: 60
          maximum: 1209600
          example: 345600
        max_message_bytes:
          type: integer
          minimum: 1024
          maximum: 262144
          example: 262144
        delay_seconds:
          type: integer
          minimum: 0
          maximum: 900
          example: 0
        receive_wait_time_seconds:
          type: integer
          minimum: 0
          maximum: 20
          example: 0
        kms_data_key_reuse_period_seconds:
          type: integer
          minimum: 60
          maximum: 86400
          example: 300
        content_based_deduplication:
          type: boolean
          description: Somente filas FIFO.
          example: false
        kms_key:
          type: string
          description: >-
            UUID, CRN ou nome da chave KMS na conta. Omita para usar a chave da
            plataforma.
          example: crn:kms:sa-saopaulo-1:acme:key/service-key
        redrive_policy:
          $ref: '#/components/schemas/RedrivePolicyInput'
        tags:
          $ref: '#/components/schemas/Tags'
    QueueResponse:
      type: object
      required:
        - queue
      properties:
        queue:
          $ref: '#/components/schemas/Queue'
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
            - request_id
          properties:
            code:
              type: string
              description: Código de erro identificando o tipo de erro
              example: INVALID_INPUT
            message:
              type: string
              description: Mensagem de erro legível pelo ser humano
              example: Invalid request parameters
            params:
              type: object
              additionalProperties: true
              description: >-
                Valores não sensíveis opcionais para interpolação de erros
                localizados, codificados por código de erro. Nunca presente para
                erros de servidor.
              example:
                instances: 2
                pools: 0
            request_id:
              type: string
              format: uuid
              description: Solicitar ID para depuração
              example: 550e8400-e29b-41d4-a716-446655440000
    RedrivePolicyInput:
      type: object
      description: >-
        UUID, CRN ou nome da fila de destino na conta. Resolvido uma vez e
        armazenado como UUID imutável. Deve ser da mesma conta, região e tipo, e
        diferente da origem. Sintaxe, tipo ou região inválidos retornam 400;
        destinos inexistentes ou de outra conta retornam 404. Não há busca
        alternativa.
      required:
        - dead_letter_queue
        - max_receive_count
      properties:
        dead_letter_queue:
          type: string
          example: crn:queue:sa-saopaulo-1:acme:queue/failed-orders
        max_receive_count:
          type: integer
          minimum: 1
          maximum: 1000
          example: 5
    Tags:
      type: object
      additionalProperties:
        type: string
      example:
        environment: production
        team: backend
    Queue:
      type: object
      required:
        - id
        - crn
        - name
        - kind
        - attributes
        - created_at
        - updated_at
      properties:
        id:
          type: string
          format: uuid
          example: a1b2c3d4-5e6f-4a7b-8c9d-0e1f2a3b4c5d
        crn:
          type: string
          example: crn:queue:sa-saopaulo-1:my-account:queue/orders
        name:
          type: string
          description: >-
            Exclusivo na conta e imutável. Não pode começar com crn: nem ser
            UUID em formato canônico, compacto, entre chaves ou urn:uuid:,
            independentemente de maiúsculas.
          example: orders
        kind:
          type: string
          enum:
            - standard
            - fifo
          description: Derivado do nome e imutável.
          example: standard
        attributes:
          $ref: '#/components/schemas/QueueAttributes'
        redrive_policy:
          $ref: '#/components/schemas/RedrivePolicy'
        content_based_deduplication:
          type: boolean
          description: >-
            Somente FIFO. Deriva o identificador de deduplicação do hash do
            corpo quando o remetente não o fornece.
          example: false
        kms_key:
          allOf:
            - $ref: '#/components/schemas/ResourceRef'
          description: >-
            Chave gerenciada pelo cliente que protege a chave de dados da fila.
            Ausente para criptografia da plataforma. Se os metadados estiverem
            indisponíveis, a referência mantém ID e CRN, sem nome.
          example:
            id: c3d4e5f6-7a8b-4c9d-8e0f-1a2b3c4d5e6f
            crn: crn:kms:sa-saopaulo-1:acme:key/service-key
            name: service-key
        tags:
          $ref: '#/components/schemas/Tags'
        depth:
          $ref: '#/components/schemas/QueueDepth'
        created_at:
          type: string
          format: date-time
          example: '2026-01-15T09:30:00Z'
        updated_at:
          type: string
          format: date-time
          example: '2026-01-18T11:45:00Z'
    QueueAttributes:
      type: object
      description: >-
        Configurações ajustáveis da fila. Todas as durações são segundos
        inteiros.
      properties:
        visibility_timeout_seconds:
          type: integer
          minimum: 0
          maximum: 43200
          description: >-
            Tempo de invisibilidade da mensagem recebida antes da reentrega. 0
            permite reentrega imediata.
          example: 30
        message_retention_seconds:
          type: integer
          minimum: 60
          maximum: 1209600
          description: Tempo de retenção de uma mensagem não excluída antes do descarte.
          example: 345600
        max_message_bytes:
          type: integer
          minimum: 1024
          maximum: 262144
          description: Tamanho máximo aceito. Inclui o corpo e os atributos.
          example: 262144
        delay_seconds:
          type: integer
          minimum: 0
          maximum: 900
          description: >-
            Atraso padrão dos envios que não o substituem. Não disponível em
            filas FIFO.
          example: 0
        receive_wait_time_seconds:
          type: integer
          minimum: 0
          maximum: 20
          description: Janela padrão de espera para recebimentos que não a substituem.
          example: 0
        kms_data_key_reuse_period_seconds:
          type: integer
          minimum: 60
          maximum: 86400
          description: >-
            Tempo de cache da chave de dados descriptografada. Envios e
            recebimentos podem continuar por esse período após desativar a chave
            protetora. Reduzir o período diminui essa janela e aumenta as
            chamadas ao KMS.
          example: 300
    RedrivePolicy:
      type: object
      description: >-
        Isola mensagens concedidas e abandonadas repetidamente. Quando
        `receive_count` atinge `max_receive_count`, a mensagem deixa de ser
        entregue e vai para a fila de mensagens não entregues, que deve ser do
        mesmo tipo.
      required:
        - dead_letter_queue
        - max_receive_count
      properties:
        dead_letter_queue:
          allOf:
            - $ref: '#/components/schemas/ResourceRef'
          example:
            id: b2c3d4e5-6f7a-4b8c-9d0e-1f2a3b4c5d6e
            crn: crn:queue:sa-saopaulo-1:acme:queue/failed-orders
            name: failed-orders
        max_receive_count:
          type: integer
          minimum: 1
          maximum: 1000
          example: 5
    ResourceRef:
      type: object
      required:
        - id
        - crn
      properties:
        id:
          type: string
          format: uuid
          example: 288aa1e9-bbf5-5584-bce9-6a688f06d8a1
        crn:
          type: string
          example: crn:catalog::platform:country/288aa1e9-bbf5-5584-bce9-6a688f06d8a1
        name:
          type: string
          description: >-
            Rótulo no momento da resposta: o nome do recurso, quando houver, ou
            seu rótulo legível (número de fatura, nome de exibição da conta).
            Ausente quando o destino não existe mais. Não é uma chave de
            consulta.
          example: Brazil
    QueueDepth:
      type: object
      description: >-
        Contagens aproximadas de mensagens, limitadas a 10000. Uma contagem
        exata exigiria uma varredura e ficaria desatualizada imediatamente.
        `counts_capped` indica que ao menos uma contagem é um limite inferior.
      properties:
        approximate_available:
          type: integer
          example: 42
        approximate_in_flight:
          type: integer
          example: 3
        approximate_delayed:
          type: integer
          example: 0
        counts_capped:
          type: boolean
          example: false
  responses:
    BadRequest:
      description: Parâmetros de solicitação inválidos
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: INVALID_INPUT
              message: Invalid request parameters
              request_id: 550e8400-e29b-41d4-a716-446655440000
    Unauthorized:
      description: Autenticação necessária ou token inválido
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: UNAUTHORIZED
              message: Authentication required
              request_id: 550e8400-e29b-41d4-a716-446655440000
    Forbidden:
      description: Permissões insuficientes
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: ACCESS_DENIED
              message: You don't have permission to perform this action
              request_id: 550e8400-e29b-41d4-a716-446655440000
    NotFound:
      description: Página não encontrada
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: NOT_FOUND
              message: Resource not found
              request_id: 550e8400-e29b-41d4-a716-446655440000
    UnprocessableEntity:
      description: >
        A solicitação está bem formada, mas não pode ser processada conforme
        enviada. Nas operações que aceitam `Idempotency-Key` este é o caso de
        reutilização de chave: a chave foi vista pela primeira vez com uma carga
        de solicitação diferente, então reproduzir o resultado armazenado
        responderia a uma pergunta que o chamador não fez.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: IDEMPOTENCY_KEY_REUSED
              message: >-
                This Idempotency-Key was already used with a different request
                payload
              request_id: 550e8400-e29b-41d4-a716-446655440000
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >+
        Um token bearer OAuth 2.0, enviado como `Authorization: Bearer <token>`.
        Esta é a forma recomendada de autenticação.


        Obtenha o token trocando o par de chaves de acesso de uma conta de
        serviço em `POST /v1/oauth/token` com `grant_type=client_credentials`.
        Esse é o fluxo padrão de credenciais de cliente; bibliotecas compatíveis
        com OAuth podem obter e renovar o token para você.


        ```

        curl -s -u "$KEY_ID:$SECRET" -d grant_type=client_credentials \
          https://iam.basaltic.sh/v1/oauth/token
        ```


        Os tokens duram uma hora por padrão. O mesmo par de chaves de acesso
        também serve como credencial AWS SigV4 para o endpoint de objetos
        compatível com S3, que aceita somente esse método de autenticação.


````

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