---
title: PDF Task Status API Reference
version: 1.0.0
description: "Check the status of a previously initiated PDF processing task using its unique task ID. Returns task status, creation and expiry timestamps, output file URLs and IDs, and input file IDs. Supports status values: queued, processing, completed, failed."
openapi: 3.1.1
servers:
  - https://api.apifreaks.com/v1.0
paths: 1
operations: 1
schemas: 2
---

## Table of Contents

- [PDF Task Status API Reference v1.0.0](#pdf-task-status-api-reference-v100)
  - [Authentication](#authentication)
  - [Task Status and File Info APIs](#task-status-and-file-info-apis)
    - [getTaskStatus](#gettaskstatus)
      - [Parameters](#parameters)
      - [Responses](#responses)
  - [Schemas](#schemas)
    - [TaskStatusResponse](#taskstatusresponse)
    - [ErrorResponse](#errorresponse)



# PDF Task Status API Reference v1.0.0

Check the status of a previously initiated PDF processing task using its unique task ID. Returns task status, creation and expiry timestamps, output file URLs and IDs, and input file IDs. Supports status values: queued, processing, completed, failed.

Base URLs:

* [https://api.apifreaks.com/v1.0](https://api.apifreaks.com/v1.0)

## Authentication

* API Key (ApiKeyAuthHeader)
    - Parameter Name: **X-apiKey**, in: header. Pass your API key via the X-apiKey request header.

* API Key (ApiKeyAuthQuery)
    - Parameter Name: **apiKey**, in: query. Pass your API key via the apiKey query parameter.

## Task Status and File Info APIs

### getTaskStatus

`GET /pdf/task-status`

*Check PDF task status*

This API checks the status of a previously initiated PDF processing task using its unique task ID.

#### Parameters

|Name|In|Type|Required|Description|
|---|---|---|---|---|
|format|query|string|false|Specifies the desired format for the API response. Choose 'json' for a JSON object or 'xml' for an XML structure.|
|task_id|query|string|true|The unique ID of the PDF processing task for which the status is requested.|

##### Enumerated Values

|Parameter|Value|
|---|---|
|format|json|
|format|xml|

> Example responses

> Task status retrieved successfully

```json
{
  "taskId": "74004a68-ec05-4681-8d10-698304206065",
  "status": "completed",
  "createdAt": "2026-07-27 10:48:51",
  "outputUrls": [
    "https://api.apifreaks.com/v1.0/pdf/resource/download?resource_id=21e3bb30-f98e-47ca-9d52-b221857d1f48"
  ],
  "outputIds": [
    "21e3bb30-f98e-47ca-9d52-b221857d1f48"
  ],
  "inputIds": [
    "0deab2f6-927c-451e-81e2-e8565206690e",
    "5b6a4836-8c4c-4379-8b3c-0867be35db71"
  ],
  "expiresAt": "2026-08-03 10:48:51"
}
```

```json
{
  "taskId": "9d8d803b-e23a-4431-901b-98b1f337355c",
  "status": "failed",
  "createdAt": "2026-07-27 10:52:12",
  "inputIds": [
    "63ea4110-b007-475b-9211-2fa7138b8ba1"
  ],
  "error": "Invalid Page Range",
  "message": "One or more specified page numbers exceed the total number of pages in the PDF document.",
  "expiresAt": "2026-08-03 10:52:12"
}
```

> Bad Request — Missing required task_id parameter

```json
{
  "error": "Invalid Param Exception",
  "message": "please pass correct parameters",
  "path": "/v1.0/pdf/task-status",
  "status": 400,
  "timestamp": "2026-07-27T10:49:06.412Z"
}
```

> Task ID Not Found

```json
{
  "timestamp": "2026-07-27T10:49:05.829Z",
  "path": "/v1.0/pdf/task-status",
  "status": 404,
  "error": "Task ID Not Found",
  "message": "Please provide a valid task ID."
}
```

#### Responses

|Status|Meaning|Description|Schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Task status retrieved successfully|[TaskStatusResponse](#taskstatusresponse)|
|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|Bad Request — Missing required task_id parameter|[ErrorResponse](#errorresponse)|
|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Task ID Not Found|[ErrorResponse](#errorresponse)|

#### Response Headers

|Status|Header|Type|Format|Description|
|---|---|---|---|---|
|200|X-AF-Credits-Cost|integer||Specifies the number of credits consumed by the current request.|
|400|X-AF-Credits-Cost|integer||Specifies the number of credits consumed by the current request.|
|404|X-AF-Credits-Cost|integer||Specifies the number of credits consumed by the current request.|

To perform this operation, you must be authenticated by means of one of the following methods:
ApiKeyAuthHeader, ApiKeyAuthQuery

## Schemas

### TaskStatusResponse

Task status response containing the current state of a PDF processing task.

#### Properties

|Name|Type|Required|Restrictions|Description|
|---|---|---|---|---|
|taskId|string|true|none|The unique identifier of the PDF processing task.|
|status|string|true|none|The current status of the task (e.g., 'queued', 'processing', 'completed', 'failed').|
|createdAt|string|true|none|The timestamp when the task status was created, formatted as 'yyyy-MM-dd HH:mm:ss'.|
|zipFileId|string|false|none|The unique identifier for the ZIP file. This is present only when the task status is 'COMPLETED'.|
|outputUrls|[string]|false|none|A list of URLs for each individual output file. This is present only when the task is 'COMPLETED'.|
|outputIds|[string]|false|none|A list of unique IDs for the output files. This is present only when the task is 'COMPLETED'.|
|inputIds|[string]|true|none|A list of unique IDs for the input files submitted with the task. If the task was initiated with the `destroy` parameter set to `true`, `inputIds` will not be generated.|
|error|string|false|none|The error code for the PDF Task. This is included only if the task fails.|
|message|string|false|none|A descriptive message indicating the reason for task failure. This is included only if the task fails.|
|expiresAt|string|true|none|The timestamp when the task status will expire and be removed from the system, formatted as 'yyyy-MM-dd HH:mm:ss'.|
|zipFileUrl|string|false|none|The URL to download all output files as a single ZIP archive. Present only when the task status is completed.|

### ErrorResponse

Standard error envelope returned by the API on failed requests.

#### Properties

|Name|Type|Required|Restrictions|Description|
|---|---|---|---|---|
|error|string|false|none|Short error category or exception type.|
|message|string|true|none|Human-readable error message describing the failure.|
|path|string|false|none|API endpoint path that produced the error.|
|status|integer|false|none|HTTP status code returned with the error.|
|timestamp|string(date-time)|false|none|Timestamp when the error occurred (ISO 8601).|