Poll the status of an async conversation PDF export
Checks the state of a PDF export job that was created by GET /api/conversations/{id}/export?format=pdf.
/api/conversations/{id}/export/{jobId}/statusChecks the state of a PDF export job that was created by GET /api/conversations/{id}/export?format=pdf. While the job is still running, the endpoint returns 202 with the current state. When the job completes, it returns the generated PDF file as a binary application/pdf document. If the job fails, it returns a 500 response with the error message. Unknown job IDs return not found.
Endpoint requirements
- Credentials
- Use either
Bearer API keyorX-API-Key header. - Required scope
conversations:read- Module
- Automation & API module (
api_access) - Organization and site scope
- Requests can access only resources owned by the authenticated organization. The API does not reveal whether an identifier belongs to another organization or site.
- Retry behavior
- Safe read: You can safely retry this read-only request after a transport failure. It does not change resource state.
Path Parameters
Conversation for which the PDF export was requested. The identifier must reference a resource visible to the authenticated organization.
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$uuidPDF export job identifier.
1 <= lengthHeader Parameters
DA-4035: selects the active site (project) for project-scoped operations. Accepts a site UUID, or the literal all to aggregate across every accessible site on read-only aggregate routes (single-or-all-read). Mutations and single-site routes reject all. Path-owned project routes (/api/projects/{projectId}/…) resolve the site from the URL and ignore this header. Conflicting selectors across header/query/body/path return PROJECT_CONTEXT_CONFLICT (400); an archived site returns PROJECT_ARCHIVED (410).
Response Body
application/pdf
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
"<binary PDF data>"Request examples
curl
curl --request GET \
'https://api.convor.io/api/conversations/11111111-1111-4111-8111-111111111111/export/pdf-export-job-123/status' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer convor_sk_...'JavaScript
const response = await fetch("https://api.convor.io/api/conversations/11111111-1111-4111-8111-111111111111/export/pdf-export-job-123/status", {
method: "GET",
headers: {
"Accept": "application/json",
"Authorization": "Bearer convor_sk_..."
},
});
const contentType = response.headers.get("content-type") ?? "";
const data = response.status === 204
? null
: contentType.includes("json")
? await response.json()
: contentType.startsWith("text/")
? await response.text()
: await response.blob();
if (!response.ok) {
const message = typeof data === "object" && data !== null
&& "error" in data && typeof data.error === "object"
&& data.error !== null && "message" in data.error
? String(data.error.message)
: "Convor API request failed (" + response.status + ")";
throw new Error(message);
}
console.log(data);Was this page helpful?