Skip to main content
POST
/
v1
/
tasks
Initiate a task
curl --request POST \
  --url https://api.turbofiles.io/v1/tasks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/vnd.api+json' \
  --data '
{
  "data": {
    "attributes": {
      "format": {
        "input": "image/png",
        "output": "image/webp"
      },
      "settings": {
        "resize": {
          "width": 640,
          "height": 640,
          "max_width": 1280,
          "max_height": 1280
        }
      }
    },
    "relationship": {
      "input": {
        "data": {
          "id": "<string>"
        }
      }
    }
  }
}
'
{
  "jsonapi": {
    "version": "1.1"
  },
  "links": {
    "self": "<string>"
  },
  "data": {
    "id": "<string>",
    "attributes": {
      "public": false,
      "created_at": "2023-01-01T00:00:00.000000Z",
      "updated_at": "2023-01-02T00:00:00.000000Z",
      "settings": {},
      "status": "COMPLETED",
      "format": {
        "input": "image/png",
        "output": "image/webp"
      },
      "started_at": "2023-01-03T00:00:00.000000Z",
      "processed_at": "2023-01-04T00:00:00.000000Z",
      "processing_metadata": {}
    },
    "relationships": {
      "input": {
        "data": {
          "id": "<string>"
        },
        "links": {
          "self": "<string>",
          "related": "<string>"
        }
      },
      "output": {
        "data": {
          "id": "<string>"
        },
        "links": {
          "self": "<string>",
          "related": "<string>"
        }
      }
    },
    "links": {
      "self": "<string>"
    }
  },
  "included": [
    {
      "id": "8fhd83jpk",
      "attributes": {
        "size": 504233,
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      },
      "links": {
        "self": "<string>",
        "upload": "<string>",
        "download": "<string>"
      }
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.turbofiles.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

Authentication token must be provided in the Authorization header using the Bearer scheme. Example: Authorization: Bearer your-api-key-or-token

Body

application/vnd.api+json
data
object
required

Response

201 - application/vnd.api+json

Created successfully

jsonapi
object
required
data
object
required
included
object[]