CVReader API

Mise à jour et suppression d'un CV analysé

Met à jour les données d'un CV existant.

Supprime un CV analysé.

Uploads a job description file (PDF, DOCX, etc.) and returns a structured Job object. The file is parsed server-side and the result is persisted and linked to the authenticated user.

Headers

Authorization: ApiKey YOUR_API_KEY
Content-Type: multipart/form-data

Request body multipart/form-data

Request example

curl -X POST "https://cvreader.fr/api/job/parse/api-key" \
  -H "Authorization: ApiKey YOUR_API_KEY" \
  -F "file=@/path/to/job_description.pdf"

Response 200 OK

{
  "id": "d4c7a1e2-0f3b-4c8d-9e1f-000000000001",
  "title": "Senior Software Engineer",
  "description": "We are looking for...",
  "profile": "Experienced developer with leadership skills",
  "experience": "5+ years",
  "education": "Bachelor's degree",
  "skills": "[\"Java\",\"Spring Boot\",\"Docker\"]",
  "company": "TechCorp",
  "country": "FR",
  "city": "Paris"
}

Error responses

Parses a raw job description string and returns a structured DTO without creating a file upload. The body can be a plain JSON string, a quoted string, or a JSON object with a description, job_description, or text field — the API extracts the value automatically.

Headers

Authorization: ApiKey YOUR_API_KEY
Content-Type: application/json

Request body application/json

Send the job description as a JSON string, a raw string, or an object with a recognized field:

// Option A — plain JSON string
"We are looking for a Senior React Developer with 5+ years..."

// Option B — object with recognized field
{ "description": "We are looking for a Senior React Developer..." }

Request example

curl -X POST "https://cvreader.fr/api/job/parse/text/api-key" \
  -H "Authorization: ApiKey YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '"We are looking for a Senior React Developer with 5+ years of experience..."'

Response 200 OK

{
  "jobTitle": "Senior React Developer",
  "jobDescription": "We are looking for a Senior React Developer...",
  "profileRecherche": "Experienced frontend engineer",
  "experienceRequired": "5+ years",
  "educationLevel": "Bachelor's degree",
  "skills": ["React", "TypeScript", "Node.js", "GraphQL"]
}

Error responses

Creates a new job record linked to the API key owner. The payload shape is the same as the authenticated frontend endpoint. Use this to push jobs from your own ATS or data pipeline.

Request body application/json

Request example

curl -X POST "https://cvreader.fr/api/jobs/api-key" \
  -H "Authorization: ApiKey YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Senior Java Developer",
    "reference": "JOB-2026-001",
    "description": "We are looking for a Senior Java Developer...",
    "profile": "Experienced backend engineer",
    "experience": "5+ years",
    "education": "Bachelor'"'"'s degree",
    "skills": "[\"Java\",\"Spring Boot\",\"Docker\"]",
    "company": "TechCorp",
    "country": "FR",
    "city": "Paris",
    "status": "ACTIVE"
  }'

Response 200 OK

Returns the created Job object (same shape as the parse file response).

{
  "id": "d4c7a1e2-0f3b-4c8d-9e1f-000000000001",
  "title": "Senior Java Developer",
  "reference": "JOB-2026-001",
  "status": "ACTIVE",
  "company": "TechCorp",
  "country": "FR",
  "city": "Paris"
}

Error responses

Returns a paginated list of jobs belonging to the API key owner. Supports the same filtering options as the authenticated frontend list endpoint.

Query parameters

Request example

# All active jobs, page 0, 10 per page
curl "https://cvreader.fr/api/jobs/api-key/my?page=0&size=10&status=ACTIVE" \
  -H "Authorization: ApiKey YOUR_API_KEY"

Response 200 OK

Paginated response — standard Spring Page structure:

{
  "content": [
    { "id": "d4c7a1e2-...", "title": "Senior Java Developer", "status": "ACTIVE", ... }
  ],
  "totalElements": 42,
  "totalPages": 5,
  "number": 0,
  "size": 10
}

Error responses

Retrieves a single job by ID. Ownership is enforced — only jobs belonging to the authenticated API key owner are returned.

Path parameters

Request example

JOB_ID="d4c7a1e2-0f3b-4c8d-9e1f-000000000001"
curl "https://cvreader.fr/api/jobs/api-key/my/${JOB_ID}" \
  -H "Authorization: ApiKey YOUR_API_KEY"

Response 200 OK

Returns the full Job object.

Error responses

Replaces an existing job's data. The payload shape is the same as POST /api/jobs/api-key. Only fields present in the body are applied — omit fields you do not wish to change. Ownership is enforced.

Path parameters

Request body application/json

Request example

JOB_ID="d4c7a1e2-0f3b-4c8d-9e1f-000000000001"
curl -X PUT "https://cvreader.fr/api/jobs/api-key/my/${JOB_ID}" \
  -H "Authorization: ApiKey YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Lead Java Developer",
    "status": "ACTIVE",
    "city": "Lyon"
  }'

Response 200 OK

Returns the updated Job object.

Error responses

Replaces the authenticated user's resume settings and immediately regenerates canvas preview images. Returns the updated settings payload including refreshed canvas pages — ideal for updating the preview UI instantly after a settings change.

Request body application/json

Request example

curl -X PUT "https://cvreader.fr/api/resume-settings/api-key/update-with-canvas" \
  -H "Authorization: ApiKey YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "layout": "modern",
    "fontStyle": "Calibri",
    "fontSize": 11,
    "lineHeight": 1.35,
    "marginTop": 20,
    "marginBottom": 18,
    "marginX": 18,
    "sectionSpacing": 10,
    "agencyName": "Acme Recruiting",
    "agencyWebsite": "https://acme.example"
  }'

