مرجع APIAPI reference

مولّد من مستند OpenAPI 3.1 لواجهة «عليم زاحف الويب»؛ التوافق في جدول التوافق.Generated from Aleem AI Web Crawler's OpenAPI 3.1 document; compatibility is in the compatibility table.

«عليم عليم زاحف الويب الويب» نسخة ١.٠.٠Aleem AI Web Crawler v1.0.0 · https://web-crawler.aleem-ai.com

١1

النظامSystem

٣ نقاط نهاية.3 endpoints.

GET`/health`

حالة الخدمة دون مصادقةService health (no auth)

curl -X GET https://web-crawler.aleem-ai.com/health

مثال الاستجابةResponse example

{
  "status": "ok",
  "product": "zahif-v1.0.0",
  "name": "عليم زاحف الويب",
  "version": "1.0.0",
  "bindings": {
    "db": true,
    "cache": true,
    "jobs": true,
    "browser": true,
    "ai": true
  },
  "origin": null
}

GET`/bot`

صفحة معلومات عليم زاحف الويب بوتZahifBot crawler information page

curl -X GET https://web-crawler.aleem-ai.com/bot

GET`/v2/zahif/capabilities`

القدرات المتاحة فعلاً الآنRuntime capabilities (also in GET /health): edge engines and budgets, origin engines, LLM providers, search backends, features

curl -X GET https://web-crawler.aleem-ai.com/v2/zahif/capabilities \
  -H "Authorization: Bearer zh-YOUR_KEY"

مثال الاستجابةResponse example

{
  "success": true,
  "capabilities": {
    "edge": {
      "fetch": {
        "available": true
      },
      "browser": {
        "available": true,
        "remainingMinutes": 512.4,
        "monthlyMinutes": 540
      }
    },
    "origin": {
      "configured": false,
      "healthy": false,
      "engines": {
        "rust": {
          "available": false,
          "reason_en": "origin not configured",
          "reason_ar": "الأصل غير مُعدّ"
        }
      }
    },
    "features": {
      "scrape": true,
      "parse": false
    }
  }
}

SOURCE/openapi.json

٢2

جلب صفحةScrape

١ نقطة نهاية.1 endpoint.

POST`/v2/scrape`

جلب صفحة واحدة وتحويلها إلى Markdown أو JSON أو لقطة شاشة وغيرهاScrape one URL into Markdown, HTML, JSON, screenshot and more

حقول الطلبRequest fields

الحقلField	النوعType	الوصفDescription
`formats`	`FormatType \| FormatSpec[]`	Default ["markdown"]
`onlyMainContent`	`boolean` = true	Strip navigation, headers, footers and boilerplate
`includeTags`	`string[]`	CSS selectors to keep
`excludeTags`	`string[]`	CSS selectors to drop
`maxAge`	`integer` = 172800000	Accept a cached copy younger than this (ms)
`minAge`	`integer`	Only return a cached copy at least this old (ms)
`headers`	`object`
`waitFor`	`integer`	Extra wait after load (ms); renders with the browser
`mobile`	`boolean` = false	Mobile viewport and user agent
`skipTlsVerification`	`boolean`
`timeout`	`integer` = 60000	Request timeout (ms)
`parsers`	`string \| object[]`	Document parsers, e.g. ["pdf"]
`actions`	`Action[]`
`location`	`Location`
`removeBase64Images`	`boolean` = true
`blockAds`	`boolean` = true
`proxy`	`"basic" \| "stealth" \| "enhanced" \| "auto"`
`storeInCache`	`boolean` = true
`zeroDataRetention`	`boolean` = false	Never store page content or results
`fastMode`	`boolean`
`mode`	`Mode`	fast = سريع; extended = مطوّل قليلاً; deep = مطوّل; custom = مخصص
`settings`	`SettingsOverride`	Per-request settings (see GET /v2/zahif/settings/schema)
`url` *	`string`

curl -X POST https://web-crawler.aleem-ai.com/v2/scrape \
  -H "Authorization: Bearer zh-YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://ar.wikipedia.org/wiki/الرياض","formats":["markdown","links"],"onlyMainContent":true,"mode":"fast"}'

مثال الاستجابةResponse example

{
  "success": true,
  "data": {
    "markdown": "# الرياض\n\nالرياض عاصمة المملكة العربية السعودية…",
    "metadata": {
      "title": "الرياض - ويكيبيديا",
      "language": "ar",
      "sourceURL": "https://ar.wikipedia.org/wiki/الرياض",
      "statusCode": 200,
      "creditsUsed": 1,
      "engine": "fetch",
      "quality": 0.91,
      "cacheState": "miss"
    }
  }
}

SOURCE/openapi.json

٣3

دفعاتBatch

٤ نقاط نهاية.4 endpoints.

POST`/v2/batch/scrape`

بدء جلب دفعة روابطStart a batch scrape of many URLs

حقول الطلبRequest fields

الحقلField	النوعType	الوصفDescription
`formats`	`FormatType \| FormatSpec[]`	Default ["markdown"]
`onlyMainContent`	`boolean` = true	Strip navigation, headers, footers and boilerplate
`includeTags`	`string[]`	CSS selectors to keep
`excludeTags`	`string[]`	CSS selectors to drop
`maxAge`	`integer` = 172800000	Accept a cached copy younger than this (ms)
`minAge`	`integer`	Only return a cached copy at least this old (ms)
`headers`	`object`
`waitFor`	`integer`	Extra wait after load (ms); renders with the browser
`mobile`	`boolean` = false	Mobile viewport and user agent
`skipTlsVerification`	`boolean`
`timeout`	`integer` = 60000	Request timeout (ms)
`parsers`	`string \| object[]`	Document parsers, e.g. ["pdf"]
`actions`	`Action[]`
`location`	`Location`
`removeBase64Images`	`boolean` = true
`blockAds`	`boolean` = true
`proxy`	`"basic" \| "stealth" \| "enhanced" \| "auto"`
`storeInCache`	`boolean` = true
`zeroDataRetention`	`boolean` = false	Never store page content or results
`fastMode`	`boolean`
`mode`	`Mode`	fast = سريع; extended = مطوّل قليلاً; deep = مطوّل; custom = مخصص
`settings`	`SettingsOverride`	Per-request settings (see GET /v2/zahif/settings/schema)
`urls` *	`string[]`
`webhook`	`WebhookSpec`
`maxConcurrency`	`integer`
`ignoreInvalidURLs`	`boolean`

curl -X POST https://web-crawler.aleem-ai.com/v2/batch/scrape \
  -H "Authorization: Bearer zh-YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"urls":["https://example.com","https://example.org"],"formats":["markdown"]}'

مثال الاستجابةResponse example

{
  "success": true,
  "id": "0f1e2d3c-4b5a-6978-8796-a5b4c3d2e1f0",
  "url": "https://web-crawler.aleem-ai.com/v2/batch/scrape/0f1e2d3c-4b5a-6978-8796-a5b4c3d2e1f0",
  "invalidURLs": []
}

GET`/v2/batch/scrape/{id}`

حالة الدفعة ونتائجهاBatch status and results

المعاملParameter	الموضعIn	الوصفDescription
`id` *	path	Job id
`skip`	query	Results to skip (paging)
`limit`	query	Max results in this page

curl -X GET https://web-crawler.aleem-ai.com/v2/batch/scrape/JOB_ID \
  -H "Authorization: Bearer zh-YOUR_KEY"

مثال الاستجابةResponse example

{
  "success": true,
  "status": "scraping",
  "total": 25,
  "completed": 9,
  "creditsUsed": 9,
  "expiresAt": "2026-11-04T19:00:00.000Z",
  "next": null,
  "progress": {
    "phase": "scrape",
    "pct": 36,
    "message_ar": "تُجلب الصفحات",
    "message_en": "Scraping pages"
  },
  "data": []
}

DELETE`/v2/batch/scrape/{id}`

إلغاء الدفعةCancel a batch

المعاملParameter	الموضعIn	الوصفDescription
`id` *	path	Job id

curl -X DELETE https://web-crawler.aleem-ai.com/v2/batch/scrape/JOB_ID \
  -H "Authorization: Bearer zh-YOUR_KEY"

مثال الاستجابةResponse example

{
  "success": true,
  "status": "cancelled"
}

GET`/v2/batch/scrape/{id}/errors`

أخطاء الدفعةBatch errors

المعاملParameter	الموضعIn	الوصفDescription
`id` *	path	Job id

curl -X GET https://web-crawler.aleem-ai.com/v2/batch/scrape/JOB_ID/errors \
  -H "Authorization: Bearer zh-YOUR_KEY"

SOURCE/openapi.json

٤4

زحفCrawl

٦ نقاط نهاية.6 endpoints.

POST`/v2/crawl`

بدء زحف موقعStart a crawl of a website

حقول الطلبRequest fields

الحقلField	النوعType	الوصفDescription
`url` *	`string`
`prompt`	`string`	Natural-language crawl intent
`excludePaths`	`string[]`	Regex patterns
`includePaths`	`string[]`	Regex patterns
`maxDiscoveryDepth`	`integer`
`sitemap`	`"include" \| "only" \| "skip"` = "include"
`ignoreQueryParameters`	`boolean`
`regexOnFullURL`	`boolean`
`limit`	`integer` = 10000
`crawlEntireDomain`	`boolean`
`allowExternalLinks`	`boolean`
`allowSubdomains`	`boolean`
`delay`	`number`	Seconds between requests
`maxConcurrency`	`integer`
`webhook`	`WebhookSpec`
`scrapeOptions`	`ScrapeOptions`
`zeroDataRetention`	`boolean`
`mode`	`Mode`	fast = سريع; extended = مطوّل قليلاً; deep = مطوّل; custom = مخصص
`settings`	`SettingsOverride`	Per-request settings (see GET /v2/zahif/settings/schema)

curl -X POST https://web-crawler.aleem-ai.com/v2/crawl \
  -H "Authorization: Bearer zh-YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://example.com","limit":25,"maxDiscoveryDepth":2,"scrapeOptions":{"formats":["markdown"]},"webhook":{"url":"https://hooks.example.com/zahif","events":["completed","failed"]},"mode":"extended"}'

مثال الاستجابةResponse example

{
  "success": true,
  "id": "0f1e2d3c-4b5a-6978-8796-a5b4c3d2e1f0",
  "url": "https://web-crawler.aleem-ai.com/v2/crawl/0f1e2d3c-4b5a-6978-8796-a5b4c3d2e1f0"
}

GET`/v2/crawl/{id}`

حالة الزحف ونتائجهCrawl status and results

