---
title: PDF File Status API Reference
version: 1.0.0
description: Check the status of a PDF file using its unique file ID. Returns file metadata including name, type, creation time, and scheduled deletion time. Use this endpoint to verify file availability after upload or before processing.
openapi: 3.1.1
servers:
  - https://api.apifreaks.com/v1.0
paths: 1
operations: 1
schemas: 2
---

## Table of Contents

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



# PDF File Status API Reference v1.0.0

Check the status of a PDF file using its unique file ID. Returns file metadata including name, type, creation time, and scheduled deletion time. Use this endpoint to verify file availability after upload or before processing.

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

### getFileStatus

`GET /pdf/file-status`

*Check file status*

This API checks the status of a PDF file using its unique file ID, providing information about its creation and potential deletion time.

#### 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.|
|file_id|query|string|true|The unique ID of the file whose status is requested.|

##### Enumerated Values

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

> Example responses

> Successful operation

```json
{
  "fileId": "b7ece7d4-1141-4143-98cb-7b4b818d6d82",
  "fileName": "test.pdf",
  "fileType": "pdf",
  "fileCreationTime": "2026-07-27T10:46:36",
  "fileDeletionTime": "2026-08-26"
}
```

> Bad Request — Missing required file_id parameter

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

> File ID Not Found

```json
{
  "timestamp": "2026-07-27T10:46:37.828Z",
  "path": "/v1.0/pdf/file-status",
  "status": 404,
  "error": "File ID Not Found",
  "message": "Please provide a valid file ID."
}
```

#### Responses

|Status|Meaning|Description|Schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Successful operation|[FileStatusResponse](#filestatusresponse)|
|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|Bad Request — Missing required file_id parameter|[ErrorResponse](#errorresponse)|
|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|File 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

### FileStatusResponse

File status response containing metadata about the PDF file.

#### Properties

|Name|Type|Required|Restrictions|Description|
|---|---|---|---|---|
|fileId|string|true|none|The unique identifier of the file.|
|fileName|string|true|none|The name of the file.|
|fileType|string|true|none|The type of the file (e.g., 'pdf').|
|fileCreationTime|string(date-time)|true|none|The timestamp when the file was created.|
|fileDeletionTime|string(date)|true|none|Date on which the file is scheduled to be deleted, in UTC.|

### 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).|