Apply an effect to an image

Authorization

x-api-key

<token>

API Key for authentication

In: header

Request Body

application/jsonOptional

inputrequired

string

The id of the file to operate on.

name

string

effectrequired

string

The effect to apply to the image

Value in: "grayscale" | "scanner" | "black-background"

Response Body

The response of an apply-effect task

TypeScript Definitions

Use the response body type in TypeScript.

responserequired

Apply Effect Response

The response of an apply-effect task

curl -X POST "https://api.scan-documents.com/v1/image-operations/apply-effect" \
  -H "x-api-key: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "input": "file_avyrvozb9302uwhq",
    "name": "Example Image",
    "effect": "grayscale"
  }'

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

Authorization

Request Body

Response Body

Completed apply-effect Task Response

Pending apply-effect Task Response

Processing apply-effect Task Response

Failed apply-effect Task Response