Extração de Dados de Documentos API

Otimize seus fluxos de trabalho com nossa API de Extração de Dados de Documentos projetada para transformar qualquer documento estruturado ou não estruturado em dados estruturados e acionáveis
Use esta API do seu agente de IA via MCP
Funciona com OpenClaw, Claude Code/Desktop, Cursor, Windsurf, Cline e qualquer cliente de IA compatível com MCP.
Docs e configuração
Crie uma skill envolvendo este MCP: https://mcp.zylalabs.com/mcp?apikey=YOUR_ZYLA_API_KEY

Eleve suas capacidades de manuseio de dados com a API de Extração de Dados de Documentos da Extracta.ai Nossa solução inovadora capacita seus sistemas a extrair automaticamente dados estruturados de uma infinidade de documentos - sejam imagens digitalizadas, PDFs, e-mails, faturas, contratos ou qualquer formato de arquivo digital que você possa imaginar Adaptada para atender às necessidades de várias indústrias nossa API facilita a automação perfeita de fluxos de trabalho reduzindo significativamente os esforços manuais e aumentando a eficiência geral

Características:

  • Compatibilidade Universal: Processar documentos em qualquer formato - PDF DOCX TXT JPG PNG e mais
  • Alta Precisão e Velocidade: Aproveite a tecnologia de ponta que não requer pré-treinamento garantindo extração rápida com precisão superior
  • Extração de Dados Personalizável: Defina critérios de extração específicos para atender às suas necessidades comerciais exclusivas desde a extração de seções específicas de texto até pontos de dados complexos
  • Integração Fácil: Com documentação de API amigável para desenvolvedores integre nosso serviço suavemente em seu software ou fluxo de trabalho existente
  • Escalabilidade: De alguns documentos a milhares nossa API pode lidar com lotes de qualquer tamanho de forma eficiente
  • Segurança: A privacidade e segurança dos seus dados são fundamentais Garantimos que suas informações nunca sejam usadas para fins de treinamento e são tratadas com a mais alta confidencialidade

 

Se você é um desenvolvedor de software um analista de negócios ou um cientista de dados nossa API de Extração de Dados de Documentos foi projetada para simplificar suas tarefas de processamento de dados permitindo que você se concentre no que realmente importa - impulsionar seu negócio para frente Comece com a Extracta.ai hoje e transforme a maneira como você lida com documentos para sempre

Documentação da API

Endpoints


Estruture sua solicitação com parâmetros obrigatórios: 'nome', 'idioma', 'campos' e 'arquivo'. Cada campo requer uma 'chave', sendo 'descrição' e 'exemplo' opcionais. O documento deve ser fornecido como 'base64String' ou um 'fileUrl'.

## Documentação da API
Esta seção fornece diretrizes para estruturar suas solicitações da API de Análise de Documentos para a Extracta.ai. Certifique-se de seguir o formato abaixo para uma extração de dados bem-sucedida:

## Formato da Solicitação
```
{
"detalhesDaExtração": {
"nome": "Nome da Extração", // obrigatório - Nomeie seu processo de extração
"idioma": "Idioma Suportado", // obrigatório - Escolha entre os idiomas suportados
"campos": [
{
"chave": "Chave do Campo", // obrigatório - Defina a chave para a extração de dados
"descrição": "Descrição do Campo", // opcional - Descreva o campo
"exemplo": "Exemplo do Campo" // opcional - Forneça um valor de exemplo
},
...
]
},
"arquivo": "base64String ou URL do arquivo" // obrigatório - Forneça o documento no formato base64String ou como uma URL
}
```
## Formato Avançado
Além do formato básico descrito nas seções anteriores, a Extracta.ai também suporta estruturas de dados mais complexas para necessidades de extração especializadas. Este formato avançado permite a definição de **objetos e arrays aninhados**, atendendo a uma gama mais ampla de representação de dados.

### Tipo `objeto`
O tipo **objeto** representa um objeto estruturado com múltiplas **propriedades**. Cada propriedade é definida como um objeto dentro de um array e pode incluir sua própria **chave**, **descrição**, **tipo** e **exemplo**.
```
{
"chave": "informações_pessoais",
"descrição": "Informações pessoais da pessoa", // opcional
"tipo": "objeto",
"propriedades": [
{
"chave": "nome",
"descrição": "Nome da pessoa", // opcional
"exemplo": "Alex Smith", // opcional
"tipo": "string" // opcional
},
{
"chave": "email",
"descrição": "Email da pessoa",
"exemplo": "[email protected]",
"tipo": "string"
},
.....
]
}
```

