IntentParse API · v1

Raw input in. Reliable intent out.

Your backend sends the original message, locale and schema. IntentParse calls your selected BYOK model, validates its draft and returns provenance-aware structured state.

REST + JSONOpenAPI 3.1BYOKEN + PT-BR

First parse in four steps.

01Get inp_

IntentParse credential issued for a project and environment.

02Choose model

Use a server-side BYOK credential.

03Send raw input

Do not classify intent first.

04Validate output

Consume the versioned schema object.

Authentication and BYOK.

Never send either credential from a browser. IntentParse does not persist the ephemeral provider key.

AuthorizationBearer inp_…X-IntentParse-Model-Provideropenai | deepseekX-IntentParse-Provider-KeyEphemeral secretX-IntentParse-ModelSelected compatible model

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":"I need a light notebook for travel",
       "locale":"en",
       "schema":{"id":"commerce.purchase","version":"1.0"}}'

Inspectable intent state.

FACT

known_facts

Explicit user or context information.

INFERENCE

inferences

Bounded deduction kept separate from facts.

BOUNDARY

constraints + preferences

Hard requirements stay separate from preferences.

SAFETY

unresolved_dimensions

Missing fields drive clarification or 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"
  }
}

Minimal retention by default.

Raw input is not stored by default.
BYOK credentials are never persisted, echoed or logged.
Operational records exclude sensitive content.

Predictable, safe failures.

401Invalid IntentParse or model credential422Invalid input or schema429Rate limit exceeded503Dependency unavailable; no revision created