> For the complete documentation index, see [llms.txt](https://api.pdf.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://api.pdf.ai/v1/ai-tools/resume-scanner.md).

# Resume scanner

You can get the overview of a resume along with important questions to assess candidates using the `docId` of the PDF. To get `docId` [<mark style="color:blue;">upload</mark>](/v1/upload-pdf.md) the PDF first.

{% hint style="warning" %}
The resume result will not be saved as a Chat. To save your chat history use [<mark style="color:blue;">chat</mark>](/v1/chat-with-pdf.md) API
{% endhint %}

## Invoice

## Resume scanner

<mark style="color:green;">`POST`</mark> `https://pdf.ai/api/v1/resume`

Assess candidate resume using their `docId`

#### Headers

| Name                                        | Type   | Description |
| ------------------------------------------- | ------ | ----------- |
| X-API-Key<mark style="color:red;">\*</mark> | string | \<API-key>  |

#### Request Body

| Name                                    | Type    | Description                                                                                                                              |
| --------------------------------------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
| docId<mark style="color:red;">\*</mark> | string  | Document ID obtained after uploading PDF                                                                                                 |
| message                                 | string  | You can add a specific question or leave it empty                                                                                        |
| use\_gpt4                               | boolean | <p>To get response using GPT-4 model. <br>Default model: gpt-4-turbo</p>                                                                 |
| model                                   | string  | <p>To choose GPT-4 model<br>"gpt-4o" or "gpt-4-turbo"(default). gpt-4o message costs 2 credits, gpt-4-turbo message costs 4 credits.</p> |

{% tabs %}
{% tab title="200 Resume overview/response to the query" %}

```json
{
    "content": "This is the overview of the candidate's resume"
}
```

{% endtab %}

{% tab title="401 Invalid API key" %}

```json
{
    "error": "Invalid API key"
}
```

{% endtab %}

{% tab title="400: Bad Request No API key or docId or message is present" %}

```json
{
    "error": "No API key present"
}
```

{% endtab %}
{% endtabs %}