### Tipo `array`
O tipo **array** é usado para listas de **itens**, como uma coleção de experiências de trabalho. A chave items contém um objeto definindo a estrutura de cada item no array.
```
{
"chave": "experiencia_de_trabalho",
"descrição": "Experiência de trabalho da pessoa", // opcional
"tipo": "array",
"itens": {
"tipo": "objeto",
"propriedades": [
{
"chave": "titulo",
"descrição": "Título do trabalho", // opcional
"exemplo": "Engenheiro de Software", // opcional
"tipo": "string" // opcional
},
{
"chave": "data_inicio",
"descrição": "Data de início do trabalho",
"exemplo": "2022",
"tipo": "string"
},
...
]
}
}
```

### Observações sobre o Uso | API de Análise de Documentos
- Para os tipos `objeto` e `array`, o parâmetro `exemplo` é aplicável apenas para suas propriedades/item internos.
- Ao definir campos, se nenhum `tipo` for especificado, o padrão será `string`.
- Para os tipos `objeto` e `array`, os campos internos só podem ser do tipo `string`. Isso significa que cada propriedade dentro de um objeto ou cada item dentro de um array deve ser do tipo string, garantindo consistência e simplicidade na representação de dados.
- Esses tipos de campo avançados permitem uma representação de dados mais detalhada e estruturada, aprimorando as capacidades do processo de extração de dados da Extracta.ai.

## Tipos de Arquivo Suportados

A Extracta.ai é capaz de processar documentos nos formatos **imagem (JPG, PNG), PDF e DOCX**. Essa melhoria permite uma maior variedade de tipos de documentos que podem ser enviados para extração.

## Idiomas Suportados

A Extracta.ai atualmente suporta a extração de documentos nos seguintes idiomas: **Romeno, Inglês, Francês, Espanhol, Árabe, Português, Alemão, Italiano**. Suporte adicional para mais 20 idiomas está planejado.

**Nota**: Se um idioma não suportado for especificado, a API retornará uma mensagem de erro indicando uma escolha de idioma inválida. Mantenha-se atualizado com nossa documentação da API para novas adições de idiomas.



                                                                            
POST https://www.zylalabs.com/api/3606/document+data+extraction+api/4000/process+document
                                                                            
                                                                        

Documento de Processo - Recursos do endpoint

Objeto Descrição
Corpo da requisição [Obrigatório] Json
Testar endpoint

RESPOSTA DE EXEMPLO DA API

       
                                                                                                        
                                                                                                                                                                                                                                                                                                                                        {
	"name": "Darren Charles",
	"email": "[email protected]",
	"phone": "+1-709-680-9033",
	"address": "9 Corpus Christi, Texas",
	"soft_skills": "highly motivated, ability to translate business strategies, learn new things",
	"hard_skills": "Matlab, MeVisLab, Keras, CUDA, Git, DataStage, MQTT",
	"last_job": "Trainee With English Communications",
	"years_of_experience": "Ongoing"
}
                                                                                                                                                                                                                    
                                                                                                    

Documento de Processo - TRECHOS DE CÓDIGO


curl --location --request POST 'https://zylalabs.com/api/3606/document+data+extraction+api/4000/process+document' --header 'Authorization: Bearer YOUR_API_KEY' 

--data-raw '{
	"extractionDetails": {
		"name": "CV - Extraction",
		"language": "English",
		"fields": [
			{
				"key": "name",
				"description": "the name of the person in the CV",
				"example": "Johan Smith"
			},
			{
				"key": "email",
				"description": "the email of the person in the CV",
				"example": "[email protected]"
			},
			{
				"key": "phone",
				"description": "the phone number of the person",
				"example": "123 333 4445"
			},
			{
				"key": "address",
				"description": "the compelte address of the person",
				"example": "1234 Main St, New York, NY 10001"
			},
			{
				"key": "soft_skills",
				"description": "the soft skills of the person",
				"example": ""
			},
			{
				"key": "hard_skills",
				"description": "the hard skills of the person",
				"example": ""
			},
			{
				"key": "last_job",
				"description": "the last job of the person",
				"example": "Software Engineer"
			},
			{
				"key": "years_of_experience",
				"description": "the years of experience of last job",
				"example": "5"
			}
		]
	},
	"file": "https://deveatery.com/extracta/cv.png"
}'

    

Chave de acesso à API e autenticação

