Crivum Triagem API

openapi: 3.2.0
info:
  title: Crivum Triagem API
  version: v1
  description: A Crivum mede um texto contra critérios padronizados por três modelos de referência e devolve um resultado de 0 a 100 com a decomposição por critério e a divergência entre eles. Quando o trabalho passa do piso e a autora assina, a Crivum deposita um DOI Crossref, publica uma página citável e guarda prova de anterioridade.
servers:
- url: https://crivum.org
- url: https://crivum.dev
tags:
- name: Triagem
paths:
  /v1/triagem:
    post:
      summary: Diz se um texto já está de pé, sem chave de API
      description: Rota pública, sem chave. Um modelo barato responde se o material já tem problema, método e resultado, devolve uma leitura de prontidão de 0 a 100 e, quando falta informação, até seis perguntas objetivas. O freio é por origem, com 40 triagens por dia. Texto acima do teto de leitura é aparado, nunca recusado, e a resposta declara isso em texto_aparado e caracteres_lidos. A medição que vale, com os três modelos de referência, mora em POST /v1/avaliacoes e exige chave.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                texto:
                  type: string
                  minLength: 20
                  maxLength: 400000
              required:
              - texto
              additionalProperties: false
      responses:
        '200':
          description: Triagem concluída.
          content:
            application/json:
              example:
                ok: true
                pronto: false
                prontidao: 58
                tipo_sugerido: relato
                leitura: O texto descreve a intervenção com clareza e ainda não apresenta os resultados medidos.
                perguntas:
                - Quais indicadores foram medidos antes e depois da intervenção?
                - Qual foi o período de acompanhamento?
                - Que limitações o próprio autor reconhece no método?
                texto_aparado: false
                caracteres_lidos: 1200
                alcance: Esta triagem sai de um modelo barato e responde se o texto já tem problema, método e resultado de pé. A nota que vale sai da medição pelos três modelos de referência.
                medicao_completa:
                  rota: POST /v1/avaliacoes
                  entrega: Nota de 0 a 100 com a decomposição por critério, a divergência entre os três modelos de referência e a elegibilidade da obra a um registro citável.
                  exige_chave: true
                contrato: v1
        '400':
          description: Corpo fora do contrato desta rota.
          content:
            application/json:
              schema:
                type: object
                description: Envelope de ERRO da porta. Sempre ok:false — a chamada foi recusada antes de medir.
                properties:
                  ok:
                    type: boolean
                    enum:
                    - false
                  codigo:
                    type: string
                  frase:
                    type: string
                  como_corrigir:
                    type: string
                  documentacao:
                    type: string
                  contrato:
                    type: string
                  cobrado:
                    type: boolean
                required:
                - ok
                - codigo
                - frase
                - como_corrigir
                - documentacao
                - contrato
                - cobrado
        '429':
          description: As triagens gratuitas desta origem acabaram nesta janela.
          content:
            application/json:
              schema:
                type: object
                description: Envelope de ERRO da porta. Sempre ok:false — a chamada foi recusada antes de medir.
                properties:
                  ok:
                    type: boolean
                    enum:
                    - false
                  codigo:
                    type: string
                  frase:
                    type: string
                  como_corrigir:
                    type: string
                  documentacao:
                    type: string
                  contrato:
                    type: string
                  cobrado:
                    type: boolean
                required:
                - ok
                - codigo
                - frase
                - como_corrigir
                - documentacao
                - contrato
                - cobrado
        '503':
          description: A casa não conseguiu triar o texto agora.
          content:
            application/json:
              schema:
                type: object
                description: Envelope de ERRO da porta. Sempre ok:false — a chamada foi recusada antes de medir.
                properties:
                  ok:
                    type: boolean
                    enum:
                    - false
                  codigo:
                    type: string
                  frase:
                    type: string
                  como_corrigir:
                    type: string
                  documentacao:
                    type: string
                  contrato:
                    type: string
                  cobrado:
                    type: boolean
                required:
                - ok
                - codigo
                - frase
                - como_corrigir
                - documentacao
                - contrato
                - cobrado
      tags:
      - Triagem
      operationId: postV1Triagem
      x-operation-id-source: derived
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Chave de API da conta, enviada como Authorization: Bearer <chave>.'