{ "openapi": "3.0.1", "info": { "title": "Arabic Text Toolkit: Normalize, Transliterate, Numbers", "description": "Normalise Arabic text, strip diacritics, transliterate Arabic to Latin, match names across scripts, and write amounts in Arabic words. Pure computation, no web calls.", "version": "0.1", "x-build-id": "T7IIRDV92RrNaMxc8" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/firebrick_zamia~arabic-text-toolkit/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-firebrick_zamia-arabic-text-toolkit", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/firebrick_zamia~arabic-text-toolkit/runs": { "post": { "operationId": "runs-sync-firebrick_zamia-arabic-text-toolkit", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/firebrick_zamia~arabic-text-toolkit/run-sync": { "post": { "operationId": "run-sync-firebrick_zamia-arabic-text-toolkit", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "properties": { "texts": { "title": "Texts", "type": "array", "description": "Texts to process, one per line (up to 10,000, each up to 20,000 characters). Each text is one billed result.", "items": { "type": "string" } }, "operations": { "title": "Operations", "type": "array", "description": "What to compute for every text: detect (script and diacritics report), normalize, transliterate (Arabic to Latin), name_key (fuzzy match key for Arabic or Latin names).", "items": { "type": "string", "enum": [ "detect", "normalize", "transliterate", "name_key" ], "enumTitles": [ "Detect script", "Normalize", "Transliterate to Latin", "Name matching key" ] }, "default": [ "detect", "normalize", "transliterate" ] }, "removeDiacritics": { "title": "Remove diacritics", "type": "boolean", "description": "Normalize: strip tashkeel (fatha, damma, kasra, shadda, sukun, tanween, dagger alef).", "default": true }, "removeTatweel": { "title": "Remove tatweel", "type": "boolean", "description": "Normalize: remove the elongation character (ـ).", "default": true }, "unifyAlef": { "title": "Unify alef forms", "type": "boolean", "description": "Normalize: map أ إ آ ٱ to plain ا (useful for search matching).", "default": false }, "unifyYa": { "title": "Unify alef maqsura", "type": "boolean", "description": "Normalize: map ى to ي (useful for search matching).", "default": false }, "unifyTaMarbuta": { "title": "Unify taa marbuta", "type": "boolean", "description": "Normalize: map ة to ه (aggressive; useful for search matching only).", "default": false }, "digits": { "title": "Digit style", "enum": [ "keep", "western", "arabic_indic" ], "type": "string", "description": "Normalize: convert digits to Western (0-9), Arabic-Indic (٠-٩) or leave unchanged. Persian digits are read as input too.", "default": "keep" }, "arabizi": { "title": "Chat style (Arabizi) transliteration", "type": "boolean", "description": "Transliterate: use chat digits for letters without a Latin equivalent (ع=3, ح=7, خ=5, ء=2, ط=6).", "default": false }, "amounts": { "title": "Amounts to write in Arabic words", "type": "array", "description": "Numbers or amounts such as 1250.50 or ١٢٣٤٫٥٠ (up to 10,000). Each amount is one billed result. Max 999,999,999,999.", "items": { "type": "string" } }, "currency": { "title": "Currency for amounts", "enum": [ "none", "AED", "SAR", "QAR", "KWD", "BHD", "OMR" ], "type": "string", "description": "Currency used when writing amounts in words (with minor units). Choose none to write a plain whole number.", "default": "none" } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }