API e integrações
Conecte o CVforge ao Claude Desktop, n8n, Cursor e às suas automações via API MCP. Upload de currículos, recuperação das otimizações, gestão do seu perfil — tudo acessível de forma programática.
Endpoint
api.cvforge.co/mcp
Protocolo
MCP · JSON-RPC 2.0
Transporte
HTTP POST
Auth
PAT ou OAuth2
1. Pré-requisitos
O acesso à API MCP está incluído no pacote Expert.
- Ter uma conta CVforge ativa com uma assinatura Expert em vigor.
- Criar um Personal Access Token (PAT) na página Configurações → API e integrações.
2. Autenticação
O CVforge oferece dois métodos de autenticação. Para a maioria das integrações pessoais (n8n, scripts, Claude Desktop), use um PAT. Para aplicações de terceiros, use o fluxo OAuth 2.0 Authorization Code + PKCE.
2.1 Personal Access Token (PAT)
Um PAT é um token opaco com o prefixo mcp_pat_. Ele é exibido uma única vez na criação — guarde-o com cuidado.
Uso em cada requisição:
Authorization: Bearer mcp_pat_XXXXXXXXXXXXXXXXXXXX2.2 OAuth 2.0 (Authorization Code + PKCE)
Para aplicações que atendem várias contas de usuário, use o fluxo OAuth 2.0 padrão.
| Endpoint | URL |
|---|---|
| Discovery | https://api.cvforge.co/.well-known/oauth-authorization-server |
| Authorization | https://api.cvforge.co/oauth/authorize |
| Token exchange | https://api.cvforge.co/oauth/token |
| Revogação | https://api.cvforge.co/oauth/revoke |
2.3 Scopes
| Scope | Descrição |
|---|---|
| read:profile | Ler o perfil, o plano e o saldo de créditos |
| read:cv | Listar, consultar e baixar currículos e gerações |
| write:cv | Fazer upload de currículos, enviar vagas e iniciar otimizações |
3. Fazer uma chamada MCP
A API MCP usa o protocolo JSON-RPC 2.0 sobre HTTP. Cada requisição é um POST para https://api.cvforge.co/mcp.
Formato de uma requisição
POST https://api.cvforge.co/mcp
Content-Type: application/json
Authorization: Bearer mcp_pat_XXXXXXXXXXXXXXXXXXXX
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "<nom_de_l_outil>",
"arguments": { /* paramètres de l'outil */ }
}
}Formato de uma resposta (sucesso)
{
"jsonrpc": "2.0",
"id": 1,
"result": {
"content": [
{
"type": "text",
"text": "{ ...données... }"
}
]
}
}Formato de uma resposta (erro)
{
"jsonrpc": "2.0",
"id": 1,
"error": {
"code": -32001,
"message": "Token invalide ou révoqué",
"data": { "error_code": "MCP_TOKEN_INVALID" }
}
}4. Ferramentas disponíveis
A API expõe 10 ferramentas. As ferramentas de leitura exigem read:profile ou read:cv. O upload, o envio de vagas e as otimizações exigem write:cv.
get_profileread:profileRetorna as informações da conta: nome, e-mail, plano de assinatura.
Exemplo de chamada
POST https://api.cvforge.co/mcp
Content-Type: application/json
Authorization: Bearer mcp_pat_XXXX
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": { "name": "get_profile", "arguments": {} }
}Resposta (trecho)
{
"id": "uuid",
"email": "alice@example.com",
"full_name": "Alice Martin",
"subscription_plan": "Expert",
"subscription_status": "active"
}get_creditsread:profileRetorna o saldo de créditos detalhado (assinatura, pago, gratuito).
Exemplo de chamada
POST https://api.cvforge.co/mcp
Content-Type: application/json
Authorization: Bearer mcp_pat_XXXX
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": { "name": "get_credits", "arguments": {} }
}Resposta (trecho)
{
"total": 7,
"subscription_credits": 5,
"paid_credits": 2,
"free_credits": 0
}list_cvsread:cvLista os perfis de currículo enviados (sem o conteúdo).
Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
| limit | integer? | Número máx. (padrão: 20, máx.: 50) |
| offset | integer? | Paginação (padrão: 0) |
Exemplo de chamada
POST https://api.cvforge.co/mcp
Content-Type: application/json
Authorization: Bearer mcp_pat_XXXX
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": { "name": "list_cvs", "arguments": { "limit": 10, "offset": 0 } }
}Resposta (trecho)
{
"cvs": [
{
"id": "uuid",
"original_filename": "CV_Alice_2026.pdf",
"created_at": "2026-04-10T14:30:00Z",
"generation_count": 3
}
],
"total": 1
}get_cvread:cvRetorna o conteúdo completo (texto extraído) de um currículo.
Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
| cv_id | string | UUID do perfil de currículo |
Exemplo de chamada
POST https://api.cvforge.co/mcp
Content-Type: application/json
Authorization: Bearer mcp_pat_XXXX
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": { "name": "get_cv", "arguments": { "cv_id": "uuid" } }
}Resposta (trecho)
{
"id": "uuid",
"original_filename": "CV_Alice_2026.pdf",
"extracted_text": "Alice Martin — Product Manager...",
"created_at": "2026-04-10T14:30:00Z"
}upload_cvwrite:cvFaz upload de um currículo em base64. Formatos aceitos: PDF, DOCX (máx. 10 MB). Retorna o cv_profile_id a usar com optimize_cv.
Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
| filename | string | Nome do arquivo (com extensão) |
| file_base64 | string | Conteúdo do arquivo codificado em base64 |
| mime_type | string | application/pdf | application/vnd.openxmlformats-officedocument.wordprocessingml.document |
Exemplo de chamada
POST https://api.cvforge.co/mcp
Content-Type: application/json
Authorization: Bearer mcp_pat_XXXX
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": { "name": "upload_cv", "arguments": {
"filename": "mon_cv.pdf",
"file_base64": "JVBERi0xLjQ...",
"mime_type": "application/pdf"
} }
}Resposta (trecho)
{
"cv_profile_id": "uuid",
"message": "CV uploaded and parsed successfully."
}submit_offerwrite:cvEnvia a URL de uma vaga (LinkedIn, Indeed, WTTJ, etc.) para scraping e armazenamento. Retorna o offer_id a usar com optimize_cv. Limite: 5 chamadas/min. Sites suportados: LinkedIn, Indeed, WTTJ, France Travail, HelloWork, APEC, Cadremploi, Glassdoor, Meteojob, LeBonCoin, JobTeaser, Collective Work.
Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
| offer_url | string | URL completa da vaga |
Exemplo de chamada
POST https://api.cvforge.co/mcp
Content-Type: application/json
Authorization: Bearer mcp_pat_XXXX
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": { "name": "submit_offer", "arguments": {
"offer_url": "https://www.linkedin.com/jobs/view/1234567890/"
} }
}Resposta (trecho)
{
"offer_id": "uuid",
"offer_url": "https://www.linkedin.com/jobs/view/1234567890/",
"job_title": "Product Manager Senior",
"company_name": "Acme Corp"
}optimize_cvwrite:cvInicia a otimização com IA de um currículo para uma vaga. Consome 1 crédito. A operação é assíncrona: use get_generation para acompanhar o progresso (pending → processing → completed/failed).
Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
| cv_profile_id | string | UUID do perfil de currículo (obtido via upload_cv ou list_cvs) |
| offer_id | string | UUID da vaga (obtido via submit_offer) |
Exemplo de chamada
POST https://api.cvforge.co/mcp
Content-Type: application/json
Authorization: Bearer mcp_pat_XXXX
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": { "name": "optimize_cv", "arguments": {
"cv_profile_id": "uuid-du-cv",
"offer_id": "uuid-de-l-offre"
} }
}Resposta (trecho)
{
"generation_id": "uuid",
"status": "processing",
"message": "CV optimization started"
}list_generationsread:cvLista os currículos otimizados gerados, com o status e as pontuações ATS.
Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
| limit | integer? | Número máx. (padrão: 20, máx.: 100) |
| offset | integer? | Paginação (padrão: 0) |
Exemplo de chamada
POST https://api.cvforge.co/mcp
Content-Type: application/json
Authorization: Bearer mcp_pat_XXXX
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": { "name": "list_generations", "arguments": { "limit": 5 } }
}Resposta (trecho)
{
"generations": [
{
"id": "uuid",
"cv_id": "uuid",
"job_title": "Product Manager Senior",
"ats_score": 87,
"status": "completed",
"created_at": "2026-04-11T09:00:00Z"
}
],
"total": 1
}get_generationread:cvRetorna o detalhe de uma geração: análise, texto otimizado, pontuação.
Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
| generation_id | string | UUID da geração |
Exemplo de chamada
POST https://api.cvforge.co/mcp
Content-Type: application/json
Authorization: Bearer mcp_pat_XXXX
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": { "name": "get_generation", "arguments": { "generation_id": "uuid" } }
}Resposta (trecho)
{
"id": "uuid",
"job_title": "Product Manager Senior",
"ats_score": 87,
"optimized_text": "Alice Martin — Product Manager Senior...",
"analysis": { "missing_keywords": ["OKR", "roadmap"], "strengths": [...] },
"status": "completed",
"created_at": "2026-04-11T09:00:00Z"
}download_generationread:cvBaixa o PDF final de uma geração em base64.
Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
| generation_id | string | UUID da geração |
Exemplo de chamada
POST https://api.cvforge.co/mcp
Content-Type: application/json
Authorization: Bearer mcp_pat_XXXX
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": { "name": "download_generation", "arguments": { "generation_id": "uuid" } }
}Resposta (trecho)
{
"filename": "CV_Alice_PM_Senior.pdf",
"content_b64": "JVBERi0xLjQ...",
"mime_type": "application/pdf",
"size_bytes": 124580
}5. Exemplos de integração
5.1 Fluxo completo: upload → vaga → otimização → download
Exemplo em Python ilustrando o percurso completo em 4 etapas.
import requests, base64, time, json, os
PAT = os.environ["CVFORGE_PAT"]
MCP = "https://api.cvforge.co/mcp"
HEADERS = {"Content-Type": "application/json", "Authorization": f"Bearer {PAT}"}
def mcp(tool: str, args: dict = {}):
r = requests.post(MCP, json={
"jsonrpc": "2.0", "id": 1, "method": "tools/call",
"params": {"name": tool, "arguments": args}
}, headers=HEADERS, timeout=60)
r.raise_for_status()
data = r.json()
if "error" in data:
raise RuntimeError(data["error"]["message"])
return json.loads(data["result"]["content"][0]["text"])
# Étape 1 — Upload du CV
with open("mon_cv.pdf", "rb") as f:
b64 = base64.b64encode(f.read()).decode()
cv = mcp("upload_cv", {
"filename": "mon_cv.pdf",
"file_base64": b64,
"mime_type": "application/pdf",
})
cv_id = cv["cv_profile_id"]
print(f"CV uploadé : {cv_id}")
# Étape 2 — Soumission de l'offre
offer = mcp("submit_offer", {
"offer_url": "https://www.linkedin.com/jobs/view/1234567890/"
})
offer_id = offer["offer_id"]
print(f"Offre : {offer['job_title']} @ {offer['company_name']} ({offer_id})")
# Étape 3 — Lancement de l'optimisation (1 crédit consommé)
gen = mcp("optimize_cv", {"cv_profile_id": cv_id, "offer_id": offer_id})
gen_id = gen["generation_id"]
print(f"Génération démarrée : {gen_id}")
# Étape 4 — Attente + téléchargement
for _ in range(20):
time.sleep(5)
details = mcp("get_generation", {"generation_id": gen_id})
print(f" statut : {details['status']}")
if details["status"] == "completed":
dl = mcp("download_generation", {"generation_id": gen_id})
print(f"Téléchargement : {dl['download_url']} (valide 15 min)")
break
if details["status"] == "failed":
raise RuntimeError("Optimisation échouée")5.2 curl
# Remplacez YOUR_PAT par votre Personal Access Token
export PAT="mcp_pat_XXXXXXXXXXXXXXXXXXXX"
# Récupérer le profil
curl -X POST https://api.cvforge.co/mcp \
-H "Content-Type: application/json" \
-H "Authorization: Bearer $PAT" \
-d '{"jsonrpc":"2.0","id":1,"method":"tools/call","params":{"name":"get_profile","arguments":{}}}'
# Vérifier le solde de crédits
curl -X POST https://api.cvforge.co/mcp \
-H "Content-Type: application/json" \
-H "Authorization: Bearer $PAT" \
-d '{"jsonrpc":"2.0","id":2,"method":"tools/call","params":{"name":"get_credits","arguments":{}}}'5.3 Claude Desktop / Claude.ai
Adicione o bloco a seguir ao seu arquivo de configuração do Claude Desktop (~/Library/Application Support/Claude/claude_desktop_config.json no macOS).
{
"mcpServers": {
"cvforge": {
"command": "npx",
"args": [
"-y",
"mcp-remote",
"https://api.cvforge.co/mcp",
"--header",
"Authorization: Bearer mcp_pat_XXXXXXXXXXXXXXXXXXXX"
]
}
}
}Depois de reiniciar, o Claude terá acesso às ferramentas do CVforge diretamente na conversa. Diga, por exemplo: "Liste meus currículos no CVforge" ou "Faça upload do arquivo MeuCV.pdf no CVforge".
5.4 n8n — nó HTTP Request
No n8n, crie um nó HTTP Request com os seguintes parâmetros:
| Method | POST |
| URL | https://api.cvforge.co/mcp |
| Authentication | Header Auth · Name: Authorization · Value: Bearer mcp_pat_XXX |
| Content-Type | application/json |
| Body (JSON) | { "jsonrpc": "2.0", "id": 1, "method": "tools/call", "params": { "name": "list_cvs", "arguments": {} } } |
O resultado JSON fica disponível no nó seguinte via {{ $json.result.content[0].text }}. Faça o parse com um nó Set ou Function para extrair os campos.
5.5 Cursor / Windsurf
Em .cursor/mcp.json (ou o equivalente para o Windsurf):
{
"mcpServers": {
"cvforge": {
"url": "https://api.cvforge.co/mcp",
"headers": {
"Authorization": "Bearer mcp_pat_XXXXXXXXXXXXXXXXXXXX"
}
}
}
}6. Códigos de erro
| error_code | código JSON-RPC | Descrição |
|---|---|---|
| MCP_TOKEN_INVALID | -32001 | Token ausente, malformado ou revogado |
| MCP_TOKEN_EXPIRED | -32001 | Token expirado — gere um novo nas Configurações |
| MCP_SUBSCRIPTION_REQUIRED | -32003 | Plano Expert obrigatório — veja /pricing |
| MCP_SCOPE_INSUFFICIENT | -32004 | O token não possui o scope necessário |
| MCP_TOOL_NOT_FOUND | -32601 | Ferramenta desconhecida |
| MCP_INVALID_PARAMS | -32602 | Parâmetros inválidos ou ausentes |
| MCP_INTERNAL_ERROR | -32603 | Erro interno — tente novamente ou contate o suporte |
| PARSE_ERROR | -32700 | JSON inválido na requisição |
| INVALID_REQUEST | -32600 | Estrutura JSON-RPC inválida |
7. Limites e boas práticas
Rate limiting
| Limite | Valor |
|---|---|
| Requisições por minuto (por IP) | 60 req/min |
| submit_offer (por usuário) | 5 req/min |
| Tamanho máx. de um arquivo enviado | 10 MB |
| Formatos de currículo aceitos | PDF, DOCX |
| Tokens PAT ativos simultaneamente | 10 por conta |
Em caso de estouro do limite, a API retorna um HTTP 429 com o cabeçalho Retry-After. Implemente um backoff exponencial nas suas automações.
Boas práticas
- Crie um token por integração (um para o n8n, um para o Claude Desktop…) — assim você facilita a revogação individual sem impactar as demais.
- Conceda apenas os scopes necessários a cada token.
- Armazene os tokens em variáveis de ambiente ou em um gerenciador de segredos, nunca fixos no código.
- Revogue imediatamente qualquer token comprometido na página Configurações.
- O endpoint MCP suporta CORS aberto — lembre-se de validar a origem no lado do servidor nas suas próprias integrações.
Descobribilidade
O CVforge publica um manifesto MCP legível pelos LLMs e mecanismos de busca:
- /.well-known/mcp.json — manifesto MCP
- /.well-known/oauth-authorization-server — descoberta OAuth2 (RFC 8414)
- /llms.txt — contexto MCP para os LLMs
Pronto para integrar o CVforge?
Crie seu primeiro token em 30 segundos nas Configurações.