Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
openapi: 3.2.0
info:
title: Crivum Saldo 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: Saldo
paths:
/v1/saldo:
get:
summary: Laudas de cortesia e pagas restantes, e o preço da próxima lauda avulsa
security:
- bearerAuth: []
responses:
'200':
description: Saldo atual da conta dona da chave.
content:
application/json:
example:
ok: true
livres: 42
pagas: 8
total: 50
proxima_renovacao: '2026-10-13T00:00:00.000Z'
preco_proxima_lauda: 12.9
moeda: BRL
chave:
prefixo_visivel: crv_live_9f3a
ambiente: live
expira_em: '2027-09-13T00:00:00.000Z'
escopos:
- avaliar
contrato: v1
'401':
description: Chave ausente, inválida, revogada ou vencida.
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:
- Saldo
operationId: getV1Saldo
x-operation-id-source: derived
components:
securitySchemes:
bearerAuth:
type: http
scheme: bearer
description: 'Chave de API da conta, enviada como Authorization: Bearer <chave>.'