API
The API allows you to integrate the core CvToBlind functionality within your app.
Authentication
All endpoints use the Bearer Authentication mechanism. You can create a new API Key at Settings / Access Keys.
Usage guide
Creating a profile
In order to ingest a new profile into CvToBlind, you need to upload a CV file to the POST /api/v1/convert endpoint. The endpoint returns the ID of created profile.
Profile processing
Once you have that ID, you can retrieve the profile with GET /api/v1/profiles/{profileId}. The profile has a status
field, which initially will be set to queued
. Within 15-30 seconds the profile will be processed & the data
field will be populated.
Profile contents
Once the processing is completed, the data
field contains the entire CvData object. This object contains all the data we've extracted from the CV file. It can also be modified with the Profile Editor inside the app, but not via the API.
Exporting profiles
In order to export profile data, you can either access the raw files directly as JSON via GET /api/v1/profiles/{profileId} or render the profile in a given template with GET /api/v1/profiles/{profileId}/render. The available options are docx
and pdf.
If you don't specify a templateId
parameter, the default template assigned to your account will be used. In order to lookup available templates, see Templates. You can copy the templateId
by clicking the ID column value.
OpenAI Spec
Last updated