All requests require a Bearer token in the Authorization header:
/v1/extract/name
Full name extraction
/v1/extract/email
Email extraction and typo correction
/v1/extract/postal-code
International postal code
/v1/extract/yes-no
Yes/No detection in any language
/v1/extract/birthdate
Date of birth in any format
/v1/extract/handoff
Intent to speak with human agent
/v1/extract/cancel-intent
Service cancellation intent
/v1/extract/company-name
Company name extraction
/v1/extract/cpf
Brazilian CPF validation (mod 11)
/v1/extract/cep
Brazilian ZIP code + enriched address
/v1/extract/phone-br
Brazilian phone with area code
/v1/extract/cnpj
Brazilian CNPJ validation (mod 11)
/v1/extract/plate-br
Brazilian vehicle plate (Mercosul or legacy)
/v1/extract/reply
Premium
Full conversational context analysis. Detects reply type, extracts value and provides suggestion to agent.
| Field | Type | Required | Description |
|---|---|---|---|
| agent_input | string | Yes* | Agent question/message (*not for reply) |
| user_input | string | Yes* | User response (*not for reply) |
| agent_message | string | reply only | Agent message for validate_reply |
| user_reply | string | reply only | User reply for validate_reply |
| language | string | No | BCP-47 tag (default: pt-BR) |
| agent_context | string | No | Agent objective description (improves accuracy) |
| Field | Type | Description |
|---|---|---|
| obtained | bool | true = data extracted successfully |
| extracted_value | string? | Normalized and validated value |
| certain | bool | true = no ambiguity |
| confidence | string | high / medium / low |
| smart_suggestion | string? | Suggested re-ask when obtained=false |
| credits_used | int | Credits consumed by this call |
| reply_type | string? | validate_reply only: confirmation / rejection / counter_proposal / handoff / cancel / other |
| suggestion_to_agent | string? | validate_reply only: contextual suggestion for the agent |
| Status | Meaning |
|---|---|
| 200 | Success |
| 400 | Invalid request (missing required field) |
| 401 | Invalid or missing API key |
| 402 | Insufficient credits |
| 429 | Rate limit exceeded |
| 500 | Internal server error |