REST API Reference

The complete REST API reference for RESTume. 76 endpoints organized across 8 categories — from public profile access and AI chat to authenticated profile management, admin tooling, and admin blog publishing.

Base URL

Authentication Model

Bearer JWT

Used for account lifecycle flows, admin operations, and interactive owner sessions. The CLI stores this as a session and no longer auto-creates API keys during login.

Header: Authorization: Bearer <token>

API Key

Used for authenticated owner APIs under /v1/me/* when you are automating with a dedicated API key. Keys are created explicitly and shown only once.

Header: X-API-Key: rst_...

Category Pages

Auth & Account

12 endpoints

Registration, login, email verification, Google sign-in, password recovery, API-key lifecycle, and account state.

Public API

7 endpoints

Read-only profile, skills, experience, education, projects, certifications, and full structured resume access.

AI

1 endpoint

Grounded natural-language Q&A against a professional profile with deterministic answers, evidence types, and answer-state metadata.

Owner API

41 endpoints

Authenticated owner operations for profile CRUD, themes, layout, insights, transcripts, exports, billing, security log, and resume maintenance.

Admin API

12 endpoints

Operator KPI snapshots, support search/detail, manual entitlement grants and revokes, controlled re-embedding, and admin blog publishing/import workflows.

Platform

3 endpoints

Server capabilities discovery for the CLI, waitlist capture, and health checks. Includes notes on the intentionally undocumented internal Stripe webhook.

Portal Notes

3

Use the category pages for stable counts and curated guidance. Use OpenAPI or ReDoc when you need raw schema detail.

For terminal workflows, the CLI docs mirror the canonical command names and machine-readable automation features now supported by restume-cli.

Also available: /redoc · /openapi.json · MCP recruiting docs