معرفی وب‌سرویس iotype

Iotype AI API — speech, image and text processing for Persian, English and Arabic.

Base URL: https://iotype.com · every HTTP endpoint uses the POST method.

Required request headers on every call: Authorization: Bearer <ACCESS_TOKEN> · Accept: application/json · X-Requested-With: XMLHttpRequest

Machine-readable documentation:

• LLM index for the whole site: https://iotype.com/llms.txt
• Instructions for AI coding assistants: https://raw.githubusercontent.com/iotype-ai/iotype-api/main/AGENTS.md
• OpenAPI 3.1 specification (HTTP endpoints): https://raw.githubusercontent.com/iotype-ai/iotype-api/main/spec/openapi.yaml
• AsyncAPI 3.0 specification (realtime ASR only): https://raw.githubusercontent.com/iotype-ai/iotype-api/main/spec/asyncapi.yaml
• Repository and runnable examples: https://github.com/iotype-ai/iotype-api

Official SDKs: pip install iotype-ai · composer require iotype-ai/sdk · npm i @iotype-ai/sdk · go get github.com/iotype-ai/iotype-api/sdk/go

Implementation notes that are commonly got wrong:

1. X-Requested-With: XMLHttpRequest is mandatory on every request. Omitting it does not produce a clear error — the response simply is not what you expect.
2. The asynchronous endpoints (/io/v1/ocr and /io/v1/transcribe) return no result in the initial response. They return file.uuid, and you poll POST /io/v1/file/track with it.
3. The completion signal is a non-null result, not the status field. Poll with exponential backoff, starting around 5 s and capping at 60 s.
4. Identify entries in file.processes[] by their type field (ocr, transcribe, summarize). Array order is not guaranteed.
5. Model identifiers are io-fa (Persian), io-en (English), io-ar (Arabic). They apply to realtime ASR only.
6. Credential scope. Every HTTP endpoint authenticates with an Access Token, which belongs on your server only. A Flash Token is accepted by the realtime ASR WebSocket and by nothing else — no HTTP endpoint takes one. Transcription, OCR, translation, text-to-speech and the file endpoints therefore have no client-side credential and must be called server-side.

Billing is metered in tokens and failed requests are not charged. Pricing: https://iotype.com/plans/api · Get a token: https://iotype.com/api-service/authentication