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.

GET/api/conversations/{id}/export/{jobId}/status

Checks 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. If the job fails, it returns a 500 response with the error message. Unknown job IDs return not found.

pages.docs.apiRequirements.title

pages.docs.apiRequirements.credentials: pages.docs.apiRequirements.credentialsIntro pages.docs.apiRequirements.bearerApiKey pages.docs.apiRequirements.or pages.docs.apiRequirements.apiKeyHeader.
pages.docs.apiRequirements.scope: conversations:read
pages.docs.apiRequirements.module: pages.docs.apiRequirements.automationApiModule (automation_api)
pages.docs.apiRequirements.tenantScope: All resources and identifiers are isolated to the authenticated organization. Identifiers owned by another organization or site are not disclosed.
pages.docs.apiRequirements.retryBehavior: pages.docs.apiRequirements.retryModes.safeRead: This read-only operation can be retried after transport failures without changing resource state.

Path Parameters

id*string

Conversation for which the PDF export was requested. The identifier must reference a resource visible to the authenticated organization.

jobId*string

PDF export job identifier.

Response Body

`application/pdf`

`application/json`

"string"

{
  "state": "waiting",
  "jobId": "pdf-export-job-123"
}

{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {
      "property1": "string",
      "property2": "string"
    },
    "details": {},
    "correlationId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {
      "property1": "string",
      "property2": "string"
    },
    "details": {},
    "correlationId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {
      "property1": "string",
      "property2": "string"
    },
    "details": {},
    "correlationId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {
      "property1": "string",
      "property2": "string"
    },
    "details": {},
    "correlationId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {
      "property1": "string",
      "property2": "string"
    },
    "details": {},
    "correlationId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {
      "property1": "string",
      "property2": "string"
    },
    "details": {},
    "correlationId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {
      "property1": "string",
      "property2": "string"
    },
    "details": {},
    "correlationId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {
      "property1": "string",
      "property2": "string"
    },
    "details": {},
    "correlationId": "string"
  }
}

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?

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.

GET/api/conversations/{id}/export/{jobId}/status

pages.docs.apiRequirements.title

pages.docs.apiRequirements.credentials: pages.docs.apiRequirements.credentialsIntro pages.docs.apiRequirements.bearerApiKey pages.docs.apiRequirements.or pages.docs.apiRequirements.apiKeyHeader.
pages.docs.apiRequirements.scope: conversations:read
pages.docs.apiRequirements.module: pages.docs.apiRequirements.automationApiModule (automation_api)
pages.docs.apiRequirements.tenantScope: All resources and identifiers are isolated to the authenticated organization. Identifiers owned by another organization or site are not disclosed.
pages.docs.apiRequirements.retryBehavior: pages.docs.apiRequirements.retryModes.safeRead: This read-only operation can be retried after transport failures without changing resource state.

Path Parameters

id*string

Conversation for which the PDF export was requested. The identifier must reference a resource visible to the authenticated organization.

jobId*string

PDF export job identifier.

Response Body

`application/pdf`

`application/json`

"string"

{
  "state": "waiting",
  "jobId": "pdf-export-job-123"
}

{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {
      "property1": "string",
      "property2": "string"
    },
    "details": {},
    "correlationId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {
      "property1": "string",
      "property2": "string"
    },
    "details": {},
    "correlationId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {
      "property1": "string",
      "property2": "string"
    },
    "details": {},
    "correlationId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {
      "property1": "string",
      "property2": "string"
    },
    "details": {},
    "correlationId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {
      "property1": "string",
      "property2": "string"
    },
    "details": {},
    "correlationId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {
      "property1": "string",
      "property2": "string"
    },
    "details": {},
    "correlationId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {
      "property1": "string",
      "property2": "string"
    },
    "details": {},
    "correlationId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {
      "property1": "string",
      "property2": "string"
    },
    "details": {},
    "correlationId": "string"
  }
}

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?

Poll the status of an async conversation PDF export

pages.docs.apiRequirements.title

Path Parameters

Response Body

`application/pdf`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

Request examples

curl

JavaScript

On this page

Poll the status of an async conversation PDF export

pages.docs.apiRequirements.title

Path Parameters

Response Body

`application/pdf`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

Request examples

curl

JavaScript

On this page

Poll the status of an async conversation PDF export

pages.docs.apiRequirements.title

200application/pdf

202application/json

400application/json

401application/json

403application/json

404application/json

409application/json

422application/json

429application/json

500application/json

On this page

Poll the status of an async conversation PDF export

pages.docs.apiRequirements.title

200application/pdf

202application/json

400application/json

401application/json

403application/json

404application/json

409application/json

422application/json

429application/json

500application/json

On this page

`application/pdf`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/pdf`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`