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

# Reservar um efeito

> Reserva a próxima tentativa de um efeito pela chave do fato de negócio; uma chave já feita ou ambígua não reserva nada, e uma tentativa em voo responde 409.



## OpenAPI

````yaml openapi/pt/cell.json POST /v1/coordination/effects
openapi: 3.1.0
info:
  title: API de dados da Niadra
  version: '1'
  description: >-
    Escrita, contexto, histórico, objetos, identidade, privacidade e governança
    de um espaço. Cada espaço tem um endereço estável, com o espaço e a região
    no nome.
servers:
  - url: https://{space}.{region}.api.niadra.com
    variables:
      space:
        default: acme-prod
        description: O espaço, que vem na chave de fonte.
      region:
        default: us-east-2
        description: A região do espaço, que também vem na chave.
security: []
paths:
  /v1/coordination/effects:
    post:
      tags:
        - coordination
      summary: Reservar um efeito
      description: >-
        Reserva a próxima tentativa de um efeito, nomeado pela chave do fato de
        negócio a que pertence (uma despedida por conversa, um protocolo por
        intimação). Uma pergunta com `effect_key` faz o mesmo; esta rota serve a
        quem já decidiu. Uma chave já `done` ou `unknown_outcome` não reserva
        nada, e a resposta diz isso; uma chave `reserved` por outra tentativa
        responde 409.


        **Autenticação.** Chave de fonte: `Authorization: Bearer nia_sk_...`.
        Escopo exigido: `coordinate`. Só responde num espaço com a
        funcionalidade `coordination` ligada (o documento `features`); num
        espaço sem ela, 404.
      operationId: reserve_effect_v1_coordination_effects_post
      parameters:
        - in: header
          name: Idempotency-Key
          required: true
          schema:
            maxLength: 256
            minLength: 1
            title: Idempotency-Key
            type: string
          description: >-
            Obrigatório. Guardado por 24 horas com o hash do corpo: a mesma
            chave com o mesmo corpo devolve a primeira resposta, e a mesma chave
            com outro corpo devolve 409 `conflict`.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EffectReserve'
        required: true
      responses:
        '200':
          description: 'A chave já estava feita ou ambígua: nada foi reservado, não aja.'
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Effect'
          description: A tentativa está reservada para quem chamou, que precisa encerrá-la.
        '409':
          description: '`effect_in_flight`: outra tentativa segura a chave.'
        '422':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
          description: O pedido não bate com o contrato.
      security:
        - sourceKey: []
components:
  schemas:
    EffectReserve:
      additionalProperties: false
      properties:
        cost_units:
          default: 0
          minimum: 0
          title: Cost Units
          type: integer
        effect_key:
          maxLength: 512
          minLength: 1
          title: Effect Key
          type: string
        fact:
          anyOf:
            - $ref: '#/components/schemas/ObjectRef'
            - type: 'null'
        kind:
          $ref: '#/components/schemas/EffectKind'
      required:
        - effect_key
        - kind
      title: EffectReserve
      type: object
    Effect:
      additionalProperties: false
      description: >-
        `effect_id` é o hash com chave da chave do efeito: nomeia o efeito nos
        caminhos, onde a própria chave, que pode levar um id de conversa, nunca
        vai.
      properties:
        attempt:
          title: Attempt
          type: integer
        done_at:
          anyOf:
            - format: date-time
              type: string
            - type: 'null'
          title: Done At
        effect_id:
          pattern: ^[A-Za-z0-9_-]{43}$
          title: Effect Id
          type: string
        reserved_at:
          format: date-time
          title: Reserved At
          type: string
        state:
          enum:
            - reserved
            - done
            - failed
            - unknown_outcome
          title: State
          type: string
      required:
        - effect_id
        - state
        - attempt
        - reserved_at
      title: Effect
      type: object
    Problem:
      additionalProperties: false
      description: >-
        Detalhes do problema no formato da RFC 9457; `code` vem do catálogo de
        erros versionado.
      properties:
        code:
          title: Code
          type: string
        detail:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          title: Detail
        request_id:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          title: Request Id
        status:
          title: Status
          type: integer
        title:
          title: Title
          type: string
        type:
          default: about:blank
          title: Type
          type: string
      required:
        - title
        - status
        - code
      title: Problem
      type: object
    ObjectRef:
      additionalProperties: false
      description: Um objeto de negócio num sistema de registro.
      properties:
        id:
          maxLength: 512
          minLength: 1
          title: Id
          type: string
          description: O id nesse sistema.
        namespace:
          maxLength: 256
          minLength: 1
          title: Namespace
          type: string
          description: O sistema onde ele vive, como `erp`.
        type:
          maxLength: 256
          minLength: 1
          title: Type
          type: string
          description: Tipo do objeto, como `invoice`, `order` ou `ticket`.
      required:
        - type
        - namespace
        - id
      title: ObjectRef
      type: object
    EffectKind:
      enum:
        - delivery
        - document
        - notice
        - filing
        - paid_call
        - external_action
      title: EffectKind
      type: string
  securitySchemes:
    sourceKey:
      type: http
      scheme: bearer
      description: nia_sk_...

````