Após se cadastrar, cada desenvolvedor recebe uma chave de acesso à API pessoal, uma combinação única de letras e dígitos para acessar nosso endpoint de API. Para autenticar com a Extração de Dados de Documentos API basta incluir seu token Bearer no cabeçalho Authorization.
Cabeçalhos
Cabeçalho Descrição
Authorization [Obrigatório] Deve ser Bearer access_key. Veja "Sua chave de acesso à API" acima quando você estiver inscrito.

Preços simples e transparentes

Sem compromisso de longo prazo. Faça upgrade, downgrade ou cancele a qualquer momento. O teste gratuito inclui até 50 requisições.

🚀 Empresarial

A partir de
$ 10.000/Ano


  • Volume personalizado
  • Limite de taxa personalizado
  • Suporte ao cliente especializado
  • Monitoramento de API em tempo real

Recursos favoritos dos clientes

  • ✔︎ Pague apenas por requisições bem-sucedidas
  • ✔︎ Teste 7 dias gratis
  • ✔︎ Suporte multilíngue
  • ✔︎ Uma chave de API, todas as APIs.
  • ✔︎ Painel intuitivo
  • ✔︎ Tratamento de erros abrangente
  • ✔︎ Documentação amigável para desenvolvedores
  • ✔︎ Integração com Postman
  • ✔︎ Conexões HTTPS seguras
  • ✔︎ Alta disponibilidade

Extração de Dados de Documentos API FAQs

Somos capazes de lidar com uma ampla gama de documentos, abrangendo tanto formatos estruturados quanto não estruturados, como PDFs, documentos Word, arquivos de texto e imagens digitalizadas (nos formatos PNG, JPG), empregando tecnologia OCR conforme necessário

A API retorna dados estruturados extraídos de documentos, incluindo campos principais como nome, e-mail, telefone, endereço e habilidades. Esses dados são organizados em um formato JSON, facilitando a integração em aplicativos

Os usuários podem personalizar solicitações definindo critérios de extração específicos no parâmetro 'fields'. Cada campo pode incluir uma 'chave', 'descrição' e 'exemplo', permitindo a extração de dados personalizada com base nas necessidades comerciais exclusivas

Os dados de resposta geralmente incluem campos como "nome", "email", "telefone", "endereço", "habilidades_suaves", "habilidades_duras", "último_emprego" e "anos_de_experiência" Esses campos fornecem insights abrangentes sobre o conteúdo do documento extraído

Os dados da resposta estão estruturados em um formato JSON onde cada chave corresponde a uma peça específica de informação extraída Essa organização permite uma análise e integração diretas em várias aplicações

A API pode extrair uma ampla variedade de informações, incluindo detalhes pessoais, informações de contato, habilidades, experiência de trabalho e formação educacional de vários tipos de documentos, como currículos e faturas

A precisão dos dados é mantida através de algoritmos de extração avançados que aproveitam a tecnologia de ponta A API não requer pré-treinamento garantindo extração rápida e precisa de diversos formatos de documentos

O endpoint aceita parâmetros como 'name' (nome da extração), 'language' (idiomas suportados) e 'fields' (chaves de dados específicas). Os usuários devem fornecer um documento válido no formato 'base64String' ou 'fileUrl'

Casos de uso típicos incluem a automação da inserção de dados a partir de currículos, faturas, contratos e outros documentos, a otimização dos fluxos de trabalho nos setores de RH, finanças e jurídicos, e a melhoria da eficiência do processamento de dados em várias indústrias

Perguntas Frequentes Gerais

O Zyla API Hub é como uma grande loja de APIs, onde você pode encontrar milhares delas em um só lugar. Também oferecemos suporte dedicado e monitoramento em tempo real de todas as APIs. Após se cadastrar, você pode escolher quais APIs deseja usar. Lembre-se apenas de que cada API precisa de sua própria assinatura. Mas se você se inscrever em várias, usará a mesma chave para todas elas, facilitando as coisas para você.

Os preços são listados em USD (Dólar Americano), EUR (Euro), CAD (Dólar Canadense), AUD (Dólar Australiano) e GBP (Libra Esterlina). Aceitamos todos os principais cartões de débito e crédito. Nosso sistema de pagamento usa a mais recente tecnologia de segurança e é operado pela Stripe, uma das empresas de pagamento mais confiáveis do mundo. Se tiver problemas para pagar com cartão, entre em contato conosco em [email protected]


Além disso, se você já tiver uma assinatura ativa em qualquer uma dessas moedas (USD, EUR, CAD, AUD, GBP), essa moeda será mantida para assinaturas subsequentes. Você pode alterar a moeda a qualquer momento, desde que não tenha assinaturas ativas.

