API reference
Generated from the same OpenAPI document the API serves at /openapi.json and RapidAPI imports to build the listing.
Endpoints
POST /v1/parse
Accepts a JSON body with a text field, a multipart form with a file part, or the file bytes as the raw request body. PDF and DOCX are detected from the bytes, not from the Content-Type header.
| Status | Meaning |
|---|
200 | The parsed resume. |
400 | The body carried no resume. |
403 | Not called through RapidAPI. |
413 | Document larger than the limit. |
415 | File type cannot be read. |
422 | File unreadable, or the document is not a resume. |
503 | Model upstream unavailable. Retry after the Retry-After delay. |
GET /v1/health
Liveness and the active model
| Status | Meaning |
|---|
200 | Service is up. |
Schemas
A nullable field is null whenever the resume does not state it. It is never an empty string and never the word "null".
Resume
WorkEntry
EducationEntry
ParseResponse
Error
Date format
Every date field — start_date, end_date, a certification date — is one of exactly three things:
| Value | Means | Example in the CV |
|---|
"2022-03" | Year and month | March 2022, Mar '22, 03/2022 |
"2016" | Year only; the CV gave no month | 2014 – 2016 |
null | The CV did not state it, or the role is current | Present, Current, blank |
Anything the model returns that is not one of those is dropped rather than passed through, so sorting by start_date is always a string comparison.