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 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.

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

post

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

Authorizations

Body

filestring · binaryrequired

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://app.cvtoblind.com/api/v1/convert' \
  --header 'Authorization: Bearer {access token}' \
  --header 'Content-Type: multipart/form-data' \
  --form 'file=text'

200

400

401

500

200

{
  "profileId": "text"
}

ID of the created profile

Get profiles

get

Returns a paginated list of profiles

Authorizations

Query parameters

pageinteger · default: 1

pageSizeinteger · default: 10

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://app.cvtoblind.com/api/v1/profiles' \
  --header 'Authorization: Bearer {access token}'

200

400

401

500

200

{
  "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"
        ],
        "category_tech": {
          "ANY_ADDITIONAL_PROPERTY": [
            "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"
        },
        "custom_fields": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        }
      }
    }
  ],
  "metadata": {
    "total": 0,
    "page": 1,
    "pageSize": 10,
    "totalPages": 0
  }
}

A paginated list of profiles

Get profile by ID

get

Returns a single profile

Authorizations

Path parameters

profileIdstringrequired

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://app.cvtoblind.com/api/v1/profiles/{profileId}' \
  --header 'Authorization: Bearer {access token}'

200

404

500

200

{
  "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"
    ],
    "category_tech": {
      "ANY_ADDITIONAL_PROPERTY": [
        "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"
    },
    "custom_fields": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  }
}

Profile details

Render profile document

get

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

Authorizations

Path parameters

profileIdstringrequired

Query parameters

templateIdstring

fileTypestring · enumrequired

Options: pdf, docx

Responses

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

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://app.cvtoblind.com/api/v1/profiles/{profileId}/render?fileType=pdf' \
  --header 'Authorization: Bearer {access token}'

200

400

404

500

200

application/pdf

application/vnd.openxmlformats-officedocument.wordprocessingml.document

application/pdf

text

Rendered profile document

Delete profile by ID

delete

Authorizations

Path parameters

profileIdstringrequired

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://app.cvtoblind.com/api/v1/profiles/{profileId}' \
  --header 'Authorization: Bearer {access token}'

204

401

404

500

204

No body

Profile deleted