IntentParse API · v1

Raw input entra. Intenção confiável sai.

Seu backend envia a mensagem original, locale e schema. O IntentParse chama o modelo BYOK escolhido, valida o draft e retorna estado estruturado com proveniência.

REST + JSONOpenAPI 3.1BYOKEN + PT-BR

Primeiro parse em quatro passos.

01Obtenha inp_

Credencial IntentParse emitida para projeto e ambiente.

02Escolha modelo

Use uma credencial BYOK server-side.

03Envie raw input

Não classifique a intenção antes.

04Valide a saída

Consuma o objeto conforme o schema versionado.

Autenticação e BYOK.

Nunca envie nenhuma dessas credenciais pelo navegador. O IntentParse não persiste a chave efêmera do provedor.

AuthorizationBearer inp_…X-IntentParse-Model-Provideropenai | deepseekX-IntentParse-Provider-KeySegredo efêmeroX-IntentParse-ModelModelo compatível escolhido

POST /v1/parse

curl https://api.intentparse.com/v1/parse \
+  -H "Authorization: Bearer $INTENTPARSE_API_KEY" \
+  -H "X-IntentParse-Model-Provider: deepseek" \
+  -H "X-IntentParse-Provider-Key: $DEEPSEEK_API_KEY" \
+  -H "X-IntentParse-Model: deepseek-v4-flash" \
+  -H "Content-Type: application/json" \
+  -d '{"input":"Quero um notebook leve para viajar",
       "locale":"pt-BR",
       "schema":{"id":"commerce.purchase","version":"1.0"}}'

Estado de intenção inspecionável.

FACT

known_facts

Informação explícita do usuário ou contexto.

INFERENCE

inferences

Dedução limitada, separada de fatos.

BOUNDARY

constraints + preferences

Requisitos rígidos não se misturam com preferências.

SAFETY

unresolved_dimensions

Campos ausentes orientam clarificação ou abstention.

{
  "intent": {
    "state": "resolved",
    "intent": "purchase_product",
    "entities": { "product_category": "notebook" },
    "preferences": [{ "dimension": "weight", "value": "light" }],
    "known_facts": [{ "dimension": "use_context", "value": "travel" }],
    "confidence": 0.9,
    "recommended_action": "execute"
  }
}

Retenção mínima por padrão.

Raw input não é armazenado por padrão.
Credencial BYOK nunca é persistida, ecoada ou logada.
Registros operacionais excluem conteúdo sensível.

Falhas previsíveis e seguras.

401Credencial IntentParse ou modelo inválida422Input ou schema inválido429Limite excedido503Dependência indisponível; nenhum revision criado