Skip to content
CurriculoCurriculo DocsDocs
API referenceConsole

Quickstart

On this page

Go from sign-up to a working API call in three steps. No sales call is needed to begin.

How do I make my first Curriculo API call?

Sign in at console.curriculo.me to create an account and receive the $5.00 free credit. Create an API key in the Console; it is shown once. Then send it as a bearer token to POST /parse/ with a CV attached. The response is the CV as structured JSON, and the call shows up in Console usage.

1. Create an account

Sign in at console.curriculo.me. Your account and its API identity are provisioned on first sign-in, and a one-time $5.00 free credit is added.

Until provisioning completes, keys can be issued but cannot serve traffic: calls return 403 with "Account provisioning incomplete".

2. Create an API key

In the Console, open API keys and choose Create API key. You give the key a name and an optional expiry. The key looks like key_<id>_<secret> and is shown once. Only its prefix and a hash are stored, so it cannot be recovered later. Store it somewhere safe.

A new key works immediately for every operation. There is nothing to enable per capability.

Never commit a key to source control or paste it into an untrusted client. If a key is lost or exposed, revoke it in the Console (revocation is immediate) and create a new one.

3. Call an endpoint

Send the key as a bearer token. Every processed call is visible in Console → Usage.

Parse a CV into structured JSON:

# POST /parse/ (multipart, one document or up to 10)
curl -X POST https://api.curriculo.me/public/parse/ \
  -H 'Authorization: Bearer key_abc123_yoursecret' \
  -F 'files=@/path/to/candidate.pdf'

Response (single document):

{
  "name": "Jordan Rivera",
  "title": "Lead Software Engineer",
  "email": "jordan.rivera@example.com",
  "experience": [ … ],
  "technical_skills": [ … ]
}

This call costs $0.01, drawn from your free credit. See Pricing and billing.

CV parsing can take up to 90 seconds per document. Set your HTTP client timeout above five minutes, because a 30-second timeout will abandon calls that would have succeeded. For backlogs, use background processing.

Try it without code

The synchronous operations are runnable from the Console's documentation page: paste your key, attach a real CV and read the response. To use Postman, import a cURL request copied from the Console's documentation page.

Next steps

Was this page helpful?

Updated