Quickstart

Draft

Get from zero to your first generated resume against the Resumez API.

1. Register an app

Create an OAuth client in the Developer Console. You'll receive a client_id and client_secret, and you'll set one or more redirect URIs.

2. Get an access token

Send your user through the OAuth authorization flow to obtain an access token scoped to the data you need. See the OAuth guide for the full flow.

Exchange an authorization code

curl https://api.resumez.ai/oauth/token \
  -d grant_type=authorization_code \
  -d code=$AUTH_CODE \
  -d client_id=$CLIENT_ID \
  -d client_secret=$CLIENT_SECRET \
  -d redirect_uri=$REDIRECT_URI

3. Read the canonical profile

The canonical career profile is the source of truth for every generated artifact.

GET /v1/profile

curl https://api.resumez.ai/v1/profile \
  -H "Authorization: Bearer $ACCESS_TOKEN"

4. Generate a resume

Generate a role-specific resume from the profile and a target job.

POST /v1/resumes/generate

curl https://api.resumez.ai/v1/resumes/generate \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "targetRole": "Senior Backend Engineer",
    "jobDescription": "We are hiring a backend engineer..."
  }'

Next: explore the API Reference or read the Guides.