RemakeCV API introduction

#Base URL

https://app.remakecv.com/api/public/v1

All endpoint paths below are relative to this base URL.

#What can it do?

#The response envelope

Every successful response uses the same shape, so a client can parse them uniformly:

{
  "data": { },
  "pagination": null,
  "error": null
}

• data — the result. An object or an array, depending on the endpoint.
• pagination — populated on list endpoints, null elsewhere.
• error — always null on success.

Errors use a different envelope. See errors.

#Your first request

1. 1

   Check connectivity

   GET /health needs no authentication and returns {"status":"ok"}. If this fails, the problem is network-level rather than a credential problem.

   bash

   curl https://app.remakecv.com/api/public/v1/health

2. 2

   Authenticate

   Every other endpoint needs Authorization: Bearer <your-api-key>. See authentication.

3. 3

   List your templates

   A good first authenticated call — it confirms the key works and shows you the template IDs you will pass when processing.

   bash

   curl "https://app.remakecv.com/api/public/v1/templates?acting_user_email=consultant@agency.com" \
     -H "Authorization: Bearer $REMAKECV_API_KEY"

4. 4

   Process a CV

   POST /cvs/process with the file and the acting consultant's email. See process a CV.

#Things to know before you build

• The API extracts and stores; it does not render. download_url gives you the source CV as a PDF, not a document rendered into your template.
• acting_user_email applies to two endpoints only — POST /cvs/process and GET /templates.
• The default rate limit is 30 requests per minute per company, configurable. See rate limits.
• The default maximum file size is 10MB, configurable per company.
• Every response carries an X-Request-Id header, including /health and errors. Log it — it is what support needs to trace a specific call.
• One credit per CV processed, drawn from the same pool as the web app.

#Machine-readable specification

The OpenAPI 3.1 specification is published at /openapi/public-api.v1.yaml. Point your client generator or coding agent at it directly.