المعاملParameter	الموضعIn	الوصفDescription
`id` *	path	Job id
`skip`	query	Results to skip (paging)
`limit`	query	Max results in this page

curl -X GET https://web-crawler.aleem-ai.com/v2/crawl/JOB_ID \
  -H "Authorization: Bearer zh-YOUR_KEY"

مثال الاستجابةResponse example

{
  "success": true,
  "status": "scraping",
  "total": 25,
  "completed": 9,
  "creditsUsed": 9,
  "expiresAt": "2026-11-04T19:00:00.000Z",
  "next": null,
  "progress": {
    "phase": "scrape",
    "pct": 36,
    "message_ar": "تُجلب الصفحات",
    "message_en": "Scraping pages"
  },
  "data": []
}

DELETE`/v2/crawl/{id}`

إلغاء الزحفCancel a crawl

المعاملParameter	الموضعIn	الوصفDescription
`id` *	path	Job id

curl -X DELETE https://web-crawler.aleem-ai.com/v2/crawl/JOB_ID \
  -H "Authorization: Bearer zh-YOUR_KEY"

مثال الاستجابةResponse example

{
  "success": true,
  "status": "cancelled"
}

GET`/v2/crawl/{id}/errors`

أخطاء الزحفCrawl errors

المعاملParameter	الموضعIn	الوصفDescription
`id` *	path	Job id

curl -X GET https://web-crawler.aleem-ai.com/v2/crawl/JOB_ID/errors \
  -H "Authorization: Bearer zh-YOUR_KEY"

GET`/v2/crawl/active`

عمليات الزحف النشطةActive crawls of this team

curl -X GET https://web-crawler.aleem-ai.com/v2/crawl/active \
  -H "Authorization: Bearer zh-YOUR_KEY"

POST`/v2/crawl/params-preview`

تحويل وصف نصي إلى معاملات زحف دون بدء الزحفTurn a natural-language prompt into crawl parameters (no crawl is started)

حقول الطلبRequest fields

الحقلField	النوعType	الوصفDescription
`url` *	`string`
`prompt` *	`string`

curl -X POST https://web-crawler.aleem-ai.com/v2/crawl/params-preview \
  -H "Authorization: Bearer zh-YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://example.com","prompt":"only blog posts from 2026"}'

SOURCE/openapi.json

٥5

خريطة الموقعMap

١ نقطة نهاية.1 endpoint.

POST`/v2/map`

اكتشاف روابط الموقع مع ترتيبها بكلمة بحث اختيارياًDiscover the URLs of a site (sitemaps + links), optionally ranked by a search term

حقول الطلبRequest fields

الحقلField	النوعType	الوصفDescription
`url` *	`string`
`search`	`string`	Rank links by relevance to this term (BM25)
`sitemap`	`"include" \| "only" \| "skip"`
`includeSubdomains`	`boolean`
`ignoreQueryParameters`	`boolean`
`limit`	`integer` = 5000
`timeout`	`integer`
`location`	`Location`
`mode`	`Mode`	fast = سريع; extended = مطوّل قليلاً; deep = مطوّل; custom = مخصص
`settings`	`SettingsOverride`	Per-request settings (see GET /v2/zahif/settings/schema)

curl -X POST https://web-crawler.aleem-ai.com/v2/map \
  -H "Authorization: Bearer zh-YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://example.com","search":"pricing","limit":100}'

مثال الاستجابةResponse example

{
  "success": true,
  "links": [
    {
      "url": "https://example.com/pricing",
      "title": "Pricing"
    }
  ]
}

SOURCE/openapi.json

٦6

بحثSearch

١ نقطة نهاية.1 endpoint.

POST`/v2/search`

بحث في الويب والأخبار والصور بدمج مصادر مجانية متعددة مع جلب النتائج اختيارياًWeb, news and image search fused from several free sources; optionally scrape the hits

حقول الطلبRequest fields

الحقلField	النوعType	الوصفDescription
`query` *	`string`
`limit`	`integer` = 5
`sources`	`"web" \| "news" \| "images" \| object[]`
`categories`	`"github" \| "research" \| "pdf" \| object[]`
`tbs`	`string`	Time filter, e.g. qdr:d, qdr:w, qdr:m, qdr:y
`location`	`string`
`country`	`string`
`timeout`	`integer`
`ignoreInvalidURLs`	`boolean`
`scrapeOptions`	`ScrapeOptions`
`mode`	`Mode`	fast = سريع; extended = مطوّل قليلاً; deep = مطوّل; custom = مخصص
`settings`	`SettingsOverride`	Per-request settings (see GET /v2/zahif/settings/schema)

curl -X POST https://web-crawler.aleem-ai.com/v2/search \
  -H "Authorization: Bearer zh-YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"query":"عجز الميزانية السعودية 2026","limit":5,"sources":["web","news"],"mode":"extended"}'

مثال الاستجابةResponse example

{
  "success": true,
  "data": {
    "web": [
      {
        "url": "https://example.com/a",
        "title": "…",
        "description": "…",
        "position": 1,
        "source": "bing+ddg"
      }
    ]
  }
}

SOURCE/openapi.json

٧7

استخراج منظمExtract

٢ نقطة نهاية.2 endpoints.

POST`/v2/extract`

بدء استخراج بيانات منظمة من روابط أو من الويب بمخطط أو تعليماتStart structured extraction from URLs (and optionally the web) with a schema or prompt

حقول الطلبRequest fields

