Porta de API

Documentação

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.

Comece sem chave

A triagem responde se o texto já está de pé, com uma leitura de prontidão de 0 a 100, o tipo de obra sugerido e até seis perguntas objetivas sobre o que falta. Ela não pede chave nenhuma.

A triagem roda num modelo barato e serve para decidir se vale medir. A nota que conta, com os três modelos de referência e a elegibilidade da obra a um registro citável, sai em /v1/avaliacoes.

O freio é por origem, com quarenta triagens por dia. Texto comprido é aparado na leitura, nunca recusado, e a resposta diz quantos caracteres entraram.

curl https://crivum.org/v1/triagem \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{ "texto": "O rascunho, do jeito que ele está agora." }'

Autenticação

Toda chamada de /v1 leva a chave de API no header Authorization, no formato Bearer seguido da chave, por exemplo Authorization: Bearer crv_test_SUACHAVE.

Uma chave crv_test_ mede em ambiente de teste, sem cobrar da conta. Uma chave crv_live_ mede de verdade e consome laudas da conta.

Emita a sua chave no console do desenvolvedor, com a conta da Crivum. A chave aparece em claro uma única vez.

Medir um texto

Uma chave crv_test_ mede em ambiente de teste, sem cobrar da conta.

curl https://crivum.org/v1/avaliacoes \
  -X POST \
  -H "Authorization: Bearer crv_test_SUACHAVE" \
  -H "Content-Type: application/json" \
  -d '{
    "texto": "O texto completo do trabalho.",
    "titulo": "Título do trabalho",
    "tipo": "pesquisa",
    "referencia": "meu-pedido-001"
  }'

Reconsultar pela referência

A mesma referência do pedido original devolve o resultado já registrado, sem medir de novo e sem cobrar de novo.

curl https://crivum.org/v1/avaliacoes/meu-pedido-001 \
  -H "Authorization: Bearer crv_test_SUACHAVE"

Critérios, sem chave

Título e descrição de cada critério por tipo de obra, o mesmo texto que chega ao modelo que mede. Rota pública.

curl https://crivum.org/v1/criterios

Acervo publicado, sem chave

Os mesmos registros que /acervo já mostra, paginados por cursor.

curl https://crivum.org/v1/records

Duas formas de corpo

O corpo de erro sempre traz ok falso e descreve um problema na própria chamada, como chave ausente ou limite de pedidos excedido. Toda resposta atendida traz ok verdadeiro, então a mesma propriedade responde nos dois caminhos.

Sobra um terceiro caso. Quando a medição não chega ao fim, por falta de saldo, por recusa de conteúdo ou por indisponibilidade, o campo ok não nasce, porque dizer que a chamada foi atendida ali seria falso. Nesse caso o par estado e causa conta o que aconteceu.

Contrato completo

A descrição estruturada de toda rota, no formato OpenAPI, está em /openapi.json. Um resumo curto para um modelo de linguagem ler direto está em /llms.txt.