Skip to main content
GET
Get conversation analysis PDF
GET /interviews/{id}/analysis-pdf is a permanent alias of this endpoint and keeps working unchanged, with the same scopes and the same response. See Resource names.
Returns the Base64-encoded PDF report of a conversation’s analysis.

Overview

The PDF comes back as a Base64-encoded string. It is kept off the conversation resource itself so that GET /conversations/:id stays lightweight — fetch it here when you need the formatted report to download, forward or archive.

Use Cases

  • Download the report: the formatted analysis of one conversation
  • Forward it: email or share it with whoever needs to read it
  • Archival: store it alongside your own records

Prerequisites

The conversation must have a completed analysis for a PDF to exist. While one is still in progress, or if it has no analysis, this endpoint returns 404.

Response

The analysisPdfBase64 field contains the full PDF document encoded as a Base64 string. To reconstruct the PDF file, decode the Base64 string into binary data.

Example Usage

Error Scenarios

  • 404 Not Found: the conversation does not exist, has been deleted, or has no analysis yet
  • 403 Forbidden: the conversation belongs to a different company
The analysis PDF is also included in the analysis.completed webhook payload as the analysisPdfBase64 field, so you may not need this endpoint if you are already consuming webhooks.

Get Conversation

Read the whole conversation, analysis included

Webhooks Guide

Receive analysis PDF automatically via webhooks

Authorizations

Authorization
string
header
required

API key for authentication using Bearer scheme

Path Parameters

id
string<uuid>
required

Query Parameters

companyId
string

Required for ATS API keys to specify which company to access. Ignored for standard company API keys.

Response

200 - application/json
analysisPdfBase64
string
required

Base64-encoded PDF report of the conversation's analysis

Example:

"JVBERi0xLjQKMSAwIG9iai..."