Scan Documents

Authorization

x-api-key

<token>

API Key for authentication

In: header

Path Parameters

idrequired

string

The id of the task to get.

Response Body

Task response

TypeScript Definitions

Use the response body type in TypeScript.

responserequired

unknown

curl -X GET "https://api.scan-documents.com/v1/tasks/task_euyrvozb9302uwhq" \
  -H "x-api-key: <token>"

{
  "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"
}