Response 200 OK

Returns a ResumeSettingsResponseDto JSON object:

Response example

{
  "id": "a3f4e2b1-0c91-4d2e-bc57-7f3a6e9d0012",
  "layout": "modern",
  "settings": {
    "fontStyle": "Calibri",
    "fontSize": 11,
    "lineHeight": 1.35,
    "marginTop": 20,
    "marginBottom": 18,
    "marginX": 18,
    "sectionSpacing": 10,
    "agencyName": "Acme Recruiting",
    "agencyWebsite": "https://acme.example"
  },
  "privacy": {
    "hidePhoto": false,
    "hideEmail": false,
    "hidePhone": false,
    "hideName": false
  },
  "canvas_page_count": 2,
  "canvas_pages": [
    { "index": 0, "url": "https://cdn.cvreader.fr/canvas/page_0.png" },
    { "index": 1, "url": "https://cdn.cvreader.fr/canvas/page_1.png" }
  ]
}

Error responses

Generates a PDF for the given resumeId using the current settings of the ApiKey owner. Candidate ownership is enforced — the resume must belong to the authenticated user. Returns the PDF as binary bytes with Content-Type: application/pdf.

Path parameters

Request example

# Replace RESUME_ID with a valid UUID
curl -X POST \
  "https://cvreader.fr/api/resume-settings/api-key/resumes/RESUME_ID/generate-pdf" \
  -H "Authorization: ApiKey YOUR_API_KEY" \
  --output resume.pdf

Response 200 OK

Error responses

Synchronously generates up to 10 PDFs in a single blocking request. All PDFs are ready when the response arrives — download URLs are included directly in the body. For larger batches (1–500) use the async webhook endpoint below.

Request body application/json

Request example

curl -X POST "https://cvreader.fr/api/resume-settings/v1/generate-pdf" \
  -H "Authorization: ApiKey YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '["9f6ad665-25ce-4107-8ec5-b2a2fba572cc", "a1b2c3d4-5678-90ab-cdef-000000000001"]'

Response 200 OK

{
  "jobId": "b72e9a01-3f4c-4e12-9a1d-000000000001",
  "status": "COMPLETED",
  "progress": "100%",
  "results": [
    {
      "resumeId": "9f6ad665-25ce-4107-8ec5-b2a2fba572cc",
      "downloadUrl": "https://cdn.cvreader.fr/pdfs/resume_9f6ad665.pdf",
      "generatedAt": "2026-05-14T10:00:00Z"
    }
  ]
}

Error responses

Enqueues a large PDF batch for asynchronous processing. Returns immediately with a 202 Accepted response containing a job ID and status URL. Results are pushed to your configured webhook URL once processing completes. Requires a webhook configured with pdfGenerated=true.

Request body application/json

Request example

curl -X POST "https://cvreader.fr/api/webhook/generate-pdfs" \
  -H "Authorization: ApiKey YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '["<uuid-1>", "<uuid-2>", ..., "<uuid-50>"]'

Response 202 Accepted

{
  "jobId": "c8a12f44-0000-0000-0000-000000000002",
  "status": "QUEUED",
  "statusUrl": "/api/webhook/generate-pdfs/c8a12f44-0000-0000-0000-000000000002",
  "message": "Processing started. Results will be sent to your webhook URL.",
  "webhookSecurity": {
    "algorithm": "HmacSHA256",
    "signatureHeader": "X-Webhook-Signature",
    "timestampHeader": "X-Webhook-Timestamp",
    "signedPayload": "<timestamp>.<raw-json-body>"
  }
}

Error responses

Polls the status of an asynchronous PDF generation job. Returns per-resume processing results and webhook delivery attempts. Poll periodically until status is "COMPLETED".

Path parameters

Request example

JOB_ID="c8a12f44-0000-0000-0000-000000000002"
curl "https://cvreader.fr/api/webhook/generate-pdfs/${JOB_ID}" \
  -H "Authorization: ApiKey YOUR_API_KEY"

Response 200 OK

{
  "jobId": "c8a12f44-0000-0000-0000-000000000002",
  "status": "PROCESSING",
  "total": 25,
  "processed": 12,
  "results": [
    { "resumeId": "9f6ad665-...", "processed": true,  "downloadUrl": "https://cdn.cvreader.fr/pdfs/...", "generatedAt": "2026-05-14T10:02:00Z" },
    { "resumeId": "a1b2c3d4-...", "processed": false, "downloadUrl": null, "generatedAt": null }
  ],
  "deliveries": [
    {
      "deliveryId": "d1e2f3a4-...",
      "type": "PDF_GENERATED",
      "delivered": false,
      "attemptCount": 1,
      "lastAttempt": "2026-05-14T10:01:00Z",
      "nextAttempt": "2026-05-14T10:06:00Z",
      "responseStatusCode": 500,
      "responseBody": "Internal Server Error",
      "errorMessage": "Connection refused"
    }
  ]
}

Error responses

Configurez les règles d'anonymisation dans votre espace abonné ("Paramètres du CV").

Request body application/json — array of resume UUIDs

[
  "resume-data-uuid-1",
  "a10288d7-b4ad-4181-8a45-2b7af9671b7c"
]

Request example

curl -X POST "https://cvreader.fr/api/resume-settings/format" \
  -H "Authorization: ApiKey YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '["resume-data-uuid-1", "a10288d7-b4ad-4181-8a45-2b7af9671b7c"]'

Les CV générés sont livrés par webhook ou email avec un lien de téléchargement.