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

# Encerrar uma tentativa

> Como a tentativa terminou: `done`, `failed` ou `unknown_outcome`. Só `failed` abre uma tentativa nova.



## OpenAPI

````yaml openapi/pt/cell.json POST /v1/coordination/effects/{effect_id}/settle
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/{effect_id}/settle:
    post:
      tags:
        - coordination
      summary: Encerrar uma tentativa
      description: >-
        Como a tentativa que quem chama detém terminou: `done`, `failed` ou
        `unknown_outcome` (o pedido saiu e ninguém confirmou). Só `failed` abre
        uma tentativa nova; um efeito ambíguo nunca é enviado de novo por conta
        própria. O encerramento de uma tentativa mais antiga é recusado.


        **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: settle_effect_v1_coordination_effects__effect_id__settle_post
      parameters:
        - in: path
          name: effect_id
          required: true
          schema:
            title: Effect Id
            type: string
        - in: header
          name: Idempotency-Key
          required: true
          schema:
            maxLength: 256
            minLength: 1
            title: Idempotency-Key
            type: string
          description: >-
            Fica guardada 24 horas com o hash do corpo; a mesma chave com outro
            corpo devolve 409.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EffectSettle'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Effect'
          description: O efeito como fica depois do encerramento.
        '422':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
          description: O pedido não bate com o contrato.
      security:
        - sourceKey: []
components:
  schemas:
    EffectSettle:
      additionalProperties: false
      properties:
        attempt:
          minimum: 1
          title: Attempt
          type: integer
        state:
          enum:
            - done
            - failed
            - unknown_outcome
          title: State
          type: string
      required:
        - state
        - attempt
      title: EffectSettle
      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
  securitySchemes:
    sourceKey:
      type: http
      scheme: bearer
      description: nia_sk_...

````