Image Operations
Warp (perspective correct) an image
Creates a task to apply perspective correction (warp) to an image based on detected document boundaries.
x-api-key
<token>
API Key for authentication
In: header
inputrequired
string
The id of the file or task to operate on.
name
FileName
The name of the image to be saved
verticesrequired
array<unknown>
Coordinates of the 4 vertices of the quadrilateral to warp the image to.
Items
4 <= items <= 4callback_url
string
The URL to call when the task is completed or failed. If you want to receive events, you probably prefer to use webhooks instead.
Format
uriResponse Body
curl -X POST "https://api.scan-documents.com/v1/image-operations/warp" \ -H "Content-Type: application/json" \ -d '{ "input": "file_avyrvozb9302uwhq", "vertices": [ { "x": 0, "y": 0 }, { "x": 100, "y": 10 }, { "x": 100, "y": 100 }, { "x": 0, "y": 90 } ] }'{
"id": "task_euyrvozb9302uwhq",
"operation": "warp",
"parameters": {
"input": "file_avyrvozb9302uwhq",
"name": "Example Image",
"vertices": [
{
"x": 0,
"y": 0
},
{
"x": 100,
"y": 10
},
{
"x": 100,
"y": 100
},
{
"x": 0,
"y": 90
}
],
"callback_url": "https://example.com/callback"
},
"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"
}
]
},
"callback_url": "https://example.com/callback",
"created_at": "2021-05-01T12:00:00Z",
"updated_at": "2021-05-01T12:00:00Z"
}{
"type": "https://scan-documents.com/docs/errors/not-found",
"title": "Not Found",
"status": 404,
"message": "{resource} with id {id} not found."
}{
"type": "https://scan-documents.com/docs/errors/validation-error",
"title": "Validation Error",
"status": 422,
"errors": {
"{field}": [
"{error}."
]
}
}{
"type": "https://scan-documents.com/docs/errors/rate-limit-error",
"title": "Rate Limit Exceeded",
"status": 429,
"message": "Rate limit exceeded. Please try again later or contact support."
}{
"type": "https://scan-documents.com/docs/errors/internal-error",
"title": "An unexpected error occurred. Contact support if the problem persists.",
"status": 500,
"message": "An unexpected error occurred. Contact support if the problem persists."
}