الحقلField	النوعType	الوصفDescription
`urls`	`string[]`	URLs; a trailing /* expands to the site
`prompt`	`string`
`schema`	`object`
`enableWebSearch`	`boolean`
`ignoreSitemap`	`boolean`
`includeSubdomains`	`boolean`
`showSources`	`boolean`
`scrapeOptions`	`ScrapeOptions`
`ignoreInvalidURLs`	`boolean`
`mode`	`Mode`	fast = سريع; extended = مطوّل قليلاً; deep = مطوّل; custom = مخصص
`settings`	`SettingsOverride`	Per-request settings (see GET /v2/zahif/settings/schema)

curl -X POST https://web-crawler.aleem-ai.com/v2/extract \
  -H "Authorization: Bearer zh-YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"urls":["https://example.com/*"],"prompt":"Company name and pricing plans","schema":{"type":"object","properties":{"company":{"type":"string"},"plans":{"type":"array","items":{"type":"string"}}}}}'

مثال الاستجابةResponse example

{
  "success": true,
  "id": "0f1e2d3c-4b5a-6978-8796-a5b4c3d2e1f0",
  "url": "https://web-crawler.aleem-ai.com/v2/extract/0f1e2d3c-4b5a-6978-8796-a5b4c3d2e1f0"
}

GET`/v2/extract/{id}`

حالة الاستخراج ونتيجتهExtraction status and result

المعاملParameter	الموضعIn	الوصفDescription
`id` *	path	Job id

curl -X GET https://web-crawler.aleem-ai.com/v2/extract/JOB_ID \
  -H "Authorization: Bearer zh-YOUR_KEY"

مثال الاستجابةResponse example

{
  "success": true,
  "status": "scraping",
  "total": 25,
  "completed": 9,
  "creditsUsed": 9,
  "expiresAt": "2026-11-04T19:00:00.000Z",
  "next": null,
  "progress": {
    "phase": "scrape",
    "pct": 36,
    "message_ar": "تُجلب الصفحات",
    "message_en": "Scraping pages"
  },
  "data": []
}

SOURCE/openapi.json

٨8

وكيل البحثResearch

٦ نقاط نهاية.6 endpoints.

POST`/v2/agent`

بدء وكيل البحث: يخطط ويبحث ويقرأ ويرتب ويجيب باقتباسات مرقّمةStart the research agent: plan, search, read, rank and answer with numbered citations

حقول الطلبRequest fields

الحقلField	النوعType	الوصفDescription
`prompt` *	`string`	Research question
`urls`	`string[]`
`schema`	`object`
`maxCredits`	`integer`
`strictConstrainToURLs`	`boolean`
`mode`	`"fast" \| "extended" \| "deep" \| "custom" \| "extract" \| "chat"`	Aleem AI Web Crawler work mode. Clients of the Firecrawl v2 API may send their own agent mode extract \| chat: it is accepted, kept as the agent style, and the Aleem AI Web Crawler work mode then comes from zahifMode, the x-zahif-mode header or the key profile.
`zahifMode`	`Mode`	Aleem AI Web Crawler work mode when `mode` carries extract \| chat
`settings`	`SettingsOverride`	Per-request settings (see GET /v2/zahif/settings/schema)

curl -X POST https://web-crawler.aleem-ai.com/v2/agent \
  -H "Authorization: Bearer zh-YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"prompt":"What were Saudi Arabia's 2025 budget deficit figures? Cite sources.","mode":"extended","maxCredits":200}'

مثال الاستجابةResponse example

{
  "success": true,
  "id": "0f1e2d3c-4b5a-6978-8796-a5b4c3d2e1f0",
  "url": "https://web-crawler.aleem-ai.com/v2/agent/0f1e2d3c-4b5a-6978-8796-a5b4c3d2e1f0"
}

GET`/v2/agent/{id}`

حالة البحث وإجابته ومصادرهResearch status, answer and sources

المعاملParameter	الموضعIn	الوصفDescription
`id` *	path	Job id

curl -X GET https://web-crawler.aleem-ai.com/v2/agent/JOB_ID \
  -H "Authorization: Bearer zh-YOUR_KEY"

مثال الاستجابةResponse example

{
  "success": true,
  "status": "scraping",
  "total": 25,
  "completed": 9,
  "creditsUsed": 9,
  "expiresAt": "2026-11-04T19:00:00.000Z",
  "next": null,
  "progress": {
    "phase": "scrape",
    "pct": 36,
    "message_ar": "تُجلب الصفحات",
    "message_en": "Scraping pages"
  },
  "data": []
}

DELETE`/v2/agent/{id}`

إلغاء البحثCancel research

المعاملParameter	الموضعIn	الوصفDescription
`id` *	path	Job id

curl -X DELETE https://web-crawler.aleem-ai.com/v2/agent/JOB_ID \
  -H "Authorization: Bearer zh-YOUR_KEY"

مثال الاستجابةResponse example

{
  "success": true,
  "status": "cancelled"
}

GET`/v2/zahif/research/{id}`

اسم بديل لـ GET /v2/agent/{id}Alias of GET /v2/agent/{id}

المعاملParameter	الموضعIn	الوصفDescription
`id` *	path	Job id

curl -X GET https://web-crawler.aleem-ai.com/v2/zahif/research/JOB_ID \
  -H "Authorization: Bearer zh-YOUR_KEY"

مثال الاستجابةResponse example

{
  "success": true,
  "status": "scraping",
  "total": 25,
  "completed": 9,
  "creditsUsed": 9,
  "expiresAt": "2026-11-04T19:00:00.000Z",
  "next": null,
  "progress": {
    "phase": "scrape",
    "pct": 36,
    "message_ar": "تُجلب الصفحات",
    "message_en": "Scraping pages"
  },
  "data": []
}

DELETE`/v2/zahif/research/{id}`

اسم بديل لـ DELETE /v2/agent/{id}Alias of DELETE /v2/agent/{id}

المعاملParameter	الموضعIn	الوصفDescription
`id` *	path	Job id

curl -X DELETE https://web-crawler.aleem-ai.com/v2/zahif/research/JOB_ID \
  -H "Authorization: Bearer zh-YOUR_KEY"

مثال الاستجابةResponse example

{
  "success": true,
  "status": "cancelled"
}

POST`/v2/zahif/research`

اسم بديل لـ POST /v2/agentAlias of POST /v2/agent

حقول الطلبRequest fields

الحقلField	النوعType	الوصفDescription
`prompt` *	`string`	Research question
`urls`	`string[]`
`schema`	`object`
`maxCredits`	`integer`
`strictConstrainToURLs`	`boolean`
`mode`	`"fast" \| "extended" \| "deep" \| "custom" \| "extract" \| "chat"`	Aleem AI Web Crawler work mode. Clients of the Firecrawl v2 API may send their own agent mode extract \| chat: it is accepted, kept as the agent style, and the Aleem AI Web Crawler work mode then comes from zahifMode, the x-zahif-mode header or the key profile.
`zahifMode`	`Mode`	Aleem AI Web Crawler work mode when `mode` carries extract \| chat
`settings`	`SettingsOverride`	Per-request settings (see GET /v2/zahif/settings/schema)

curl -X POST https://web-crawler.aleem-ai.com/v2/zahif/research \
  -H "Authorization: Bearer zh-YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"prompt":"ما أحدث أرقام عجز الميزانية السعودية؟ اذكر المصادر.","mode":"deep"}'

مثال الاستجابةResponse example

{
  "success": true,
  "id": "0f1e2d3c-4b5a-6978-8796-a5b4c3d2e1f0",
  "url": "https://web-crawler.aleem-ai.com/v2/agent/0f1e2d3c-4b5a-6978-8796-a5b4c3d2e1f0"
}

SOURCE/openapi.json

٩9

الحساب والاستهلاكAccount

٨ نقاط نهاية.8 endpoints.

GET`/v2/team/credit-usage`

الرصيد المتبقي واستهلاك الخطةRemaining credits and plan usage

curl -X GET https://web-crawler.aleem-ai.com/v2/team/credit-usage \
  -H "Authorization: Bearer zh-YOUR_KEY"

مثال الاستجابةResponse example

{
  "success": true,
  "data": {
    "remainingCredits": 99120,
    "planCredits": 100000
  }
}

GET`/v2/team/token-usage`

استهلاك رموز النماذج اللغويةLLM token usage

curl -X GET https://web-crawler.aleem-ai.com/v2/team/token-usage \
  -H "Authorization: Bearer zh-YOUR_KEY"

GET`/v2/team/queue-status`

حالة الطابورQueue status for this team

curl -X GET https://web-crawler.aleem-ai.com/v2/team/queue-status \
  -H "Authorization: Bearer zh-YOUR_KEY"

GET`/v2/zahif/usage`

الاستهلاك هذا الشهر حسب العمليةUsage this month by operation (admins also see budgets)

curl -X GET https://web-crawler.aleem-ai.com/v2/zahif/usage \
  -H "Authorization: Bearer zh-YOUR_KEY"

GET`/v2/concurrency-check`

المهام النشطة مقابل حد التزامنActive jobs of this key against the concurrency limit

curl -X GET https://web-crawler.aleem-ai.com/v2/concurrency-check \
  -H "Authorization: Bearer zh-YOUR_KEY"

GET`/v2/zahif/me`

المفتاح المستدعي ورصيدهThe calling key: id, name, scopes, remaining credits, last 24 h credits

curl -X GET https://web-crawler.aleem-ai.com/v2/zahif/me \
  -H "Authorization: Bearer zh-YOUR_KEY"

GET`/v2/zahif/webhook-secret`

سرّ توقيع الـ webhooks لهذا المفتاحThe HMAC secret that signs this key's webhooks

curl -X GET https://web-crawler.aleem-ai.com/v2/zahif/webhook-secret \
  -H "Authorization: Bearer zh-YOUR_KEY"

GET`/v2/zahif/files/{key}`

ملف لقطة شاشة أو PDF ناتج عن عملية جلبStored screenshot or PDF produced by a scrape (unguessable name, no auth)

المعاملParameter	الموضعIn	الوصفDescription
`key` *	path	<uuid>.png\|jpg\|pdf

curl -X GET https://web-crawler.aleem-ai.com/v2/zahif/files/{key}

SOURCE/openapi.json

١٠10

الإعداداتSettings

٣ نقاط نهاية.3 endpoints.

GET`/v2/zahif/settings`

ملف إعدادات المفتاحThe settings profile of this key

curl -X GET https://web-crawler.aleem-ai.com/v2/zahif/settings \
  -H "Authorization: Bearer zh-YOUR_KEY"

PUT`/v2/zahif/settings`

حفظ ملف إعدادات المفتاح بعد التحقق من السجلSave the settings profile of this key (validated against the registry)

حقول الطلبRequest fields

الحقلField	النوعType	الوصفDescription
`settings` *	`object`
`mode`	`Mode`	fast = سريع; extended = مطوّل قليلاً; deep = مطوّل; custom = مخصص

curl -X PUT https://web-crawler.aleem-ai.com/v2/zahif/settings \
  -H "Authorization: Bearer zh-YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"settings":{"respect_robots":true,"search.max_sources":12}}'

GET`/v2/zahif/settings/schema`

سجل الإعدادات: كل مفتاح بنوعه وقيمه الافتراضية لكل وضع وتسمياتهSettings registry: every switch with type, defaults per mode and Arabic/English labels

curl -X GET https://web-crawler.aleem-ai.com/v2/zahif/settings/schema \
  -H "Authorization: Bearer zh-YOUR_KEY"

SOURCE/openapi.json

١١11

الإدارةAdmin

٣٠ نقاط نهاية.30 endpoints.

GET`/v2/zahif/keys`

عرض المفاتيح (للمشرف)List API keys (admin)

curl -X GET https://web-crawler.aleem-ai.com/v2/zahif/keys \
  -H "Authorization: Bearer zh-YOUR_KEY"

POST`/v2/zahif/keys`

إنشاء مفتاح (للمشرف)؛ يظهر مرة واحدةCreate an API key (admin). The key is returned once.

حقول الطلبRequest fields

الحقلField	النوعType	الوصفDescription
`name`	`string`
`teamId`	`string`
`scopes`	`"api" \| "mcp" \| "admin"[]`
`planCredits`	`integer`
`ratePerMin`	`integer`

curl -X POST https://web-crawler.aleem-ai.com/v2/zahif/keys \
  -H "Authorization: Bearer zh-YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"aleem","scopes":["api","mcp"],"planCredits":100000}'

مثال الاستجابةResponse example

{
  "success": true,
  "id": "k_…",
  "key": "zh-…",
  "prefix": "zh-ab12",
  "note": "Store this key now; it is shown only once."
}

DELETE`/v2/zahif/keys/{id}`

إلغاء مفتاح (للمشرف)Revoke an API key (admin)

المعاملParameter	الموضعIn	الوصفDescription
`id` *	path	Key id

curl -X DELETE https://web-crawler.aleem-ai.com/v2/zahif/keys/JOB_ID \
  -H "Authorization: Bearer zh-YOUR_KEY"

GET`/v2/zahif/settings/owner`

إعدادات المالك على مستوى النشرDeployment-wide owner settings (budgets, caps, safety switches)

curl -X GET https://web-crawler.aleem-ai.com/v2/zahif/settings/owner \
  -H "Authorization: Bearer zh-YOUR_KEY"

PUT`/v2/zahif/settings/owner`

حفظ إعدادات المالك (للمشرف)Save owner settings (admin only)

حقول الطلبRequest fields

الحقلField	النوعType	الوصفDescription
`settings` *	`object`

curl -X PUT https://web-crawler.aleem-ai.com/v2/zahif/settings/owner \
  -H "Authorization: Bearer zh-YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"settings":{"browser.monthly_minutes":540,"llm.monthly_usd_cap":50}}'

GET`/v2/zahif/keys/{id}/policy`

سياسة المفتاح التي يضبطها المشرفPer-key policy set by the admin (e.g. raised limits)

المعاملParameter	الموضعIn	الوصفDescription
`id` *	path	Key id

curl -X GET https://web-crawler.aleem-ai.com/v2/zahif/keys/JOB_ID/policy \
  -H "Authorization: Bearer zh-YOUR_KEY"

PUT`/v2/zahif/keys/{id}/policy`

ضبط سياسة مفتاح (للمشرف)Set a key's policy (admin only)

المعاملParameter	الموضعIn	الوصفDescription
`id` *	path	Key id

حقول الطلبRequest fields

الحقلField	النوعType	الوصفDescription
`settings` *	`object`

curl -X PUT https://web-crawler.aleem-ai.com/v2/zahif/keys/JOB_ID/policy \
  -H "Authorization: Bearer zh-YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"settings":{"limits.max_pages":500}}'

POST`/v2/zahif/bench/score`

قياس الأداء على الحافة: مقاييس فقط دون نص الصفحات (للمشرف)Benchmark scoring on the edge: metrics only per row, never page text (admin)

حقول الطلبRequest fields

الحقلField	النوعType	الوصفDescription
`rows` *	`object[]`	At most 25 rows
`mode`	`Mode`	fast = سريع; extended = مطوّل قليلاً; deep = مطوّل; custom = مخصص
`options`	`object`	useCache and scrape options

curl -X POST https://web-crawler.aleem-ai.com/v2/zahif/bench/score \
  -H "Authorization: Bearer zh-YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"rows":[{"id":"r1","url":"https://example.com","truth_text":"Example Domain"}],"mode":"fast"}'

POST`/v2/zahif/bench/answer`

تقييم صحة البحث: إجابات مع مصادر (للمشرف)Research-correctness evaluation: answers with citations (admin)

حقول الطلبRequest fields

الحقلField	النوعType	الوصفDescription
`questions` *	`object[]`	At most 10
`mode`	`Mode`	fast = سريع; extended = مطوّل قليلاً; deep = مطوّل; custom = مخصص

curl -X POST https://web-crawler.aleem-ai.com/v2/zahif/bench/answer \
  -H "Authorization: Bearer zh-YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"questions":[{"id":"q1","question":"What is the capital of Saudi Arabia?"}],"mode":"fast"}'

GET`/v2/zahif/selftest`

اختبار ذاتي حي من الحافة (للمشرف)Live self-test from the edge (admin)

curl -X GET https://web-crawler.aleem-ai.com/v2/zahif/selftest \
  -H "Authorization: Bearer zh-YOUR_KEY"

GET`/v2/zahif/admin/accounts`

عرض الحسابات (للمشرف)List accounts (admin)

المعاملParameter	الموضعIn	الوصفDescription
`status`	query
`q`	query
`limit`	query
`offset`	query

curl -X GET https://web-crawler.aleem-ai.com/v2/zahif/admin/accounts \
  -H "Authorization: Bearer zh-YOUR_KEY"

POST`/v2/zahif/admin/accounts`

إنشاء حساب مع مفتاح ورصيد افتتاحي اختيارياً (للمشرف)Create an account, optionally with a key and opening credits (admin)

حقول الطلبRequest fields

الحقلField	النوعType	الوصفDescription
`id`	`string`
`name` *	`string`
`planId`	`string`
`cycle`	`"monthly" \| "yearly"`
`creditsOverride`	`number \| null`
`limitsOverride`	`object`
`alertWebhook`	`string`
`notes`	`string`
`anchor`	`string`
`issueKey`	`boolean \| object`
`packCredits`	`integer`

curl -X POST https://web-crawler.aleem-ai.com/v2/zahif/admin/accounts \
  -H "Authorization: Bearer zh-YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Aleem","planId":"free","issueKey":true}'

GET`/v2/zahif/admin/accounts/{id}`

تفاصيل الحساب ومفاتيحه (للمشرف)Account detail with its keys (admin)

المعاملParameter	الموضعIn	الوصفDescription
`id` *	path	Account id

curl -X GET https://web-crawler.aleem-ai.com/v2/zahif/admin/accounts/JOB_ID \
  -H "Authorization: Bearer zh-YOUR_KEY"

PATCH`/v2/zahif/admin/accounts/{id}`

تعديل بيانات الحساب (للمشرف)Update account fields (admin)

المعاملParameter	الموضعIn	الوصفDescription
`id` *	path	Account id

حقول الطلبRequest fields

curl -X PATCH https://web-crawler.aleem-ai.com/v2/zahif/admin/accounts/JOB_ID \
  -H "Authorization: Bearer zh-YOUR_KEY"

POST`/v2/zahif/admin/accounts/{id}`

اسم بديل لـ PATCH (للمشرف)POST alias of PATCH for clients without PATCH (admin)

المعاملParameter	الموضعIn	الوصفDescription
`id` *	path	Account id

حقول الطلبRequest fields

curl -X POST https://web-crawler.aleem-ai.com/v2/zahif/admin/accounts/JOB_ID \
  -H "Authorization: Bearer zh-YOUR_KEY"

POST`/v2/zahif/admin/accounts/{id}/suspend`

إيقاف حساب (للمشرف)Suspend an account (admin)

المعاملParameter	الموضعIn	الوصفDescription
`id` *	path	Account id

حقول الطلبRequest fields

الحقلField	النوعType	الوصفDescription
`reason`	`string`

curl -X POST https://web-crawler.aleem-ai.com/v2/zahif/admin/accounts/JOB_ID/suspend \
  -H "Authorization: Bearer zh-YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"reason":"requested by the customer"}'

POST`/v2/zahif/admin/accounts/{id}/resume`

إعادة تفعيل حساب (للمشرف)Resume an account (admin)

المعاملParameter	الموضعIn	الوصفDescription
`id` *	path	Account id

حقول الطلبRequest fields

الحقلField	النوعType	الوصفDescription
`reason`	`string`

curl -X POST https://web-crawler.aleem-ai.com/v2/zahif/admin/accounts/JOB_ID/resume \
  -H "Authorization: Bearer zh-YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"reason":"requested by the customer"}'

POST`/v2/zahif/admin/accounts/{id}/cancel`

إلغاء حساب (للمشرف)Cancel an account (admin)

المعاملParameter	الموضعIn	الوصفDescription
`id` *	path	Account id

حقول الطلبRequest fields

الحقلField	النوعType	الوصفDescription
`reason`	`string`

curl -X POST https://web-crawler.aleem-ai.com/v2/zahif/admin/accounts/JOB_ID/cancel \
  -H "Authorization: Bearer zh-YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"reason":"requested by the customer"}'

POST`/v2/zahif/admin/accounts/{id}/plan`

تغيير الخطة والدورة (للمشرف) دون احتساب تناسبيChange plan and cycle (admin); no proration

المعاملParameter	الموضعIn	الوصفDescription
`id` *	path	Account id

حقول الطلبRequest fields

الحقلField	النوعType	الوصفDescription
`planId` *	`string`
`cycle`	`"monthly" \| "yearly"`
`resetPeriod`	`boolean`
`creditsOverride`	`number \| null`

curl -X POST https://web-crawler.aleem-ai.com/v2/zahif/admin/accounts/JOB_ID/plan \
  -H "Authorization: Bearer zh-YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"planId":"free","cycle":"monthly"}'

POST`/v2/zahif/admin/accounts/{id}/credits`

إضافة رصيد: حزمة أو منحة أو تعديل (للمشرف)Add credits: pack, grant or adjustment (admin)

المعاملParameter	الموضعIn	الوصفDescription
`id` *	path	Account id

حقول الطلبRequest fields

الحقلField	النوعType	الوصفDescription
`kind` *	`"pack" \| "grant" \| "adjust"`
`packs`	`integer`
`credits`	`integer`
`reason`	`string`

curl -X POST https://web-crawler.aleem-ai.com/v2/zahif/admin/accounts/JOB_ID/credits \
  -H "Authorization: Bearer zh-YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"kind":"grant","credits":500,"reason":"trial"}'

GET`/v2/zahif/admin/accounts/{id}/keys`

مفاتيح الحساب (للمشرف)Keys of an account (admin)

المعاملParameter	الموضعIn	الوصفDescription
`id` *	path	Account id

curl -X GET https://web-crawler.aleem-ai.com/v2/zahif/admin/accounts/JOB_ID/keys \
  -H "Authorization: Bearer zh-YOUR_KEY"

POST`/v2/zahif/admin/accounts/{id}/keys`

إصدار مفتاح للحساب (للمشرف)؛ يظهر مرة واحدةIssue a key for an account (admin); shown once

المعاملParameter	الموضعIn	الوصفDescription
`id` *	path	Account id

حقول الطلبRequest fields

الحقلField	النوعType	الوصفDescription
`name`	`string`
`scopes`	`string[]`

curl -X POST https://web-crawler.aleem-ai.com/v2/zahif/admin/accounts/JOB_ID/keys \
  -H "Authorization: Bearer zh-YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"aleem worker"}'

DELETE`/v2/zahif/admin/accounts/{id}/keys/{keyId}`

إلغاء مفتاح من الحساب (للمشرف)Revoke a key of an account (admin)

المعاملParameter	الموضعIn	الوصفDescription
`id` *	path	Account id
`keyId` *	path

curl -X DELETE https://web-crawler.aleem-ai.com/v2/zahif/admin/accounts/JOB_ID/keys/{keyId} \
  -H "Authorization: Bearer zh-YOUR_KEY"

GET`/v2/zahif/admin/accounts/{id}/usage`

استهلاك الحساب حسب العملية واليوم (للمشرف)Usage of an account by operation and day (admin)

المعاملParameter	الموضعIn	الوصفDescription
`id` *	path	Account id
`period`	query
`from`	query
`to`	query

curl -X GET https://web-crawler.aleem-ai.com/v2/zahif/admin/accounts/JOB_ID/usage \
  -H "Authorization: Bearer zh-YOUR_KEY"

GET`/v2/zahif/admin/accounts/{id}/ledger`

حركات الحساب (للمشرف)Ledger of an account (admin)

المعاملParameter	الموضعIn	الوصفDescription
`id` *	path	Account id
`limit`	query

curl -X GET https://web-crawler.aleem-ai.com/v2/zahif/admin/accounts/JOB_ID/ledger \
  -H "Authorization: Bearer zh-YOUR_KEY"

GET`/v2/zahif/admin/accounts/{id}/statement`

كشف حساب (للمشرف)Statement of an account (admin)

المعاملParameter	الموضعIn	الوصفDescription
`id` *	path	Account id
`format`	query

curl -X GET https://web-crawler.aleem-ai.com/v2/zahif/admin/accounts/JOB_ID/statement \
  -H "Authorization: Bearer zh-YOUR_KEY"

GET`/v2/zahif/admin/plans`

كل الخطط وحالة اعتمادها (للمشرف)All plans with their approval state (admin)

curl -X GET https://web-crawler.aleem-ai.com/v2/zahif/admin/plans \
  -H "Authorization: Bearer zh-YOUR_KEY"

PUT`/v2/zahif/admin/plans/{id}`

تعديل خطة أو اعتماد أسعارها (قرار المالك)Edit or approve a plan's prices (owner decision)

المعاملParameter	الموضعIn	الوصفDescription
`id` *	path	Plan id

حقول الطلبRequest fields

curl -X PUT https://web-crawler.aleem-ai.com/v2/zahif/admin/plans/JOB_ID \
  -H "Authorization: Bearer zh-YOUR_KEY"

GET`/v2/zahif/admin/price-table`

قواعد احتساب الرصيد (للمشرف)Credit rules (admin view)

curl -X GET https://web-crawler.aleem-ai.com/v2/zahif/admin/price-table \
  -H "Authorization: Bearer zh-YOUR_KEY"

POST`/v2/zahif/admin/quote`

تسعير أي عملية بالرصيد (للمشرف)Quote any operation (admin)

حقول الطلبRequest fields

الحقلField	النوعType	الوصفDescription
`op` *	`string`
`units`	`object`
`request`	`object`

curl -X POST https://web-crawler.aleem-ai.com/v2/zahif/admin/quote \
  -H "Authorization: Bearer zh-YOUR_KEY"

SOURCE/openapi.json

١٢12

متصفح الوكيلBrowser

١٦ نقاط نهاية.16 endpoints.

POST`/v2/zahif/browser/sessions`

إنشاء جلسة متصفح للوكيل بمفاتيحها الأربعةCreate an agent-browser session (placement, display, presence, control)

حقول الطلبRequest fields

الحقلField	النوعType	الوصفDescription
`placement`	`"auto" \| "serverless_edge" \| "serverless_container" \| "server" \| "device"` = "auto"
`display`	`"none" \| "virtual" \| "real"` = "none"
`presence`	`"off" \| "natural" \| "visible"` = "off"	Human-like behaviour: off \| natural \| visible (cursor overlay and captions)
`control`	`"autonomous" \| "supervised" \| "handoff"` = "autonomous"
`stealth`	`boolean` = false
`profile`	`string`	Persistent named profile (cookies + storage, encrypted)
`deviceId`	`string`	Required for placement=device
`viewport`	`object`
`locale`	`string`
`timezone`	`string`
`mobile`	`boolean`
`timeoutSec`	`integer`
`recording`	`boolean`
`startUrl`	`string`
`settings`	`SettingsOverride`	Per-request settings (see GET /v2/zahif/settings/schema)

curl -X POST https://web-crawler.aleem-ai.com/v2/zahif/browser/sessions \
  -H "Authorization: Bearer zh-YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"placement":"auto","display":"virtual","presence":"natural","control":"supervised","startUrl":"https://example.com","timeoutSec":600}'

مثال الاستجابةResponse example

{
  "success": true,
  "session": {
    "id": "bs_7f3a",
    "placement": "serverless_edge",
    "display": "virtual",
    "presence": "natural",
    "control": "supervised",
    "status": "ready",
    "url": "https://ar.wikipedia.org/wiki/الرياض",
    "liveViewUrl": "https://web-crawler.aleem-ai.com/app/browser/bs_7f3a",
    "creditsUsed": 2
  }
}

GET`/v2/zahif/browser/sessions`

عرض جلسات المتصفحList browser sessions

curl -X GET https://web-crawler.aleem-ai.com/v2/zahif/browser/sessions \
  -H "Authorization: Bearer zh-YOUR_KEY"

GET`/v2/zahif/browser/sessions/{id}`

حالة جلسة متصفحGet a browser session

المعاملParameter	الموضعIn	الوصفDescription
`id` *	path	Browser session id

curl -X GET https://web-crawler.aleem-ai.com/v2/zahif/browser/sessions/JOB_ID \
  -H "Authorization: Bearer zh-YOUR_KEY"

مثال الاستجابةResponse example

{
  "success": true,
  "session": {
    "id": "bs_7f3a",
    "placement": "serverless_edge",
    "display": "virtual",
    "presence": "natural",
    "control": "supervised",
    "status": "ready",
    "url": "https://ar.wikipedia.org/wiki/الرياض",
    "liveViewUrl": "https://web-crawler.aleem-ai.com/app/browser/bs_7f3a",
    "creditsUsed": 2
  }
}

DELETE`/v2/zahif/browser/sessions/{id}`

إغلاق جلسة المتصفحClose a browser session

المعاملParameter	الموضعIn	الوصفDescription
`id` *	path	Browser session id

curl -X DELETE https://web-crawler.aleem-ai.com/v2/zahif/browser/sessions/JOB_ID \
  -H "Authorization: Bearer zh-YOUR_KEY"

POST`/v2/zahif/browser/sessions/{id}/actions`

تنفيذ إجراءات في المتصفح مع لقطة اختياريةRun browser actions and optionally return a snapshot

المعاملParameter	الموضعIn	الوصفDescription
`id` *	path	Browser session id

حقول الطلبRequest fields

الحقلField	النوعType	الوصفDescription
`actions`	`BrowserAction[]`
`action`	`BrowserAction`
`snapshot`	`"aria" \| "markdown" \| "som" \| "html" \| "none"` = "none"
`maxChars`	`integer`

curl -X POST https://web-crawler.aleem-ai.com/v2/zahif/browser/sessions/JOB_ID/actions \
  -H "Authorization: Bearer zh-YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"actions":[{"type":"navigate","url":"https://example.com"},{"type":"click","ref":"e12"},{"type":"type","ref":"e7","text":"عليم زاحف الويب"},{"type":"press","key":"Enter"}],"snapshot":"aria"}'

GET`/v2/zahif/browser/sessions/{id}/snapshot`

لقطة الصفحة للوكيلPage snapshot for agents (aria refs, markdown, set-of-marks, html)

المعاملParameter	الموضعIn	الوصفDescription
`id` *	path	Browser session id
`format`	query
`maxChars`	query

curl -X GET https://web-crawler.aleem-ai.com/v2/zahif/browser/sessions/JOB_ID/snapshot \
  -H "Authorization: Bearer zh-YOUR_KEY"

مثال الاستجابةResponse example

{
  "success": true,
  "snapshot": {
    "url": "https://example.com",
    "format": "aria",
    "content": "- heading \"Example Domain\" [ref=e1]\n- link \"More information...\" [ref=e2]",
    "refs": 2
  }
}

GET`/v2/zahif/browser/sessions/{id}/screenshot`

لقطة شاشة: صورة خام افتراضياً أو JSON مع as=jsonScreenshot: raw image bytes by default, JSON {image (base64), mime} with as=json

المعاملParameter	الموضعIn	الوصفDescription
`id` *	path	Browser session id
`fullPage`	query
`marks`	query	Set-of-marks boxes over interactive elements
`as`	query	Return JSON instead of image bytes

curl -X GET https://web-crawler.aleem-ai.com/v2/zahif/browser/sessions/JOB_ID/screenshot \
  -H "Authorization: Bearer zh-YOUR_KEY"

GET`/v2/zahif/browser/sessions/{id}/live`

بث العرض الحي: أحداث SSE بإطارات JPEG وأحداث الجلسةLive view stream: Server-Sent Events of JPEG frames and session events

المعاملParameter	الموضعIn	الوصفDescription
`id` *	path	Browser session id

curl -X GET https://web-crawler.aleem-ai.com/v2/zahif/browser/sessions/JOB_ID/live \
  -H "Authorization: Bearer zh-YOUR_KEY"

POST`/v2/zahif/browser/sessions/{id}/handoff`

إيقاف الوكيل وتسليم التحكم للإنسانPause the agent and hand control to a human

المعاملParameter	الموضعIn	الوصفDescription
`id` *	path	Browser session id

حقول الطلبRequest fields

الحقلField	النوعType	الوصفDescription
`reason`	`string`

curl -X POST https://web-crawler.aleem-ai.com/v2/zahif/browser/sessions/JOB_ID/handoff \
  -H "Authorization: Bearer zh-YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"reason":"login with 2FA"}'

مثال الاستجابةResponse example

{
  "success": true,
  "session": {
    "id": "bs_7f3a",
    "placement": "serverless_edge",
    "display": "virtual",
    "presence": "natural",
    "control": "supervised",
    "status": "ready",
    "url": "https://ar.wikipedia.org/wiki/الرياض",
    "liveViewUrl": "https://web-crawler.aleem-ai.com/app/browser/bs_7f3a",
    "creditsUsed": 2
  }
}

POST`/v2/zahif/browser/sessions/{id}/resume`

إعادة التحكم للوكيلGive control back to the agent

المعاملParameter	الموضعIn	الوصفDescription
`id` *	path	Browser session id

curl -X POST https://web-crawler.aleem-ai.com/v2/zahif/browser/sessions/JOB_ID/resume \
  -H "Authorization: Bearer zh-YOUR_KEY"

مثال الاستجابةResponse example

{
  "success": true,
  "session": {
    "id": "bs_7f3a",
    "placement": "serverless_edge",
    "display": "virtual",
    "presence": "natural",
    "control": "supervised",
    "status": "ready",
    "url": "https://ar.wikipedia.org/wiki/الرياض",
    "liveViewUrl": "https://web-crawler.aleem-ai.com/app/browser/bs_7f3a",
    "creditsUsed": 2
  }
}

POST`/v2/zahif/browser/sessions/{id}/approve`

الموافقة على خطوة حساسة معلّقة أو رفضها في وضع الإشرافApprove or deny the pending risky step (supervised control)

المعاملParameter	الموضعIn	الوصفDescription
`id` *	path	Browser session id

حقول الطلبRequest fields

الحقلField	النوعType	الوصفDescription
`approvalId` *	`string`
`approve`	`boolean` = true

curl -X POST https://web-crawler.aleem-ai.com/v2/zahif/browser/sessions/JOB_ID/approve \
  -H "Authorization: Bearer zh-YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"approvalId":"ap_1","approve":true}'

POST`/v2/zahif/browser/sessions/{id}/input`

إدخال الإنسان أثناء تولّيه التحكمHuman input while in handoff (from the live view)

المعاملParameter	الموضعIn	الوصفDescription
`id` *	path	Browser session id

حقول الطلبRequest fields

الحقلField	النوعType	الوصفDescription
`events` *	`object[]`

curl -X POST https://web-crawler.aleem-ai.com/v2/zahif/browser/sessions/JOB_ID/input \
  -H "Authorization: Bearer zh-YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"events":[{"type":"click","x":420,"y":310,"button":"left"},{"type":"text","text":"عليم زاحف الويب"},{"type":"press","key":"Enter"}]}'

GET`/v2/zahif/browser/sessions/{id}/log`

سجل تدقيق إجراءات الجلسةAudit log of the session's actions

المعاملParameter	الموضعIn	الوصفDescription
`id` *	path	Browser session id
`limit`	query

curl -X GET https://web-crawler.aleem-ai.com/v2/zahif/browser/sessions/JOB_ID/log \
  -H "Authorization: Bearer zh-YOUR_KEY"

GET`/v2/zahif/browser/status`

مواضع التشغيل المتاحة والميزانيات والتسعيرAvailable placements, switches, relay endpoint, budgets and per-minute pricing

curl -X GET https://web-crawler.aleem-ai.com/v2/zahif/browser/status \
  -H "Authorization: Bearer zh-YOUR_KEY"

GET`/v2/zahif/browser/files/{sid}/{name}`

تنزيل ملف حفظته الجلسةDownload a file saved by a download or pdf action (served as an attachment)

المعاملParameter	الموضعIn	الوصفDescription
`sid` *	path	Browser session id
`name` *	path

curl -X GET https://web-crawler.aleem-ai.com/v2/zahif/browser/files/{sid}/{name} \
  -H "Authorization: Bearer zh-YOUR_KEY"

DELETE`/v2/zahif/browser/profiles/{name}`

حذف ملف متصفح محفوظDelete a stored browser profile (cookies and storage)

المعاملParameter	الموضعIn	الوصفDescription
`name` *	path

curl -X DELETE https://web-crawler.aleem-ai.com/v2/zahif/browser/profiles/{name} \
  -H "Authorization: Bearer zh-YOUR_KEY"

SOURCE/openapi.json

١1

الأجهزة المقترنةDevices

٥ نقاط نهاية.5 endpoints.

GET`/v2/zahif/browser/devices`

الأجهزة المقترنة وحالة اتصالهاList paired devices and their online state

curl -X GET https://web-crawler.aleem-ai.com/v2/zahif/browser/devices \
  -H "Authorization: Bearer zh-YOUR_KEY"

DELETE`/v2/zahif/browser/devices/{id}`

إزالة جهاز مقترنRemove a paired device

المعاملParameter	الموضعIn	الوصفDescription
`id` *	path	Device id

curl -X DELETE https://web-crawler.aleem-ai.com/v2/zahif/browser/devices/JOB_ID \
  -H "Authorization: Bearer zh-YOUR_KEY"

POST`/v2/zahif/browser/devices/pair`

إنشاء رمز اقتران من ٨ خانات صالح ١٠ دقائقCreate an 8-character pairing code (valid 10 minutes)

حقول الطلبRequest fields

الحقلField	النوعType	الوصفDescription
`name`	`string`

curl -X POST https://web-crawler.aleem-ai.com/v2/zahif/browser/devices/pair \
  -H "Authorization: Bearer zh-YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"office laptop"}'

مثال الاستجابةResponse example

{
  "success": true,
  "pairingCode": "K7Q2-M9XD",
  "expiresAt": "2026-11-03T17:20:00Z"
}

POST`/v2/zahif/browser/devices/redeem`

استبدال رمز الاقتران من الإضافة أو برنامج الترحيلRedeem a pairing code from the extension or zahif-relay (no API key; the code is the credential)

حقول الطلبRequest fields

الحقلField	النوعType	الوصفDescription
`code` *	`string`
`name`	`string`
`platform`	`string`

curl -X POST https://web-crawler.aleem-ai.com/v2/zahif/browser/devices/redeem \
  -H "Content-Type: application/json" \
  -d '{"code":"K7Q2-M9XD","name":"office laptop","platform":"chrome-extension"}'

GET`/v2/zahif/browser/relay`

اتصال WebSocket للأجهزة المقترنةWebSocket upgrade for paired devices (JSON-RPC 2.0, outbound from the device)

المعاملParameter	الموضعIn	الوصفDescription
`token`	query	Device token (or Sec-WebSocket-Protocol)

curl -X GET https://web-crawler.aleem-ai.com/v2/zahif/browser/relay

SOURCE/openapi.json

٢2

الرصيد والفوترةBilling

٨ نقاط نهاية.8 endpoints.

GET`/v2/zahif/billing`

حسابك: الحالة والخطة والفترة والرصيد وآخر الحركاتYour account: status, plan, period, balance and recent ledger

curl -X GET https://web-crawler.aleem-ai.com/v2/zahif/billing \
  -H "Authorization: Bearer zh-YOUR_KEY"

GET`/v2/zahif/billing/plans`

الخطط المتاحة دون أسعار ما لم يعتمدها المالكPublic plans (no price unless approved by the owner)

curl -X GET https://web-crawler.aleem-ai.com/v2/zahif/billing/plans \
  -H "Authorization: Bearer zh-YOUR_KEY"

GET`/v2/zahif/billing/price-table`

قواعد احتساب الرصيد لكل عمليةCredit rules per operation

curl -X GET https://web-crawler.aleem-ai.com/v2/zahif/billing/price-table \
  -H "Authorization: Bearer zh-YOUR_KEY"

POST`/v2/zahif/billing/quote`

تقدير رصيد طلب قبل تشغيلهEstimate the credits of a request before running it

حقول الطلبRequest fields

الحقلField	النوعType	الوصفDescription
`op` *	`"scrape" \| "crawl" \| "batch" \| "map" \| "search" \| "extract" \| "agent" \| "browser"`
`units`	`object`
`request`	`object`

curl -X POST https://web-crawler.aleem-ai.com/v2/zahif/billing/quote \
  -H "Authorization: Bearer zh-YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"op":"scrape","request":{"url":"https://example.com","formats":["markdown","json"]}}'

GET`/v2/zahif/billing/ledger`

حركات حسابكLedger entries of your account

المعاملParameter	الموضعIn	الوصفDescription
`limit`	query

curl -X GET https://web-crawler.aleem-ai.com/v2/zahif/billing/ledger \
  -H "Authorization: Bearer zh-YOUR_KEY"

GET`/v2/zahif/billing/statement`

كشف الحساب الشهريMonthly statement (Arabic HTML or JSON)

المعاملParameter	الموضعIn	الوصفDescription
`format`	query
`period`	query	YYYY-MM

curl -X GET https://web-crawler.aleem-ai.com/v2/zahif/billing/statement \
  -H "Authorization: Bearer zh-YOUR_KEY"

GET`/v2/zahif/billing/alerts`

تنبيهات الرصيد وسرّ التوقيعBalance alert webhook, thresholds and signing secret

curl -X GET https://web-crawler.aleem-ai.com/v2/zahif/billing/alerts \
  -H "Authorization: Bearer zh-YOUR_KEY"

PUT`/v2/zahif/billing/alerts`

ضبط رابط تنبيهات الرصيد أو مسحهSet or clear the balance alert webhook

حقول الطلبRequest fields

الحقلField	النوعType	الوصفDescription
`webhook`	`string \| null`

curl -X PUT https://web-crawler.aleem-ai.com/v2/zahif/billing/alerts \
  -H "Authorization: Bearer zh-YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"webhook":"https://hooks.example.com/billing"}'

SOURCE/openapi.json

٣3

أسماء v1 البديلةv1 aliases

١٤ نقاط نهاية.14 endpoints.

POST`/v1/scrape` v1

جلب صفحة واحدة وتحويلها إلى Markdown أو JSON أو لقطة شاشة وغيرهاv1 alias of POST /v2/scrape

حقول الطلبRequest fields

الحقلField	النوعType	الوصفDescription
`formats`	`FormatType \| FormatSpec[]`	Default ["markdown"]
`onlyMainContent`	`boolean` = true	Strip navigation, headers, footers and boilerplate
`includeTags`	`string[]`	CSS selectors to keep
`excludeTags`	`string[]`	CSS selectors to drop
`maxAge`	`integer` = 172800000	Accept a cached copy younger than this (ms)
`minAge`	`integer`	Only return a cached copy at least this old (ms)
`headers`	`object`
`waitFor`	`integer`	Extra wait after load (ms); renders with the browser
`mobile`	`boolean` = false	Mobile viewport and user agent
`skipTlsVerification`	`boolean`
`timeout`	`integer` = 60000	Request timeout (ms)
`parsers`	`string \| object[]`	Document parsers, e.g. ["pdf"]
`actions`	`Action[]`
`location`	`Location`
`removeBase64Images`	`boolean` = true
`blockAds`	`boolean` = true
`proxy`	`"basic" \| "stealth" \| "enhanced" \| "auto"`
`storeInCache`	`boolean` = true
`zeroDataRetention`	`boolean` = false	Never store page content or results
`fastMode`	`boolean`
`mode`	`Mode`	fast = سريع; extended = مطوّل قليلاً; deep = مطوّل; custom = مخصص
`settings`	`SettingsOverride`	Per-request settings (see GET /v2/zahif/settings/schema)
`url` *	`string`

curl -X POST https://web-crawler.aleem-ai.com/v1/scrape \
  -H "Authorization: Bearer zh-YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://ar.wikipedia.org/wiki/الرياض","formats":["markdown","links"],"onlyMainContent":true,"mode":"fast"}'

مثال الاستجابةResponse example

{
  "success": true,
  "data": {
    "markdown": "# الرياض\n\nالرياض عاصمة المملكة العربية السعودية…",
    "metadata": {
      "title": "الرياض - ويكيبيديا",
      "language": "ar",
      "sourceURL": "https://ar.wikipedia.org/wiki/الرياض",
      "statusCode": 200,
      "creditsUsed": 1,
      "engine": "fetch",
      "quality": 0.91,
      "cacheState": "miss"
    }
  }
}

POST`/v1/batch/scrape` v1

بدء جلب دفعة روابطv1 alias of POST /v2/batch/scrape

حقول الطلبRequest fields

الحقلField	النوعType	الوصفDescription
`formats`	`FormatType \| FormatSpec[]`	Default ["markdown"]
`onlyMainContent`	`boolean` = true	Strip navigation, headers, footers and boilerplate
`includeTags`	`string[]`	CSS selectors to keep
`excludeTags`	`string[]`	CSS selectors to drop
`maxAge`	`integer` = 172800000	Accept a cached copy younger than this (ms)
`minAge`	`integer`	Only return a cached copy at least this old (ms)
`headers`	`object`
`waitFor`	`integer`	Extra wait after load (ms); renders with the browser
`mobile`	`boolean` = false	Mobile viewport and user agent
`skipTlsVerification`	`boolean`
`timeout`	`integer` = 60000	Request timeout (ms)
`parsers`	`string \| object[]`	Document parsers, e.g. ["pdf"]
`actions`	`Action[]`
`location`	`Location`
`removeBase64Images`	`boolean` = true
`blockAds`	`boolean` = true
`proxy`	`"basic" \| "stealth" \| "enhanced" \| "auto"`
`storeInCache`	`boolean` = true
`zeroDataRetention`	`boolean` = false	Never store page content or results
`fastMode`	`boolean`
`mode`	`Mode`	fast = سريع; extended = مطوّل قليلاً; deep = مطوّل; custom = مخصص
`settings`	`SettingsOverride`	Per-request settings (see GET /v2/zahif/settings/schema)
`urls` *	`string[]`
`webhook`	`WebhookSpec`
`maxConcurrency`	`integer`
`ignoreInvalidURLs`	`boolean`

curl -X POST https://web-crawler.aleem-ai.com/v1/batch/scrape \
  -H "Authorization: Bearer zh-YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"urls":["https://example.com","https://example.org"],"formats":["markdown"]}'

مثال الاستجابةResponse example

{
  "success": true,
  "id": "0f1e2d3c-4b5a-6978-8796-a5b4c3d2e1f0",
  "url": "https://web-crawler.aleem-ai.com/v2/batch/scrape/0f1e2d3c-4b5a-6978-8796-a5b4c3d2e1f0",
  "invalidURLs": []
}

GET`/v1/batch/scrape/{id}` v1

حالة الدفعة ونتائجهاv1 alias of GET /v2/batch/scrape/{id}

المعاملParameter	الموضعIn	الوصفDescription
`id` *	path	Job id
`skip`	query	Results to skip (paging)
`limit`	query	Max results in this page

curl -X GET https://web-crawler.aleem-ai.com/v1/batch/scrape/JOB_ID \
  -H "Authorization: Bearer zh-YOUR_KEY"

مثال الاستجابةResponse example

{
  "success": true,
  "status": "scraping",
  "total": 25,
  "completed": 9,
  "creditsUsed": 9,
  "expiresAt": "2026-11-04T19:00:00.000Z",
  "next": null,
  "progress": {
    "phase": "scrape",
    "pct": 36,
    "message_ar": "تُجلب الصفحات",
    "message_en": "Scraping pages"
  },
  "data": []
}

DELETE`/v1/batch/scrape/{id}` v1

إلغاء الدفعةv1 alias of DELETE /v2/batch/scrape/{id}

المعاملParameter	الموضعIn	الوصفDescription
`id` *	path	Job id

curl -X DELETE https://web-crawler.aleem-ai.com/v1/batch/scrape/JOB_ID \
  -H "Authorization: Bearer zh-YOUR_KEY"

مثال الاستجابةResponse example

{
  "success": true,
  "status": "cancelled"
}

GET`/v1/batch/scrape/{id}/errors` v1

أخطاء الدفعةv1 alias of GET /v2/batch/scrape/{id}/errors

المعاملParameter	الموضعIn	الوصفDescription
`id` *	path	Job id

curl -X GET https://web-crawler.aleem-ai.com/v1/batch/scrape/JOB_ID/errors \
  -H "Authorization: Bearer zh-YOUR_KEY"

POST`/v1/crawl` v1

بدء زحف موقعv1 alias of POST /v2/crawl

حقول الطلبRequest fields

الحقلField	النوعType	الوصفDescription
`url` *	`string`
`prompt`	`string`	Natural-language crawl intent
`excludePaths`	`string[]`	Regex patterns
`includePaths`	`string[]`	Regex patterns
`maxDiscoveryDepth`	`integer`
`sitemap`	`"include" \| "only" \| "skip"` = "include"
`ignoreQueryParameters`	`boolean`
`regexOnFullURL`	`boolean`
`limit`	`integer` = 10000
`crawlEntireDomain`	`boolean`
`allowExternalLinks`	`boolean`
`allowSubdomains`	`boolean`
`delay`	`number`	Seconds between requests
`maxConcurrency`	`integer`
`webhook`	`WebhookSpec`
`scrapeOptions`	`ScrapeOptions`
`zeroDataRetention`	`boolean`
`mode`	`Mode`	fast = سريع; extended = مطوّل قليلاً; deep = مطوّل; custom = مخصص
`settings`	`SettingsOverride`	Per-request settings (see GET /v2/zahif/settings/schema)

curl -X POST https://web-crawler.aleem-ai.com/v1/crawl \
  -H "Authorization: Bearer zh-YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://example.com","limit":25,"maxDiscoveryDepth":2,"scrapeOptions":{"formats":["markdown"]},"webhook":{"url":"https://hooks.example.com/zahif","events":["completed","failed"]},"mode":"extended"}'

مثال الاستجابةResponse example

{
  "success": true,
  "id": "0f1e2d3c-4b5a-6978-8796-a5b4c3d2e1f0",
  "url": "https://web-crawler.aleem-ai.com/v2/crawl/0f1e2d3c-4b5a-6978-8796-a5b4c3d2e1f0"
}

GET`/v1/crawl/{id}` v1

حالة الزحف ونتائجهv1 alias of GET /v2/crawl/{id}

المعاملParameter	الموضعIn	الوصفDescription
`id` *	path	Job id
`skip`	query	Results to skip (paging)
`limit`	query	Max results in this page

curl -X GET https://web-crawler.aleem-ai.com/v1/crawl/JOB_ID \
  -H "Authorization: Bearer zh-YOUR_KEY"

مثال الاستجابةResponse example

{
  "success": true,
  "status": "scraping",
  "total": 25,
  "completed": 9,
  "creditsUsed": 9,
  "expiresAt": "2026-11-04T19:00:00.000Z",
  "next": null,
  "progress": {
    "phase": "scrape",
    "pct": 36,
    "message_ar": "تُجلب الصفحات",
    "message_en": "Scraping pages"
  },
  "data": []
}

DELETE`/v1/crawl/{id}` v1

إلغاء الزحفv1 alias of DELETE /v2/crawl/{id}

المعاملParameter	الموضعIn	الوصفDescription
`id` *	path	Job id

curl -X DELETE https://web-crawler.aleem-ai.com/v1/crawl/JOB_ID \
  -H "Authorization: Bearer zh-YOUR_KEY"

مثال الاستجابةResponse example

{
  "success": true,
  "status": "cancelled"
}

GET`/v1/crawl/{id}/errors` v1

أخطاء الزحفv1 alias of GET /v2/crawl/{id}/errors

المعاملParameter	الموضعIn	الوصفDescription
`id` *	path	Job id

curl -X GET https://web-crawler.aleem-ai.com/v1/crawl/JOB_ID/errors \
  -H "Authorization: Bearer zh-YOUR_KEY"

POST`/v1/map` v1

اكتشاف روابط الموقع مع ترتيبها بكلمة بحث اختيارياًv1 alias of POST /v2/map

حقول الطلبRequest fields

الحقلField	النوعType	الوصفDescription
`url` *	`string`
`search`	`string`	Rank links by relevance to this term (BM25)
`sitemap`	`"include" \| "only" \| "skip"`
`includeSubdomains`	`boolean`
`ignoreQueryParameters`	`boolean`
`limit`	`integer` = 5000
`timeout`	`integer`
`location`	`Location`
`mode`	`Mode`	fast = سريع; extended = مطوّل قليلاً; deep = مطوّل; custom = مخصص
`settings`	`SettingsOverride`	Per-request settings (see GET /v2/zahif/settings/schema)

curl -X POST https://web-crawler.aleem-ai.com/v1/map \
  -H "Authorization: Bearer zh-YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://example.com","search":"pricing","limit":100}'

مثال الاستجابةResponse example

{
  "success": true,
  "links": [
    {
      "url": "https://example.com/pricing",
      "title": "Pricing"
    }
  ]
}

POST`/v1/search` v1

بحث في الويب والأخبار والصور بدمج مصادر مجانية متعددة مع جلب النتائج اختيارياًv1 alias of POST /v2/search

حقول الطلبRequest fields

الحقلField	النوعType	الوصفDescription
`query` *	`string`
`limit`	`integer` = 5
`sources`	`"web" \| "news" \| "images" \| object[]`
`categories`	`"github" \| "research" \| "pdf" \| object[]`
`tbs`	`string`	Time filter, e.g. qdr:d, qdr:w, qdr:m, qdr:y
`location`	`string`
`country`	`string`
`timeout`	`integer`
`ignoreInvalidURLs`	`boolean`
`scrapeOptions`	`ScrapeOptions`
`mode`	`Mode`	fast = سريع; extended = مطوّل قليلاً; deep = مطوّل; custom = مخصص
`settings`	`SettingsOverride`	Per-request settings (see GET /v2/zahif/settings/schema)

curl -X POST https://web-crawler.aleem-ai.com/v1/search \
  -H "Authorization: Bearer zh-YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"query":"عجز الميزانية السعودية 2026","limit":5,"sources":["web","news"],"mode":"extended"}'

مثال الاستجابةResponse example

{
  "success": true,
  "data": {
    "web": [
      {
        "url": "https://example.com/a",
        "title": "…",
        "description": "…",
        "position": 1,
        "source": "bing+ddg"
      }
    ]
  }
}

POST`/v1/extract` v1

بدء استخراج بيانات منظمة من روابط أو من الويب بمخطط أو تعليماتv1 alias of POST /v2/extract

حقول الطلبRequest fields

الحقلField	النوعType	الوصفDescription
`urls`	`string[]`	URLs; a trailing /* expands to the site
`prompt`	`string`
`schema`	`object`
`enableWebSearch`	`boolean`
`ignoreSitemap`	`boolean`
`includeSubdomains`	`boolean`
`showSources`	`boolean`
`scrapeOptions`	`ScrapeOptions`
`ignoreInvalidURLs`	`boolean`
`mode`	`Mode`	fast = سريع; extended = مطوّل قليلاً; deep = مطوّل; custom = مخصص
`settings`	`SettingsOverride`	Per-request settings (see GET /v2/zahif/settings/schema)

curl -X POST https://web-crawler.aleem-ai.com/v1/extract \
  -H "Authorization: Bearer zh-YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"urls":["https://example.com/*"],"prompt":"Company name and pricing plans","schema":{"type":"object","properties":{"company":{"type":"string"},"plans":{"type":"array","items":{"type":"string"}}}}}'

مثال الاستجابةResponse example

{
  "success": true,
  "id": "0f1e2d3c-4b5a-6978-8796-a5b4c3d2e1f0",
  "url": "https://web-crawler.aleem-ai.com/v2/extract/0f1e2d3c-4b5a-6978-8796-a5b4c3d2e1f0"
}

GET`/v1/extract/{id}` v1

حالة الاستخراج ونتيجتهv1 alias of GET /v2/extract/{id}

المعاملParameter	الموضعIn	الوصفDescription
`id` *	path	Job id

curl -X GET https://web-crawler.aleem-ai.com/v1/extract/JOB_ID \
  -H "Authorization: Bearer zh-YOUR_KEY"

مثال الاستجابةResponse example

{
  "success": true,
  "status": "scraping",
  "total": 25,
  "completed": 9,
  "creditsUsed": 9,
  "expiresAt": "2026-11-04T19:00:00.000Z",
  "next": null,
  "progress": {
    "phase": "scrape",
    "pct": 36,
    "message_ar": "تُجلب الصفحات",
    "message_en": "Scraping pages"
  },
  "data": []
}

GET`/v1/team/credit-usage` v1

استهلاك الرصيد بصيغة v1v1 credit usage ({data: {remaining_credits}})

curl -X GET https://web-crawler.aleem-ai.com/v1/team/credit-usage \
  -H "Authorization: Bearer zh-YOUR_KEY"

SOURCE/openapi.json

٤4

المخططاتSchemas

أهم أشكال البيانات.Key data shapes.

ScrapeOptions

الحقلField	النوعType	الوصفDescription
`formats`	`FormatType \| FormatSpec[]`	Default ["markdown"]
`onlyMainContent`	`boolean` = true	Strip navigation, headers, footers and boilerplate
`includeTags`	`string[]`	CSS selectors to keep
`excludeTags`	`string[]`	CSS selectors to drop
`maxAge`	`integer` = 172800000	Accept a cached copy younger than this (ms)
`minAge`	`integer`	Only return a cached copy at least this old (ms)
`headers`	`object`
`waitFor`	`integer`	Extra wait after load (ms); renders with the browser
`mobile`	`boolean` = false	Mobile viewport and user agent
`skipTlsVerification`	`boolean`
`timeout`	`integer` = 60000	Request timeout (ms)
`parsers`	`string \| object[]`	Document parsers, e.g. ["pdf"]
`actions`	`Action[]`
`location`	`Location`
`removeBase64Images`	`boolean` = true
`blockAds`	`boolean` = true
`proxy`	`"basic" \| "stealth" \| "enhanced" \| "auto"`
`storeInCache`	`boolean` = true
`zeroDataRetention`	`boolean` = false	Never store page content or results
`fastMode`	`boolean`
`mode`	`Mode`	fast = سريع; extended = مطوّل قليلاً; deep = مطوّل; custom = مخصص
`settings`	`SettingsOverride`	Per-request settings (see GET /v2/zahif/settings/schema)

Document

الحقلField	النوعType	الوصفDescription
`markdown`	`string`
`html`	`string`
`rawHtml`	`string`
`links`	`string[]`
`images`	`string[]`
`screenshot`	`string`	URL or base64
`summary`	`string`
`json`	`any`
`changeTracking`	`any`
`branding`	`any`
`attributes`	`any`
`answer`	`string`
`actions`	`object`
`warning`	`string`
`metadata` *	`DocumentMetadata`

DocumentMetadata

الحقلField	النوعType	الوصفDescription
`title`	`string`
`description`	`string`
`language`	`string`
`sourceURL` *	`string`
`url`	`string`
`statusCode` *	`integer`
`contentType`	`string`
`error`	`string`
`scrapeId`	`string`
`cacheState`	`"hit" \| "miss"`
`cachedAt`	`string`
`creditsUsed`	`number`
`engine`	`string`	Aleem AI Web Crawler extra: engine that produced the result
`elapsedMs`	`integer`
`quality`	`number`	Aleem AI Web Crawler extra: extraction quality 0..1

JobView

الحقلField	النوعType	الوصفDescription
`success`	`boolean`
`id`	`string`
`kind`	`"crawl" \| "batch" \| "extract" \| "agent"`
`status`	`"scraping" \| "processing" \| "completed" \| "failed" \| "cancelled"`
`total`	`integer`
`completed`	`integer`
`creditsUsed`	`number`
`expiresAt`	`string`
`next`	`string \| null`	URL of the next page of results
`data`	`any`
`sources`	`object[]`
`error`	`string`
`progress`	`object`

SettingSpec

الحقلField	النوعType	الوصفDescription
`key` *	`string`
`group` *	`string`
`type` *	`"bool" \| "int" \| "float" \| "enum" \| "string" \| "list"`
`defaults` *	`object`
`label_ar` *	`string`
`label_en` *	`string`
`help_ar`	`string`
`help_en`	`string`
`min`	`number`
`max`	`number`
`options`	`string[]`

Firecrawl علامة تجارية لمالكها، ولا ارتباط بين «عليم زاحف الويب» وبينها.Firecrawl is a trademark of its owner; Aleem AI Web Crawler is not affiliated with it.

النظامSystem

GET/health

GET/bot

GET/v2/zahif/capabilities

جلب صفحةScrape

POST/v2/scrape

دفعاتBatch

POST/v2/batch/scrape

GET/v2/batch/scrape/{id}

DELETE/v2/batch/scrape/{id}

GET/v2/batch/scrape/{id}/errors

زحفCrawl

POST/v2/crawl

GET/v2/crawl/{id}

DELETE/v2/crawl/{id}

GET/v2/crawl/{id}/errors

GET/v2/crawl/active

POST/v2/crawl/params-preview

خريطة الموقعMap

POST/v2/map

بحثSearch

POST/v2/search

استخراج منظمExtract

POST/v2/extract

GET/v2/extract/{id}

وكيل البحثResearch

POST/v2/agent

GET/v2/agent/{id}

DELETE/v2/agent/{id}

GET/v2/zahif/research/{id}

DELETE/v2/zahif/research/{id}

POST/v2/zahif/research

الحساب والاستهلاكAccount

GET/v2/team/credit-usage

GET/v2/team/token-usage

GET/v2/team/queue-status

GET/v2/zahif/usage

GET/v2/concurrency-check

GET/v2/zahif/me

GET/v2/zahif/webhook-secret

GET/v2/zahif/files/{key}

الإعداداتSettings

GET/v2/zahif/settings

PUT/v2/zahif/settings

GET/v2/zahif/settings/schema

الإدارةAdmin

GET/v2/zahif/keys

POST/v2/zahif/keys

DELETE/v2/zahif/keys/{id}

GET/v2/zahif/settings/owner

PUT/v2/zahif/settings/owner

GET/v2/zahif/keys/{id}/policy

PUT/v2/zahif/keys/{id}/policy

POST/v2/zahif/bench/score

POST/v2/zahif/bench/answer

GET/v2/zahif/selftest

GET/v2/zahif/admin/accounts

POST/v2/zahif/admin/accounts

GET/v2/zahif/admin/accounts/{id}

PATCH/v2/zahif/admin/accounts/{id}

POST/v2/zahif/admin/accounts/{id}

POST/v2/zahif/admin/accounts/{id}/suspend

POST/v2/zahif/admin/accounts/{id}/resume

POST/v2/zahif/admin/accounts/{id}/cancel

POST/v2/zahif/admin/accounts/{id}/plan

POST/v2/zahif/admin/accounts/{id}/credits

GET/v2/zahif/admin/accounts/{id}/keys

POST/v2/zahif/admin/accounts/{id}/keys

DELETE/v2/zahif/admin/accounts/{id}/keys/{keyId}

GET/v2/zahif/admin/accounts/{id}/usage

GET/v2/zahif/admin/accounts/{id}/ledger

GET/v2/zahif/admin/accounts/{id}/statement

GET/v2/zahif/admin/plans

PUT/v2/zahif/admin/plans/{id}

GET/v2/zahif/admin/price-table

POST/v2/zahif/admin/quote

متصفح الوكيلBrowser

POST/v2/zahif/browser/sessions

GET/v2/zahif/browser/sessions

GET/v2/zahif/browser/sessions/{id}

GET`/health`

GET`/bot`

GET`/v2/zahif/capabilities`

POST`/v2/scrape`

POST`/v2/batch/scrape`

GET`/v2/batch/scrape/{id}`

DELETE`/v2/batch/scrape/{id}`

GET`/v2/batch/scrape/{id}/errors`

POST`/v2/crawl`

GET`/v2/crawl/{id}`

DELETE`/v2/crawl/{id}`

GET`/v2/crawl/{id}/errors`

GET`/v2/crawl/active`

POST`/v2/crawl/params-preview`

POST`/v2/map`

POST`/v2/search`

POST`/v2/extract`

GET`/v2/extract/{id}`

POST`/v2/agent`

GET`/v2/agent/{id}`

DELETE`/v2/agent/{id}`

GET`/v2/zahif/research/{id}`

DELETE`/v2/zahif/research/{id}`

POST`/v2/zahif/research`

GET`/v2/team/credit-usage`

GET`/v2/team/token-usage`

GET`/v2/team/queue-status`

GET`/v2/zahif/usage`

GET`/v2/concurrency-check`

GET`/v2/zahif/me`

GET`/v2/zahif/webhook-secret`

GET`/v2/zahif/files/{key}`

GET`/v2/zahif/settings`

PUT`/v2/zahif/settings`

GET`/v2/zahif/settings/schema`

GET`/v2/zahif/keys`

POST`/v2/zahif/keys`

DELETE`/v2/zahif/keys/{id}`

GET`/v2/zahif/settings/owner`

PUT`/v2/zahif/settings/owner`

GET`/v2/zahif/keys/{id}/policy`

PUT`/v2/zahif/keys/{id}/policy`

POST`/v2/zahif/bench/score`

POST`/v2/zahif/bench/answer`

GET`/v2/zahif/selftest`

GET`/v2/zahif/admin/accounts`

POST`/v2/zahif/admin/accounts`

GET`/v2/zahif/admin/accounts/{id}`

PATCH`/v2/zahif/admin/accounts/{id}`

POST`/v2/zahif/admin/accounts/{id}`

POST`/v2/zahif/admin/accounts/{id}/suspend`

POST`/v2/zahif/admin/accounts/{id}/resume`

POST`/v2/zahif/admin/accounts/{id}/cancel`

POST`/v2/zahif/admin/accounts/{id}/plan`

POST`/v2/zahif/admin/accounts/{id}/credits`

GET`/v2/zahif/admin/accounts/{id}/keys`

POST`/v2/zahif/admin/accounts/{id}/keys`

DELETE`/v2/zahif/admin/accounts/{id}/keys/{keyId}`

GET`/v2/zahif/admin/accounts/{id}/usage`

GET`/v2/zahif/admin/accounts/{id}/ledger`

GET`/v2/zahif/admin/accounts/{id}/statement`

GET`/v2/zahif/admin/plans`

PUT`/v2/zahif/admin/plans/{id}`

GET`/v2/zahif/admin/price-table`

POST`/v2/zahif/admin/quote`

POST`/v2/zahif/browser/sessions`

GET`/v2/zahif/browser/sessions`

GET`/v2/zahif/browser/sessions/{id}`

DELETE`/v2/zahif/browser/sessions/{id}`

POST`/v2/zahif/browser/sessions/{id}/actions`

GET`/v2/zahif/browser/sessions/{id}/snapshot`

GET`/v2/zahif/browser/sessions/{id}/screenshot`

GET`/v2/zahif/browser/sessions/{id}/live`

POST`/v2/zahif/browser/sessions/{id}/handoff`

POST`/v2/zahif/browser/sessions/{id}/resume`

POST`/v2/zahif/browser/sessions/{id}/approve`

POST`/v2/zahif/browser/sessions/{id}/input`

GET`/v2/zahif/browser/sessions/{id}/log`

GET`/v2/zahif/browser/status`

GET`/v2/zahif/browser/files/{sid}/{name}`