Extractors

List extractors

Lists the Custom Extractors belonging to the authenticated user,

GET https://api.handwritingocr.com/v3/extractors Try It

List extractors

cURL
curl --request GET \
  --url https://api.handwritingocr.com/v3/extractors \
  --header 'Authorization: Bearer your-api-token'
200 application/json
{
  "extractors": [
    {
      "id": "Ks08XVPyMd",
      "name": "Invoice fields",
      "description": "Supplier, invoice number, date, and total."
    },
    {
      "id": "Rt41MbQwYz",
      "name": "Registry entries",
      "description": "Names and dates from parish register scans."
    }
  ]
}

Lists the Custom Extractors belonging to the authenticated user, sorted by name. Use an extractor’s id as the extractor_id parameter when uploading a document with the extractor action.

Headers

  • Authorization string required header

    Bearer your-api-token

  • Accept string required header

    application/json

Response codes

HTTP status
  • 200

    Returns the user's extractors.

  • 401

    Unauthorized — invalid or missing API token.