POST /v1/ocr

Image OCR API

Extract text from screenshots, scanned images, receipts, labels, and photos.

Opérations clés

extract_text

extract_text_with_layout

Cas d’utilisation

  • Receipt parsing

  • Screenshot indexing

  • Document text extraction

Cycle de vie de la tâche async

Tous les endpoints de traitement ImageHQ sont asynchrones. Après un POST réussi, vous recevez une réponse 202 Acceptedavec un job_id. Interrogez l’endpoint de statut jusqu’à ce que l’état atteigne succeeded.

Exemple de requête

import requests

url = "https://api.imagehq.io/v1/ocr"
payload = {
  "operation": "extract_text",
  "options": {
    "detect_orientation": True,
    "language": "eng",
    "output_format": "txt"
  },
  "tool_slug": "image-to-text"
}
files = [("files[]", open("image.png", "rb"))]
data = {"request": json.dumps(payload)}

response = requests.post(url, files=files, data=data)
print(response.json())

Réponse réussie

{
  "completed": {
    "download_url": "/v1/jobs/job_123/download",
    "expires_at": "2026-05-03T00:00:00Z",
    "id": "job_123",
    "inputs": [
      {
        "filename": "input.png",
        "format": "png",
        "mime_type": "image/png",
        "size_bytes": 420122
      }
    ],
    "outputs": [
      {
        "filename": "output.jpg",
        "format": "jpg",
        "id": "0",
        "mime_type": "image/jpeg",
        "size_bytes": 161002
      }
    ],
    "progress": 100,
    "result_json": {
      "confidence": 0.91,
      "text": "Extracted text..."
    },
    "retention_policy": {
      "clamp": true,
      "ttl_hours": 24
    },
    "stages": [
      {
        "name": "queued",
        "progress": 100,
        "status": "succeeded"
      },
      {
        "name": "processing",
        "progress": 100,
        "status": "succeeded"
      }
    ],
    "status": "succeeded",
    "warnings": []
  },
  "queued": {
    "client_reference_id": "example-123",
    "created_at": "2026-05-02T00:00:00Z",
    "current_stage": "queued",
    "expires_at": "2026-05-03T00:00:00Z",
    "id": "job_123",
    "operation": "ocr",
    "poll_url": "/v1/jobs/job_123",
    "progress": 0,
    "status": "queued",
    "tool_slug": "png-to-jpg"
  }
}

Questions fréquentes

What languages are supported?

OCR language support depends on configured language packs in your deployment.

Does OCR return confidence values?

Yes. OCR responses include confidence metadata where available.

Can OCR run inside a pipeline?

Yes. OCR can be one step in a pipeline workflow.


API associées

API metadataAPI documentAPI pipelineAPI batch

ImageHQ

Outils d’image intelligents pour la conversion, la compression et l’automatisation.

Outils

Compresser une imageRedimensionner une imagePNG vers JPGFiltresAméliorer

© 2026 ImageHQ. Tous droits réservés.