v6

latestOpenAPI 3.1.0raw.githubusercontent.com2025-06-241833312.7 KB
Image Operations

Extract text from an image

Creates a task to extract text from a specified image file.

post/v1/image-operations/extract-text

Request body

OR
OR
OR

Example request

{
  "input": "file_avyrvozb9302uwhq",
  "callback_url": "https://example.com/callback",
  "format": "plain"
}

Response

Task created successfully. Returns the task details.

OR
OR
OR

Example response

{
  "id": "task_euyrvozb9302uwhq",
  "operation": "extract-text",
  "parameters": {
    "input": "file_avyrvozb9302uwhq",
    "callback_url": "https://example.com/callback",
    "format": "plain"
  },
  "status": "completed",
  "result": {
    "format": "plain",
    "content": "This is a sample text extracted from an image."
  },
  "callback_url": "https://example.com/callback",
  "created_at": "2021-05-01T12:00:00Z",
  "updated_at": "2021-05-01T12:00:00Z"
}