Visão geral do API
On this page
O Curriculo API é uma API RESTful API em https://api.curriculo.me/public que fornece acesso programático aos mesmos motores de currículo, avaliação, linguagem e entrevista que executam dentro do produto Curriculo. As solicitações são JSON ou multipart/form-data; as respostas são JSON.
Novo no Curriculo? Comece com o guia de início rápido : crie uma conta, emita uma chave e faça uma chamada.
Pré-requisitos
APIs Disponíveis
| API | Operação | O que faz | Preço |
|---|---|---|---|
| Analizar | POST /parse/ | Ler CVs (PDF ou DOCX) em formato estruturado JSON. | $0.01 por solicitação |
| Avaliar | POST /evaluate/ | Avaliar CVs em relação a um cargo: adequação, análise de compatibilidade, lacunas. | R$0.01 por solicitação |
| Vagas | POST /jobs/ | Opcional. Registre uma descrição de vaga uma vez e reutilize-a job_id. | Gratuito |
| Traduzir | POST /translate/ | Traduzir strings ou PDF e DOCX documentos. | R$0.01 por solicitação (consulte a tabela de preços ) |
| Detectar idioma | POST /detect-language/ | Código ISO 639-1 para um texto ou até 200. | R$0.001 por solicitação |
| Resumo de entrevista | POST /summary/ | Destaque, bandeiras vermelhas, habilidades e recomendação de contratação a partir de uma transcrição ou gravação. | R$0.01, mais R$0.002 por minuto para gravações |
| Transcrever | POST /transcribe/ | Transcrição de uma gravação, sem resumo. | R$0.002 por minuto |
| Prompt | POST /prompt/ | Gerar, editar, traduzir ou questionar o currículo vinculado à sua credencial. Com estado. | R$0.01 por solicitação |
| Entrevista de triagem | POST /screening-interview | Entrevistas de triagem gravadas e hospedadas com callbacks assinados. | US$0.02 por convite enviado |
Tarefas em segundo plano
Análise, avaliação, resumo, transcrição e tradução também são executados em segundo plano: POST /{op}/async respostas 202 com um task_id de uma vez, e você coleta o resultado com GET /{op}/tasks/{task_id} ou o recebe por callback assinado. Veja Processamento em segundo plano e callbacks.
Caminhos
Operações síncronas terminam com uma barra no final (/parse/). Caminhos de tarefas em segundo plano (/parse/async,/parse/tasks/{task_id}) e caminhos de triagem (/screening-interview) são documentados sem uma.
Para a especificação completa, consulte o documento OpenAPI, ou navegue por ele em Swagger UI ou ReDoc.
Autenticação
| Cabeçalho | Valor | Obrigatório |
|---|---|---|
Authorization | Bearer key_<id>_<secret>, sua chave Console API | Sim |
Content-Type | application/json ou multipart/form-data, dependendo da operação | Sim, em requisições com corpo |
Uma chave Console autoriza todas as operações, imediatamente. Não há credenciais por endpoint, não há escopos e nada a habilitar. Consulte Autenticação.
Não há cabeçalho de versão API. A superfície é versionada por caminho e as alterações adicionais (novos campos opcionais, novas operações) são enviadas sem quebrar as chamadas existentes.
Base URL
https://api.curriculo.me/publicAponte o cliente para essa base e anexe o caminho da operação, por exemplo https://api.curriculo.me/public/parse/.
- Uma credencial em todos os lugares. Uma única chave de Console autentica todas as operações.
- Limites impostos por chave, , então uma integração barulhenta não pode gastar o orçamento de outra.
- Requisições com falha nunca são cobradas. . Uma
4xxou5xxnão custa nada.
Produção é o único ambiente publicado.
Formato de solicitação e resposta
Veja Solicitações e respostas. A versão curta:
/parse/,/evaluate/,/prompt/e/transcribe/levammultipart/form-data./detect-language/e/jobs/levamapplication/json./translate/e/summary/levamapplication/json, oumultipart/form-datapara enviar documentos ou gravações.- Um documento pode ter até 10 MB. O corpo de uma solicitação pode ter até 12 MB, exceto
/summary/, que aceita gravações de até 100 MB. - Envie um item, obtenha o objeto desse item. Envie vários, obtenha os resultados na ordem de entrada.
Loteamento
Não há um endpoint de lote separado: a lista é o lote. Até 10 documentos por solicitação para análise e avaliação, até 200 textos para tradução e detecção de idioma. Consulte Loteamento.
Limites de taxa
| Limite | Valor |
|---|---|
| Por API chave | 600 solicitações por minuto |
| Por IP endereço | 2.000 solicitações por minuto |
| Trabalho pesado (análise, avaliação, resumo) | 3 operações por vez, compartilhadas em todo o serviço; solicitações extras são enfileiradas |
| Tempo limite de solicitação | 300 segundos |
Consulte Limites de taxa.
Erros
Os erros são JSON e carregam o status HTTP que importa. Cada resposta carrega um cabeçalho X-Curriculo-Request-Id para citar ao suporte. Consulte Erros.
Gerenciando sua conta
Chaves, uso e cobrança são gerenciados no Console de Desenvolvedor . Sua chave API faz o trabalho de contratação. Ela deliberadamente não pode criar chaves ou alterar a cobrança, então uma chave vazada nunca pode escalar para controle de conta.
Próximos passos
- Inicialização Rápida: conta, chave, primeira ligação em três etapas.
- Processamento em segundo plano e callbacks: trabalho longo sem manter uma conexão aberta.
- SDKs de cliente: gera um cliente tipado a partir da especificação OpenAPI .
- API referência: todos os campos para cada operação.
Updated