A moeda local exibida na página de preços é baseada no país do seu endereço IP e é fornecida apenas como referência. Os preços reais são em USD (Dólar Americano). Ao efetuar o pagamento, a cobrança aparecerá no extrato do seu cartão em USD, mesmo que você veja o valor equivalente em sua moeda local em nosso site. Isso significa que você não pode pagar diretamente com sua moeda local.

Ocasionalmente, o banco pode recusar a cobrança devido às configurações de proteção contra fraude. Sugerimos contatar seu banco inicialmente para verificar se estão bloqueando nossas cobranças. Você também pode acessar o Portal de Cobrança e alterar o cartão associado para realizar o pagamento. Se isso não funcionar e precisar de mais ajuda, entre em contato com nossa equipe em [email protected]

Os preços são determinados por uma assinatura recorrente mensal ou anual, dependendo do plano escolhido.

As chamadas de API são descontadas do seu plano com base nas requisições bem-sucedidas. Cada plano possui um número específico de chamadas por mês. Apenas chamadas bem-sucedidas, indicadas por uma resposta com Status 200, serão contabilizadas, garantindo que falhas não afetem sua cota mensal.

O Zyla API Hub funciona com um sistema de assinatura mensal recorrente. Seu ciclo de cobrança começa no dia em que você compra um dos planos pagos e será renovado no mesmo dia do mês seguinte. Portanto, cancele sua assinatura com antecedência se quiser evitar cobranças futuras.

Para fazer upgrade do seu plano atual, acesse a página de preços da API e selecione o novo plano desejado. O upgrade é instantâneo, permitindo aproveitar imediatamente os recursos do novo plano. Observe que as chamadas restantes do plano anterior não serão transferidas; você será cobrado pelo valor integral do novo plano.

Para verificar quantas chamadas de API restam para o mês atual, consulte o campo 'X-Zyla-API-Calls-Monthly-Remaining' no cabeçalho da resposta. Por exemplo, se seu plano permite 1.000 requisições por mês e você usou 100, este campo no cabeçalho da resposta indicará 900 chamadas restantes.

Para ver o número máximo de requisições de API que seu plano permite, verifique o cabeçalho de resposta 'X-Zyla-RateLimit-Limit'. Por exemplo, se seu plano inclui 1.000 requisições por mês, este cabeçalho exibirá 1.000.

O cabeçalho 'X-Zyla-RateLimit-Reset' mostra o número de segundos até seu limite de taxa ser redefinido. Isso informa quando sua contagem de requisições começará do zero. Por exemplo, se exibir 3.600, significa que restam 3.600 segundos até o limite ser redefinido.

Sim, você pode cancelar seu plano a qualquer momento acessando sua conta e selecionando a opção de cancelamento na página de Cobrança. Observe que upgrades, downgrades e cancelamentos têm efeito imediato. Além disso, após o cancelamento, você não terá mais acesso ao serviço, mesmo que ainda tenha chamadas restantes na sua cota.

Você pode nos contatar via chat para receber assistência imediata. Estamos online de 8h às 17h (EST). Se nos contatar após esse horário, retornaremos o mais rápido possível. Além disso, você pode enviar um e-mail para [email protected]

Para oferecer a oportunidade de experimentar nossas APIs sem compromisso, oferecemos um teste gratuito de 7 dias que permite realizar até 50 chamadas de API sem custo. Esse teste pode ser usado apenas uma vez; recomendamos aplicá-lo à API que mais interessa. Embora a maioria das APIs ofereça teste gratuito, algumas podem não oferecer. O teste termina após 7 dias ou quando você atingir 50 requisições, o que ocorrer primeiro. Se atingir o limite, será necessário "Iniciar seu plano pago" para continuar. Você encontra esse botão no perfil em Assinatura -> Escolha a API -> aba Preços. Se não cancelar até o 7º dia, sua assinatura será cobrada automaticamente, liberando todas as chamadas do plano.

Após 7 dias, será cobrado o valor total do plano ao qual você estava inscrito durante o teste. Portanto, é importante cancelar antes do término do período. Solicitações de reembolso por esquecimento de cancelamento não são aceitas.

Ao assinar um teste gratuito de API, você pode fazer até 50 chamadas. Se desejar fazer chamadas adicionais além desse limite, a API solicitará que você "Inicie seu plano pago". Você encontra o botão no perfil em Assinatura -> Escolha a API -> aba Preços.

As Ordens de Pagamento são processadas entre os dias 20 e 30 de cada mês. Se você enviar sua solicitação antes do dia 20, seu pagamento será processado dentro desse período.


APIs relacionadas


Você também pode gostar