Analyze file

POST

/files/{fileId}/analysis

Analyze file for accessibility and quality issues

Performs comprehensive analysis of the file including accessibility compliance,
quality metrics, and best practices. Results are stored with the file record
and can be retrieved later.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.perfectworks.io/api/v0/files//analysis' \
--header 'Content-Type: application/json' \
--data-raw '{
    "forceReanalysis": false
}'

Response Example

200 - Example 1

{
    "success": true,
    "message": "Operation completed successfully",
    "data": {
        "id": "123",
        "name": "Example"
    }
}

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Body Params application/json

Examples

Responses

🟢200OK

application/json

File analysis completed successfully

Body

🟠400Bad Request

🟠401Unauthorized

🟠404Record Not Found

🔴500Server Error

Modified at 2025-08-22 18:48:44

Generate download URL

Process file for accessibility