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

Upload and convert CV

Max file size: 10MB. Accepted file types: .pdf, .docx, .jpg, .png

POSThttps://app.cvtoblind.com/api/v1/convert

Authorization

bearerAuth

Body

multipart/form-data

file*string (binary)

Response

200400401500

ID of the created profile

Body

application/json

profileIdstring

Request

JavaScriptCurlPython

const response = await fetch('https://app.cvtoblind.com/api/v1/convert', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer {access token}",
      "Content-Type": "multipart/form-data"
    },
    body: JSON.stringify({
      "file": "binary"
    }),
});
const data = await response.json();

Response

200400401500

{
  "profileId": "text"
}

Get profiles

Returns a paginated list of profiles

GEThttps://app.cvtoblind.com/api/v1/profiles

Authorization

bearerAuth

Query parameters

Response

200400401500

A paginated list of profiles

Body

application/json

dataarray of ProfileDtoV1 (object)

metadataobject

Paging parameters

Request

JavaScriptCurlPython

const response = await fetch('https://app.cvtoblind.com/api/v1/profiles', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer {access token}"
    },
});
const data = await response.json();

Response

200400401500

{
  "data": [
    {
      "profileId": "text",
      "fileName": "text",
      "createdBy": "text",
      "status": "queued",
      "data": {
        "email": "text",
        "github": "text",
        "mobile": "text",
        "skills": [
          "text"
        ],
        "summary": "text",
        "linkedin": "text",
        "education": [
          {
            "major": "text",
            "start": "text",
            "degree": "text",
            "finish": "text",
            "faculty": "text",
            "university": "text"
          }
        ],
        "languages": [
          {
            "level": "text",
            "language": "text"
          }
        ],
        "last_name": "text",
        "main_role": "text",
        "experience": [
          {
            "to": "text",
            "from": "text",
            "roles": [
              "text"
            ],
            "company": "text",
            "project": "text",
            "location": "text",
            "technologies": [
              "text"
            ],
            "responsibilities": [
              "text"
            ]
          }
        ],
        "first_name": "text",
        "other_urls": [
          "text"
        ],
        "technologies": [
          "text"
        ],
        "certifications": [
          {
            "certificate": "text",
            "date": "text"
          }
        ],
        "physical_address": "text",
        "additional_information": "text",
        "hobby": [
          "text"
        ],
        "total_experience": "text",
        "detailed_address": {
          "country": "text",
          "city": "text",
          "postal_code": "text",
          "address": "text"
        }
      }
    }
  ],
  "metadata": {
    "total": 0,
    "page": 1,
    "pageSize": 10,
    "totalPages": 0
  }
}

Get profile by ID

Returns a single profile

GEThttps://app.cvtoblind.com/api/v1/profiles/{profileId}

Authorization

bearerAuth

Path parameters

profileId*string

Response

200404500

Profile details

Body

application/json

profileIdstring

fileNamestring

createdBystring

statusenum

The processing status

queuedprocessingcompletedcancelledfailed

dataCvData (object)

The complete CvData object. Please keep in mind that all of its props are in snake_case

Request

JavaScriptCurlPython

const response = await fetch('https://app.cvtoblind.com/api/v1/profiles/{profileId}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer {access token}"
    },
});
const data = await response.json();

Response

200404500

{
  "profileId": "text",
  "fileName": "text",
  "createdBy": "text",
  "status": "queued",
  "data": {
    "email": "text",
    "github": "text",
    "mobile": "text",
    "skills": [
      "text"
    ],
    "summary": "text",
    "linkedin": "text",
    "education": [
      {
        "major": "text",
        "start": "text",
        "degree": "text",
        "finish": "text",
        "faculty": "text",
        "university": "text"
      }
    ],
    "languages": [
      {
        "level": "text",
        "language": "text"
      }
    ],
    "last_name": "text",
    "main_role": "text",
    "experience": [
      {
        "to": "text",
        "from": "text",
        "roles": [
          "text"
        ],
        "company": "text",
        "project": "text",
        "location": "text",
        "technologies": [
          "text"
        ],
        "responsibilities": [
          "text"
        ]
      }
    ],
    "first_name": "text",
    "other_urls": [
      "text"
    ],
    "technologies": [
      "text"
    ],
    "certifications": [
      {
        "certificate": "text",
        "date": "text"
      }
    ],
    "physical_address": "text",
    "additional_information": "text",
    "hobby": [
      "text"
    ],
    "total_experience": "text",
    "detailed_address": {
      "country": "text",
      "city": "text",
      "postal_code": "text",
      "address": "text"
    }
  }
}

Render profile document

Renders a profile document in the specified format (pdf or docx)

GEThttps://app.cvtoblind.com/api/v1/profiles/{profileId}/render

Authorization

bearerAuth

Path parameters

profileId*string

Query parameters

Response

200400404500

Rendered profile document

Body

application/pdfapplication/vnd.openxmlformats-officedocument.wordprocessingml.document

string (binary)

Request

JavaScriptCurlPython

const response = await fetch('https://app.cvtoblind.com/api/v1/profiles/{profileId}/render?fileType=pdf', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer {access token}"
    },
});
const data = await response.json();

Response

200400404500

binary

Delete profile by ID

DELETEhttps://app.cvtoblind.com/api/v1/profiles/{profileId}

Authorization

bearerAuth

Path parameters

profileId*string

Response

204401404500

Profile deleted

Request

JavaScriptCurlPython

const response = await fetch('https://app.cvtoblind.com/api/v1/profiles/{profileId}', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer {access token}"
    },
});
const data = await response.json();

Response

401404500

{
  "error": {
    "message": "text",
    "code": "text"
  }
}