API
The API allows you to integrate the core CVtoBlind functionality within your app.
Last updated
The API allows you to integrate the core CVtoBlind functionality within your app.
Last updated
All endpoints use the mechanism. You can create a new API Key at .
In order to ingest a new profile into CVtoBlind, you need to upload a CV file to the #api-v1-convert endpoint. The endpoint returns the ID of created profile.
Once you have that ID, you can retrieve the profile with #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.
Once the processing is completed, the data
field contains the entire CV data 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.
In order to export profile data, you can either access the raw files directly as JSON via #api-v1-profiles-profileid or render the profile in a given template with #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 . You can copy the templateId
by clicking the ID column value.
Renders a profile document in the specified format (pdf or docx)