Scan Documents
SupportFeedbackDashboard
Tasks

List tasks

Retrieves a paginated list of tasks belonging to the authenticated user.

GET
/v1/tasks

Authorization

x-api-key
<token>

API Key for authentication

In: header

Query Parameters

take
number
Default: 20Minimum: 1Maximum: 100
from
string

Response Body

Paginated list of tasks

TypeScript Definitions

Use the response body type in TypeScript.

datarequired
array<Any properties in Apply Effect Response,Convert Response,Detect Documents Response,Extract Text Response,Warp Response,Extract Pages Response,Merge Response,Render Response,Split Response>

Array of task responses

linksrequired
object

curl -X GET "https://api.scan-documents.com/v1/tasks?take=20&from=string" \
  -H "x-api-key: <token>"
{
  "data": [
    {
      "id": "task_euyrvozb9302uwhq",
      "operation": "apply-effect",
      "parameters": {
        "input": "file_avyrvozb9302uwhq",
        "name": "Example Image",
        "effect": "grayscale"
      },
      "status": "completed",
      "result": {
        "generated_files": [
          {
            "id": "file_euyrvozb9302uwhq",
            "name": "Example Image",
            "type": "image/png",
            "properties": {
              "size": 1024,
              "width": 800,
              "height": 600
            },
            "task_id": "task_euyrvozb9302uwhq",
            "created_at": "2021-05-01T12:00:00Z"
          }
        ]
      },
      "created_at": "2021-05-01T12:00:00Z",
      "updated_at": "2021-05-01T12:00:00Z"
    }
  ],
  "links": {
    "previous": "string",
    "next": "string"
  }
}

Get Task GET

Retrieves the data for a specific task by its ID.

Apply an effect to an image POST

Creates a task to apply a specified visual effect to an image.