مرجع الواجهة البرمجية
المواصفة الكاملة متاحة بصيغة JSON: openapi.json. الخادم الإنتاجي: https://api.execlogic.com.sa/api/v1. العارض أدناه للقراءة فقط (لا يرسل طلبات).
المسارات بحسب المجموعة
account
| الطريقة | المسار | الوصف |
|---|---|---|
PATCH | /api/v1/account | PATCH /api/v1/account |
GET | /api/v1/account/consents | GET /api/v1/account/consents |
DELETE | /api/v1/account/consents/cross-border | DELETE /api/v1/account/consents/cross-border |
POST | /api/v1/account/consents/cross-border | POST /api/v1/account/consents/cross-border |
PUT | /api/v1/account/consents/privacy-preferences | PUT /api/v1/account/consents/privacy-preferences |
GET | /api/v1/account/data | GET /api/v1/account/data |
POST | /api/v1/account/export | POST /api/v1/account/export |
agent
| الطريقة | المسار | الوصف |
|---|---|---|
GET | /api/v1/agent/ollama/ping | GET /api/v1/agent/ollama/ping |
GET | /api/v1/agent/ollama/status | GET /api/v1/agent/ollama/status |
POST | /api/v1/agent/run | POST /api/v1/agent/run |
GET | /api/v1/agent/runs | GET /api/v1/agent/runs |
GET | /api/v1/agent/runs/{id} | GET /api/v1/agent/runs/{id} |
GET | /api/v1/agent/runs/{id}/stream | GET /api/v1/agent/runs/{id}/stream |
GET | /api/v1/agent/runs/live/stream | GET /api/v1/agent/runs/live/stream |
GET | /api/v1/agent/stats | GET /api/v1/agent/stats |
POST | /api/v1/agent/transcribe | POST /api/v1/agent/transcribe |
ai
| الطريقة | المسار | الوصف |
|---|---|---|
POST | /api/v1/ai/generate-workflow | POST /api/v1/ai/generate-workflow |
ai-assist
| الطريقة | المسار | الوصف |
|---|---|---|
POST | /api/v1/ai-assist | POST /api/v1/ai-assist |
POST | /api/v1/ai-assist/generate-workflow | POST /api/v1/ai-assist/generate-workflow |
GET | /api/v1/ai-assist/health | GET /api/v1/ai-assist/health |
analytics
| الطريقة | المسار | الوصف |
|---|---|---|
GET | /api/v1/analytics/workflows | GET /api/v1/analytics/workflows |
GET | /api/v1/analytics/workflows/{id} | GET /api/v1/analytics/workflows/{id} |
api-keys
| الطريقة | المسار | الوصف |
|---|---|---|
GET | /api/v1/api-keys | GET /api/v1/api-keys |
POST | /api/v1/api-keys | POST /api/v1/api-keys |
DELETE | /api/v1/api-keys/{id} | DELETE /api/v1/api-keys/{id} |
POST | /api/v1/api-keys/{id}/rotate | POST /api/v1/api-keys/{id}/rotate |
archivist
| الطريقة | المسار | الوصف |
|---|---|---|
GET | /api/v1/archivist/analytics | GET /api/v1/archivist/analytics |
GET | /api/v1/archivist/evidence-pack | GET /api/v1/archivist/evidence-pack |
GET | /api/v1/archivist/pii-summary | GET /api/v1/archivist/pii-summary |
GET | /api/v1/archivist/runs/{id}/guardian-receipt | GET /api/v1/archivist/runs/{id}/guardian-receipt |
GET | /api/v1/archivist/runs/{id}/replay | GET /api/v1/archivist/runs/{id}/replay |
assistant
| الطريقة | المسار | الوصف |
|---|---|---|
POST | /api/v1/assistant/agent/confirm | POST /api/v1/assistant/agent/confirm |
POST | /api/v1/assistant/agent/reject | POST /api/v1/assistant/agent/reject |
POST | /api/v1/assistant/agent/run | POST /api/v1/assistant/agent/run |
POST | /api/v1/assistant/chat | POST /api/v1/assistant/chat |
GET | /api/v1/assistant/conversations | GET /api/v1/assistant/conversations |
DELETE | /api/v1/assistant/conversations/{id} | DELETE /api/v1/assistant/conversations/{id} |
GET | /api/v1/assistant/conversations/{id} | GET /api/v1/assistant/conversations/{id} |
GET | /api/v1/assistant/email/drafts | GET /api/v1/assistant/email/drafts |
POST | /api/v1/assistant/email/drafts/{id}/approve | POST /api/v1/assistant/email/drafts/{id}/approve |
POST | /api/v1/assistant/email/drafts/{id}/reject | POST /api/v1/assistant/email/drafts/{id}/reject |
POST | /api/v1/assistant/messages | POST /api/v1/assistant/messages |
POST | /api/v1/assistant/schedule/confirm | POST /api/v1/assistant/schedule/confirm |
audit
| الطريقة | المسار | الوصف |
|---|---|---|
GET | /api/v1/audit/me | GET /api/v1/audit/me |
GET | /api/v1/audit/query | GET /api/v1/audit/query |
GET | /api/v1/audit/verify | GET /api/v1/audit/verify |
GET | /api/v1/audit/verify/{date} | GET /api/v1/audit/verify/{date} |
auth
| الطريقة | المسار | الوصف |
|---|---|---|
GET | /api/v1/auth/apple | GET /api/v1/auth/apple |
POST | /api/v1/auth/apple/callback | POST /api/v1/auth/apple/callback |
POST | /api/v1/auth/exchange | POST /api/v1/auth/exchange |
GET | /api/v1/auth/google | GET /api/v1/auth/google |
GET | /api/v1/auth/google/callback | GET /api/v1/auth/google/callback |
GET | /api/v1/auth/identities | GET /api/v1/auth/identities |
DELETE | /api/v1/auth/identities/{provider} | DELETE /api/v1/auth/identities/{provider} |
POST | /api/v1/auth/login | POST /api/v1/auth/login |
POST | /api/v1/auth/logout | POST /api/v1/auth/logout |
POST | /api/v1/auth/logout-all | POST /api/v1/auth/logout-all |
POST | /api/v1/auth/magic-link | POST /api/v1/auth/magic-link |
POST | /api/v1/auth/magic-link/verify | POST /api/v1/auth/magic-link/verify |
DELETE | /api/v1/auth/me | DELETE /api/v1/auth/me |
GET | /api/v1/auth/me | GET /api/v1/auth/me |
GET | /api/v1/auth/methods | GET /api/v1/auth/methods |
DELETE | /api/v1/auth/mfa | DELETE /api/v1/auth/mfa |
POST | /api/v1/auth/mfa/enroll | POST /api/v1/auth/mfa/enroll |
POST | /api/v1/auth/mfa/enroll-verify | POST /api/v1/auth/mfa/enroll-verify |
POST | /api/v1/auth/mfa/recovery-codes | POST /api/v1/auth/mfa/recovery-codes |
POST | /api/v1/auth/mfa/setup | POST /api/v1/auth/mfa/setup |
GET | /api/v1/auth/mfa/status | GET /api/v1/auth/mfa/status |
POST | /api/v1/auth/mfa/verify | POST /api/v1/auth/mfa/verify |
POST | /api/v1/auth/mfa/verify-setup | POST /api/v1/auth/mfa/verify-setup |
GET | /api/v1/auth/oidc/callback | GET /api/v1/auth/oidc/callback |
GET | /api/v1/auth/oidc/login | GET /api/v1/auth/oidc/login |
POST | /api/v1/auth/password/forgot | POST /api/v1/auth/password/forgot |
POST | /api/v1/auth/password/reset | POST /api/v1/auth/password/reset |
POST | /api/v1/auth/phone/enroll | POST /api/v1/auth/phone/enroll |
POST | /api/v1/auth/phone/enroll-verify | POST /api/v1/auth/phone/enroll-verify |
POST | /api/v1/auth/phone/send | POST /api/v1/auth/phone/send |
POST | /api/v1/auth/phone/verify | POST /api/v1/auth/phone/verify |
POST | /api/v1/auth/refresh | POST /api/v1/auth/refresh |
POST | /api/v1/auth/register | POST /api/v1/auth/register |
POST | /api/v1/auth/resend-verification | POST /api/v1/auth/resend-verification |
POST | /api/v1/auth/saml/acs | POST /api/v1/auth/saml/acs |
GET | /api/v1/auth/sessions | GET /api/v1/auth/sessions |
DELETE | /api/v1/auth/sessions/{jti} | DELETE /api/v1/auth/sessions/{jti} |
POST | /api/v1/auth/verify-email | POST /api/v1/auth/verify-email |
POST | /auth/login | Authenticate with email and password |
POST | /auth/logout | Revoke one refresh session |
POST | /auth/logout-all | Revoke all sessions for the current user |
POST | /auth/refresh | Rotate a refresh token |
POST | /auth/register | Register an account |
GET | /auth/sessions | List active refresh sessions |
billing
| الطريقة | المسار | الوصف |
|---|---|---|
POST | /api/v1/billing/cancel | POST /api/v1/billing/cancel |
POST | /api/v1/billing/change-tier | POST /api/v1/billing/change-tier |
GET | /api/v1/billing/checkout/{intentId} | GET /api/v1/billing/checkout/{intentId} |
POST | /api/v1/billing/checkout/stripe | POST /api/v1/billing/checkout/stripe |
POST | /api/v1/billing/checkout/tap | POST /api/v1/billing/checkout/tap |
GET | /api/v1/billing/invoices | GET /api/v1/billing/invoices |
GET | /api/v1/billing/invoices/{id} | GET /api/v1/billing/invoices/{id} |
POST | /api/v1/billing/manual-activate | POST /api/v1/billing/manual-activate |
POST | /api/v1/billing/resume | POST /api/v1/billing/resume |
POST | /api/v1/billing/subscribe | POST /api/v1/billing/subscribe |
GET | /api/v1/billing/subscription | GET /api/v1/billing/subscription |
POST | /api/v1/billing/upgrade | POST /api/v1/billing/upgrade |
GET | /api/v1/billing/usage | GET /api/v1/billing/usage |
GET | /api/v1/billing/usage/history | GET /api/v1/billing/usage/history |
POST | /billing/checkout/stripe | Unavailable: Stripe checkout is owner-gated |
POST | /billing/checkout/tap | Unavailable: Tap checkout is owner-gated |
POST | /billing/manual-activate | Unavailable: in-platform paid activation is owner-gated |
GET | /billing/subscription | Get the current subscription |
GET | /billing/usage | Get the current usage-period snapshot |
chains
| الطريقة | المسار | الوصف |
|---|---|---|
GET | /api/v1/chains | GET /api/v1/chains |
POST | /api/v1/chains | POST /api/v1/chains |
DELETE | /api/v1/chains/{id} | DELETE /api/v1/chains/{id} |
GET | /api/v1/chains/{id} | GET /api/v1/chains/{id} |
PUT | /api/v1/chains/{id} | PUT /api/v1/chains/{id} |
POST | /api/v1/chains/{id}/run | POST /api/v1/chains/{id}/run |
connector-submissions
| الطريقة | المسار | الوصف |
|---|---|---|
GET | /api/v1/connector-submissions | GET /api/v1/connector-submissions |
POST | /api/v1/connector-submissions | POST /api/v1/connector-submissions |
PATCH | /api/v1/connector-submissions/{id} | PATCH /api/v1/connector-submissions/{id} |
contact
| الطريقة | المسار | الوصف |
|---|---|---|
POST | /api/v1/contact | POST /api/v1/contact |
dx
| الطريقة | المسار | الوصف |
|---|---|---|
GET | /api/v1/dx/assessment | GET /api/v1/dx/assessment |
POST | /api/v1/dx/assessment | POST /api/v1/dx/assessment |
GET | /api/v1/dx/questions | GET /api/v1/dx/questions |
execute
| الطريقة | المسار | الوصف |
|---|---|---|
POST | /api/v1/execute/{id}/run | POST /api/v1/execute/{id}/run |
health
| الطريقة | المسار | الوصف |
|---|---|---|
GET | /api/v1/health | GET /api/v1/health |
GET | /api/v1/health/db | GET /api/v1/health/db |
GET | /api/v1/health/models | GET /api/v1/health/models |
GET | /api/v1/health/providers | GET /api/v1/health/providers |
leads
| الطريقة | المسار | الوصف |
|---|---|---|
POST | /api/v1/leads/contact | POST /api/v1/leads/contact |
POST | /api/v1/leads/demo | POST /api/v1/leads/demo |
POST | /api/v1/leads/newsletter | POST /api/v1/leads/newsletter |
livecapture
| الطريقة | المسار | الوصف |
|---|---|---|
POST | /api/v1/livecapture/analyze-video | POST /api/v1/livecapture/analyze-video |
POST | /api/v1/livecapture/events | POST /api/v1/livecapture/events |
GET | /api/v1/livecapture/session/{id} | GET /api/v1/livecapture/session/{id} |
POST | /api/v1/livecapture/session/start | POST /api/v1/livecapture/session/start |
POST | /api/v1/livecapture/session/stop | POST /api/v1/livecapture/session/stop |
marketplace
| الطريقة | المسار | الوصف |
|---|---|---|
GET | /api/v1/marketplace | GET /api/v1/marketplace |
GET | /api/v1/marketplace/{id} | GET /api/v1/marketplace/{id} |
PUT | /api/v1/marketplace/{id}/rate | PUT /api/v1/marketplace/{id}/rate |
POST | /api/v1/marketplace/import/{id} | POST /api/v1/marketplace/import/{id} |
POST | /api/v1/marketplace/publish/{id} | POST /api/v1/marketplace/publish/{id} |
GET | /api/v1/marketplace/search | GET /api/v1/marketplace/search |
mcp
| الطريقة | المسار | الوصف |
|---|---|---|
POST | /mcp/chat | Send a consent-gated MCP chat request |
notifications
| الطريقة | المسار | الوصف |
|---|---|---|
GET | /api/v1/notifications | GET /api/v1/notifications |
PATCH | /api/v1/notifications/{id}/read | PATCH /api/v1/notifications/{id}/read |
PATCH | /api/v1/notifications/read-all | PATCH /api/v1/notifications/read-all |
privacy
| الطريقة | المسار | الوصف |
|---|---|---|
POST | /api/v1/privacy/check | POST /api/v1/privacy/check |
GET | /api/v1/privacy/compliance | GET /api/v1/privacy/compliance |
GET | /api/v1/privacy/logs | GET /api/v1/privacy/logs |
POST | /api/v1/privacy/redact | POST /api/v1/privacy/redact |
GET | /api/v1/privacy/stats | GET /api/v1/privacy/stats |
queue
| الطريقة | المسار | الوصف |
|---|---|---|
GET | /api/v1/queue/dead-letter | GET /api/v1/queue/dead-letter |
POST | /api/v1/queue/dead-letter/{id}/replay | POST /api/v1/queue/dead-letter/{id}/replay |
referrals
| الطريقة | المسار | الوصف |
|---|---|---|
POST | /api/v1/referrals | POST /api/v1/referrals |
GET | /api/v1/referrals/me | GET /api/v1/referrals/me |
GET | /api/v1/referrals/resolve/{code} | GET /api/v1/referrals/resolve/{code} |
system
| الطريقة | المسار | الوصف |
|---|---|---|
GET | /api/v1/system/health | GET /api/v1/system/health |
templates
| الطريقة | المسار | الوصف |
|---|---|---|
GET | /api/v1/templates | GET /api/v1/templates |
GET | /api/v1/templates/{id} | GET /api/v1/templates/{id} |
POST | /api/v1/templates/{id}/import | POST /api/v1/templates/{id}/import |
triggers
| الطريقة | المسار | الوصف |
|---|---|---|
GET | /api/v1/triggers | GET /api/v1/triggers |
POST | /api/v1/triggers | POST /api/v1/triggers |
DELETE | /api/v1/triggers/{id} | DELETE /api/v1/triggers/{id} |
POST | /api/v1/triggers/{id}/fire | POST /api/v1/triggers/{id}/fire |
PATCH | /api/v1/triggers/{id}/toggle | PATCH /api/v1/triggers/{id}/toggle |
POST | /api/v1/triggers/schedule | POST /api/v1/triggers/schedule |
PATCH | /api/v1/triggers/schedule/{id}/toggle | PATCH /api/v1/triggers/schedule/{id}/toggle |
POST | /api/v1/triggers/schedule/preview | POST /api/v1/triggers/schedule/preview |
POST | /api/v1/triggers/webhook | POST /api/v1/triggers/webhook |
GET | /api/v1/triggers/workflow/{workflowId} | GET /api/v1/triggers/workflow/{workflowId} |
variables
| الطريقة | المسار | الوصف |
|---|---|---|
GET | /api/v1/variables | GET /api/v1/variables |
POST | /api/v1/variables | POST /api/v1/variables |
DELETE | /api/v1/variables/{id} | DELETE /api/v1/variables/{id} |
PUT | /api/v1/variables/{id} | PUT /api/v1/variables/{id} |
GET | /api/v1/variables/{id}/reveal | GET /api/v1/variables/{id}/reveal |
webhooks
| الطريقة | المسار | الوصف |
|---|---|---|
POST | /api/v1/webhooks/stripe | POST /api/v1/webhooks/stripe |
POST | /api/v1/webhooks/tap | POST /api/v1/webhooks/tap |
POST | /webhooks/stripe | Unavailable: Stripe event processing is owner-gated |
POST | /webhooks/tap | Unavailable: Tap event processing is owner-gated |
workflows
| الطريقة | المسار | الوصف |
|---|---|---|
GET | /api/v1/workflows | GET /api/v1/workflows |
POST | /api/v1/workflows | POST /api/v1/workflows |
DELETE | /api/v1/workflows/{id} | DELETE /api/v1/workflows/{id} |
GET | /api/v1/workflows/{id} | GET /api/v1/workflows/{id} |
PUT | /api/v1/workflows/{id} | PUT /api/v1/workflows/{id} |
POST | /api/v1/workflows/{id}/execute | POST /api/v1/workflows/{id}/execute |
GET | /api/v1/workflows/{id}/execution-requirements | GET /api/v1/workflows/{id}/execution-requirements |
GET | /api/v1/workflows/{id}/executions | GET /api/v1/workflows/{id}/executions |
GET | /api/v1/workflows/{id}/export | GET /api/v1/workflows/{id}/export |
GET | /api/v1/workflows/executions/{executionId} | GET /api/v1/workflows/executions/{executionId} |
POST | /api/v1/workflows/from-template/{templateId} | POST /api/v1/workflows/from-template/{templateId} |
POST | /api/v1/workflows/import | POST /api/v1/workflows/import |
zatca
| الطريقة | المسار | الوصف |
|---|---|---|
POST | /api/v1/zatca/generate | POST /api/v1/zatca/generate |
POST | /api/v1/zatca/sign | POST /api/v1/zatca/sign |
POST | /zatca/generate | Generate a local development XML/QR artifact; not clearance or certification |
POST | /zatca/sign | Apply a development signature as an administrator; submission is unavailable |