Quick Start

Process your first file using the Flimpa API in three simple steps.

Anonymous Usage

You can test the API without an API key. Anonymous usage is limited to 20 creations per hour. For higher limits, authenticate your requests.

Step 1: Create a Task

First, upload your file to the /tasks endpoint. Specify the operation you want to perform, such as image-to-webp.

bash

curl -X POST https://api.flimpa.com/api/v1/tasks \
  -F "operation=image-to-webp" \
  -F "file=@/path/to/your/image.jpg"

The response will contain a taskId and an accessToken. You will need the access token for the next steps.

json

{
  "taskId": "550e8400-e29b-41d4-a716-446655440000",
  "status": "PENDING",
  "pollUrl": "/api/v1/tasks/550e8400-e29b-41d4-a716-446655440000",
  "accessToken": "1735689600000.a1b2c3d4e5f6..."
}

Step 2: Check Task Status

Use the taskId and accessToken to check if your file is ready. The API processes files asynchronously.

bash

curl -X GET https://api.flimpa.com/api/v1/tasks/550e8400-e29b-41d4-a716-446655440000 \
  -H "X-Task-Access-Token: 1735689600000.a1b2c3d4e5f6..."

When the status changes to COMPLETED, you can download the result.

Step 3: Download the Result

Once completed, you can download the processed file using the download endpoint.

bash

curl -X GET https://api.flimpa.com/api/v1/tasks/550e8400-e29b-41d4-a716-446655440000/download \
  -H "X-Task-Access-Token: 1735689600000.a1b2c3d4e5f6..." \
  --output result.webp

Congratulations! You have successfully processed a file using the Flimpa API.