{ "openapi": "3.0.0", "info": { "title": "Execra API — Exec Logic AI Solutions", "version": "7.0.0", "description": "Enterprise Workflow Automation Platform", "contact": { "name": "Exec Logic AI Solutions", "email": "hello@execraai.com", "url": "https://execlogic.com.sa" }, "license": { "name": "BUSL-1.1", "url": "https://docs.execlogic.com.sa/license" } }, "servers": [ { "url": "https://api.execlogic.com.sa/api/v1", "description": "Production" } ], "components": { "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT" } } }, "security": [ { "bearerAuth": [] } ], "paths": { "/api/v1/account": { "patch": { "summary": "PATCH /api/v1/account", "tags": [ "account" ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/account/consents": { "get": { "summary": "GET /api/v1/account/consents", "tags": [ "account" ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/account/consents/cross-border": { "delete": { "summary": "DELETE /api/v1/account/consents/cross-border", "tags": [ "account" ], "responses": { "200": { "description": "Successful response" } } }, "post": { "summary": "POST /api/v1/account/consents/cross-border", "tags": [ "account" ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/account/consents/privacy-preferences": { "put": { "summary": "PUT /api/v1/account/consents/privacy-preferences", "tags": [ "account" ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/account/data": { "get": { "summary": "GET /api/v1/account/data", "tags": [ "account" ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/account/export": { "post": { "summary": "POST /api/v1/account/export", "tags": [ "account" ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/agent/ollama/ping": { "get": { "summary": "GET /api/v1/agent/ollama/ping", "tags": [ "agent" ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/agent/ollama/status": { "get": { "summary": "GET /api/v1/agent/ollama/status", "tags": [ "agent" ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/agent/run": { "post": { "summary": "POST /api/v1/agent/run", "tags": [ "agent" ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/agent/runs": { "get": { "summary": "GET /api/v1/agent/runs", "tags": [ "agent" ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/agent/runs/live/stream": { "get": { "summary": "GET /api/v1/agent/runs/live/stream", "tags": [ "agent" ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/agent/runs/{id}": { "get": { "summary": "GET /api/v1/agent/runs/{id}", "tags": [ "agent" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/agent/runs/{id}/stream": { "get": { "summary": "GET /api/v1/agent/runs/{id}/stream", "tags": [ "agent" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/agent/stats": { "get": { "summary": "GET /api/v1/agent/stats", "tags": [ "agent" ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/agent/transcribe": { "post": { "summary": "POST /api/v1/agent/transcribe", "tags": [ "agent" ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/ai-assist": { "post": { "summary": "POST /api/v1/ai-assist", "tags": [ "ai-assist" ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/ai-assist/generate-workflow": { "post": { "summary": "POST /api/v1/ai-assist/generate-workflow", "tags": [ "ai-assist" ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/ai-assist/health": { "get": { "summary": "GET /api/v1/ai-assist/health", "tags": [ "ai-assist" ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/ai/generate-workflow": { "post": { "summary": "POST /api/v1/ai/generate-workflow", "tags": [ "ai" ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/analytics/workflows": { "get": { "summary": "GET /api/v1/analytics/workflows", "tags": [ "analytics" ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/analytics/workflows/{id}": { "get": { "summary": "GET /api/v1/analytics/workflows/{id}", "tags": [ "analytics" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/api-keys": { "get": { "summary": "GET /api/v1/api-keys", "tags": [ "api-keys" ], "responses": { "200": { "description": "Successful response" } } }, "post": { "summary": "POST /api/v1/api-keys", "tags": [ "api-keys" ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/api-keys/{id}": { "delete": { "summary": "DELETE /api/v1/api-keys/{id}", "tags": [ "api-keys" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/api-keys/{id}/rotate": { "post": { "summary": "POST /api/v1/api-keys/{id}/rotate", "tags": [ "api-keys" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/archivist/analytics": { "get": { "summary": "GET /api/v1/archivist/analytics", "tags": [ "archivist" ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/archivist/evidence-pack": { "get": { "summary": "GET /api/v1/archivist/evidence-pack", "tags": [ "archivist" ], "x-execra-feature-flag": "isgovernedtyEvidenceEnabled", "responses": { "200": { "description": "Successful response" }, "404": { "description": "Not found — this operation exists only while isgovernedtyEvidenceEnabled() is true" } } } }, "/api/v1/archivist/pii-summary": { "get": { "summary": "GET /api/v1/archivist/pii-summary", "tags": [ "archivist" ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/archivist/runs/{id}/guardian-receipt": { "get": { "summary": "GET /api/v1/archivist/runs/{id}/guardian-receipt", "tags": [ "archivist" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "x-execra-feature-flag": "isGuardianReceiptEnabled", "responses": { "200": { "description": "Successful response" }, "404": { "description": "Not found — this operation exists only while isGuardianReceiptEnabled() is true" } } } }, "/api/v1/archivist/runs/{id}/replay": { "get": { "summary": "GET /api/v1/archivist/runs/{id}/replay", "tags": [ "archivist" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/assistant/agent/confirm": { "post": { "summary": "POST /api/v1/assistant/agent/confirm", "tags": [ "assistant" ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/assistant/agent/reject": { "post": { "summary": "POST /api/v1/assistant/agent/reject", "tags": [ "assistant" ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/assistant/agent/run": { "post": { "summary": "POST /api/v1/assistant/agent/run", "tags": [ "assistant" ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/assistant/chat": { "post": { "summary": "POST /api/v1/assistant/chat", "tags": [ "assistant" ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/assistant/conversations": { "get": { "summary": "GET /api/v1/assistant/conversations", "tags": [ "assistant" ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/assistant/conversations/{id}": { "delete": { "summary": "DELETE /api/v1/assistant/conversations/{id}", "tags": [ "assistant" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" } } }, "get": { "summary": "GET /api/v1/assistant/conversations/{id}", "tags": [ "assistant" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/assistant/email/drafts": { "get": { "summary": "GET /api/v1/assistant/email/drafts", "tags": [ "assistant" ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/assistant/email/drafts/{id}/approve": { "post": { "summary": "POST /api/v1/assistant/email/drafts/{id}/approve", "tags": [ "assistant" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/assistant/email/drafts/{id}/reject": { "post": { "summary": "POST /api/v1/assistant/email/drafts/{id}/reject", "tags": [ "assistant" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/assistant/messages": { "post": { "summary": "POST /api/v1/assistant/messages", "tags": [ "assistant" ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/assistant/schedule/confirm": { "post": { "summary": "POST /api/v1/assistant/schedule/confirm", "tags": [ "assistant" ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/audit/me": { "get": { "summary": "GET /api/v1/audit/me", "tags": [ "audit" ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/audit/query": { "get": { "summary": "GET /api/v1/audit/query", "tags": [ "audit" ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/audit/verify": { "get": { "summary": "GET /api/v1/audit/verify", "tags": [ "audit" ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/audit/verify/{date}": { "get": { "summary": "GET /api/v1/audit/verify/{date}", "tags": [ "audit" ], "parameters": [ { "name": "date", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/auth/apple": { "get": { "summary": "GET /api/v1/auth/apple", "tags": [ "auth" ], "x-execra-feature-flag": "isAppleLoginEnabled", "responses": { "200": { "description": "Successful response" }, "404": { "description": "Not found — this operation exists only while isAppleLoginEnabled() is true" } } } }, "/api/v1/auth/apple/callback": { "post": { "summary": "POST /api/v1/auth/apple/callback", "tags": [ "auth" ], "x-execra-feature-flag": "isAppleLoginEnabled", "responses": { "200": { "description": "Successful response" }, "404": { "description": "Not found — this operation exists only while isAppleLoginEnabled() is true" } } } }, "/api/v1/auth/exchange": { "post": { "summary": "POST /api/v1/auth/exchange", "tags": [ "auth" ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/auth/google": { "get": { "summary": "GET /api/v1/auth/google", "tags": [ "auth" ], "x-execra-feature-flag": "isGoogleLoginEnabled", "responses": { "200": { "description": "Successful response" }, "404": { "description": "Not found — this operation exists only while isGoogleLoginEnabled() is true" } } } }, "/api/v1/auth/google/callback": { "get": { "summary": "GET /api/v1/auth/google/callback", "tags": [ "auth" ], "x-execra-feature-flag": "isGoogleLoginEnabled", "responses": { "200": { "description": "Successful response" }, "404": { "description": "Not found — this operation exists only while isGoogleLoginEnabled() is true" } } } }, "/api/v1/auth/identities": { "get": { "summary": "GET /api/v1/auth/identities", "tags": [ "auth" ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/auth/identities/{provider}": { "delete": { "summary": "DELETE /api/v1/auth/identities/{provider}", "tags": [ "auth" ], "parameters": [ { "name": "provider", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/auth/login": { "post": { "summary": "POST /api/v1/auth/login", "tags": [ "auth" ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/auth/logout": { "post": { "summary": "POST /api/v1/auth/logout", "tags": [ "auth" ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/auth/logout-all": { "post": { "summary": "POST /api/v1/auth/logout-all", "tags": [ "auth" ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/auth/magic-link": { "post": { "summary": "POST /api/v1/auth/magic-link", "tags": [ "auth" ], "x-execra-feature-flag": "isMagicLinkEnabled", "responses": { "200": { "description": "Successful response" }, "404": { "description": "Not found — this operation exists only while isMagicLinkEnabled() is true" } } } }, "/api/v1/auth/magic-link/verify": { "post": { "summary": "POST /api/v1/auth/magic-link/verify", "tags": [ "auth" ], "x-execra-feature-flag": "isMagicLinkEnabled", "responses": { "200": { "description": "Successful response" }, "404": { "description": "Not found — this operation exists only while isMagicLinkEnabled() is true" } } } }, "/api/v1/auth/me": { "delete": { "summary": "DELETE /api/v1/auth/me", "tags": [ "auth" ], "responses": { "200": { "description": "Successful response" } } }, "get": { "summary": "GET /api/v1/auth/me", "tags": [ "auth" ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/auth/methods": { "get": { "summary": "GET /api/v1/auth/methods", "tags": [ "auth" ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/auth/mfa": { "delete": { "summary": "DELETE /api/v1/auth/mfa", "tags": [ "auth" ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/auth/mfa/enroll": { "post": { "summary": "POST /api/v1/auth/mfa/enroll", "tags": [ "auth" ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/auth/mfa/enroll-verify": { "post": { "summary": "POST /api/v1/auth/mfa/enroll-verify", "tags": [ "auth" ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/auth/mfa/recovery-codes": { "post": { "summary": "POST /api/v1/auth/mfa/recovery-codes", "tags": [ "auth" ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/auth/mfa/setup": { "post": { "summary": "POST /api/v1/auth/mfa/setup", "tags": [ "auth" ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/auth/mfa/status": { "get": { "summary": "GET /api/v1/auth/mfa/status", "tags": [ "auth" ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/auth/mfa/verify": { "post": { "summary": "POST /api/v1/auth/mfa/verify", "tags": [ "auth" ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/auth/mfa/verify-setup": { "post": { "summary": "POST /api/v1/auth/mfa/verify-setup", "tags": [ "auth" ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/auth/oidc/callback": { "get": { "summary": "GET /api/v1/auth/oidc/callback", "tags": [ "auth" ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/auth/oidc/login": { "get": { "summary": "GET /api/v1/auth/oidc/login", "tags": [ "auth" ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/auth/password/forgot": { "post": { "summary": "POST /api/v1/auth/password/forgot", "tags": [ "auth" ], "x-execra-feature-flag": "isPasswordResetEnabled", "responses": { "200": { "description": "Successful response" }, "404": { "description": "Not found — this operation exists only while isPasswordResetEnabled() is true" } } } }, "/api/v1/auth/password/reset": { "post": { "summary": "POST /api/v1/auth/password/reset", "tags": [ "auth" ], "x-execra-feature-flag": "isPasswordResetEnabled", "responses": { "200": { "description": "Successful response" }, "404": { "description": "Not found — this operation exists only while isPasswordResetEnabled() is true" } } } }, "/api/v1/auth/phone/enroll": { "post": { "summary": "POST /api/v1/auth/phone/enroll", "tags": [ "auth" ], "x-execra-feature-flag": "isPhoneOtpEnabled", "responses": { "200": { "description": "Successful response" }, "404": { "description": "Not found — this operation exists only while isPhoneOtpEnabled() is true" } } } }, "/api/v1/auth/phone/enroll-verify": { "post": { "summary": "POST /api/v1/auth/phone/enroll-verify", "tags": [ "auth" ], "x-execra-feature-flag": "isPhoneOtpEnabled", "responses": { "200": { "description": "Successful response" }, "404": { "description": "Not found — this operation exists only while isPhoneOtpEnabled() is true" } } } }, "/api/v1/auth/phone/send": { "post": { "summary": "POST /api/v1/auth/phone/send", "tags": [ "auth" ], "x-execra-feature-flag": "isPhoneOtpEnabled", "responses": { "200": { "description": "Successful response" }, "404": { "description": "Not found — this operation exists only while isPhoneOtpEnabled() is true" } } } }, "/api/v1/auth/phone/verify": { "post": { "summary": "POST /api/v1/auth/phone/verify", "tags": [ "auth" ], "x-execra-feature-flag": "isPhoneOtpEnabled", "responses": { "200": { "description": "Successful response" }, "404": { "description": "Not found — this operation exists only while isPhoneOtpEnabled() is true" } } } }, "/api/v1/auth/refresh": { "post": { "summary": "POST /api/v1/auth/refresh", "tags": [ "auth" ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/auth/register": { "post": { "summary": "POST /api/v1/auth/register", "tags": [ "auth" ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/auth/resend-verification": { "post": { "summary": "POST /api/v1/auth/resend-verification", "tags": [ "auth" ], "x-execra-feature-flag": "isEmailVerifyEnabled", "responses": { "200": { "description": "Successful response" }, "404": { "description": "Not found — this operation exists only while isEmailVerifyEnabled() is true" } } } }, "/api/v1/auth/saml/acs": { "post": { "summary": "POST /api/v1/auth/saml/acs", "tags": [ "auth" ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/auth/sessions": { "get": { "summary": "GET /api/v1/auth/sessions", "tags": [ "auth" ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/auth/sessions/{jti}": { "delete": { "summary": "DELETE /api/v1/auth/sessions/{jti}", "tags": [ "auth" ], "parameters": [ { "name": "jti", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/auth/verify-email": { "post": { "summary": "POST /api/v1/auth/verify-email", "tags": [ "auth" ], "x-execra-feature-flag": "isEmailVerifyEnabled", "responses": { "200": { "description": "Successful response" }, "404": { "description": "Not found — this operation exists only while isEmailVerifyEnabled() is true" } } } }, "/api/v1/billing/cancel": { "post": { "summary": "POST /api/v1/billing/cancel", "tags": [ "billing" ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/billing/change-tier": { "post": { "summary": "POST /api/v1/billing/change-tier", "tags": [ "billing" ], "x-execra-feature-flag": "isAutomatedBillingEnabled", "responses": { "200": { "description": "Successful response" }, "404": { "description": "Not found — this operation exists only while isAutomatedBillingEnabled() is true" } } } }, "/api/v1/billing/checkout/stripe": { "post": { "summary": "POST /api/v1/billing/checkout/stripe", "tags": [ "billing" ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/billing/checkout/tap": { "post": { "summary": "POST /api/v1/billing/checkout/tap", "tags": [ "billing" ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/billing/checkout/{intentId}": { "get": { "summary": "GET /api/v1/billing/checkout/{intentId}", "tags": [ "billing" ], "parameters": [ { "name": "intentId", "in": "path", "required": true, "schema": { "type": "string" } } ], "x-execra-feature-flag": "isAutomatedBillingEnabled", "responses": { "200": { "description": "Successful response" }, "404": { "description": "Not found — this operation exists only while isAutomatedBillingEnabled() is true" } } } }, "/api/v1/billing/invoices": { "get": { "summary": "GET /api/v1/billing/invoices", "tags": [ "billing" ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/billing/invoices/{id}": { "get": { "summary": "GET /api/v1/billing/invoices/{id}", "tags": [ "billing" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/billing/manual-activate": { "post": { "summary": "POST /api/v1/billing/manual-activate", "tags": [ "billing" ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/billing/resume": { "post": { "summary": "POST /api/v1/billing/resume", "tags": [ "billing" ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/billing/subscribe": { "post": { "summary": "POST /api/v1/billing/subscribe", "tags": [ "billing" ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/billing/subscription": { "get": { "summary": "GET /api/v1/billing/subscription", "tags": [ "billing" ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/billing/upgrade": { "post": { "summary": "POST /api/v1/billing/upgrade", "tags": [ "billing" ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/billing/usage": { "get": { "summary": "GET /api/v1/billing/usage", "tags": [ "billing" ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/billing/usage/history": { "get": { "summary": "GET /api/v1/billing/usage/history", "tags": [ "billing" ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/chains": { "get": { "summary": "GET /api/v1/chains", "tags": [ "chains" ], "responses": { "200": { "description": "Successful response" } } }, "post": { "summary": "POST /api/v1/chains", "tags": [ "chains" ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/chains/{id}": { "delete": { "summary": "DELETE /api/v1/chains/{id}", "tags": [ "chains" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" } } }, "get": { "summary": "GET /api/v1/chains/{id}", "tags": [ "chains" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" } } }, "put": { "summary": "PUT /api/v1/chains/{id}", "tags": [ "chains" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/chains/{id}/run": { "post": { "summary": "POST /api/v1/chains/{id}/run", "tags": [ "chains" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/connector-submissions": { "get": { "summary": "GET /api/v1/connector-submissions", "tags": [ "connector-submissions" ], "responses": { "200": { "description": "Successful response" } } }, "post": { "summary": "POST /api/v1/connector-submissions", "tags": [ "connector-submissions" ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/connector-submissions/{id}": { "patch": { "summary": "PATCH /api/v1/connector-submissions/{id}", "tags": [ "connector-submissions" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/contact": { "post": { "summary": "POST /api/v1/contact", "tags": [ "contact" ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/dx/assessment": { "get": { "summary": "GET /api/v1/dx/assessment", "tags": [ "dx" ], "responses": { "200": { "description": "Successful response" } } }, "post": { "summary": "POST /api/v1/dx/assessment", "tags": [ "dx" ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/dx/questions": { "get": { "summary": "GET /api/v1/dx/questions", "tags": [ "dx" ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/execute/{id}/run": { "post": { "summary": "POST /api/v1/execute/{id}/run", "tags": [ "execute" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/health": { "get": { "summary": "GET /api/v1/health", "tags": [ "health" ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/health/db": { "get": { "summary": "GET /api/v1/health/db", "tags": [ "health" ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/health/models": { "get": { "summary": "GET /api/v1/health/models", "tags": [ "health" ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/health/providers": { "get": { "summary": "GET /api/v1/health/providers", "tags": [ "health" ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/leads/contact": { "post": { "summary": "POST /api/v1/leads/contact", "tags": [ "leads" ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/leads/demo": { "post": { "summary": "POST /api/v1/leads/demo", "tags": [ "leads" ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/leads/newsletter": { "post": { "summary": "POST /api/v1/leads/newsletter", "tags": [ "leads" ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/livecapture/analyze-video": { "post": { "summary": "POST /api/v1/livecapture/analyze-video", "tags": [ "livecapture" ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/livecapture/events": { "post": { "summary": "POST /api/v1/livecapture/events", "tags": [ "livecapture" ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/livecapture/session/start": { "post": { "summary": "POST /api/v1/livecapture/session/start", "tags": [ "livecapture" ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/livecapture/session/stop": { "post": { "summary": "POST /api/v1/livecapture/session/stop", "tags": [ "livecapture" ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/livecapture/session/{id}": { "get": { "summary": "GET /api/v1/livecapture/session/{id}", "tags": [ "livecapture" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/marketplace": { "get": { "summary": "GET /api/v1/marketplace", "tags": [ "marketplace" ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/marketplace/import/{id}": { "post": { "summary": "POST /api/v1/marketplace/import/{id}", "tags": [ "marketplace" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/marketplace/publish/{id}": { "post": { "summary": "POST /api/v1/marketplace/publish/{id}", "tags": [ "marketplace" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/marketplace/search": { "get": { "summary": "GET /api/v1/marketplace/search", "tags": [ "marketplace" ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/marketplace/{id}": { "get": { "summary": "GET /api/v1/marketplace/{id}", "tags": [ "marketplace" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/marketplace/{id}/rate": { "put": { "summary": "PUT /api/v1/marketplace/{id}/rate", "tags": [ "marketplace" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/notifications": { "get": { "summary": "GET /api/v1/notifications", "tags": [ "notifications" ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/notifications/read-all": { "patch": { "summary": "PATCH /api/v1/notifications/read-all", "tags": [ "notifications" ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/notifications/{id}/read": { "patch": { "summary": "PATCH /api/v1/notifications/{id}/read", "tags": [ "notifications" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/privacy/check": { "post": { "summary": "POST /api/v1/privacy/check", "tags": [ "privacy" ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/privacy/compliance": { "get": { "summary": "GET /api/v1/privacy/compliance", "tags": [ "privacy" ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/privacy/logs": { "get": { "summary": "GET /api/v1/privacy/logs", "tags": [ "privacy" ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/privacy/redact": { "post": { "summary": "POST /api/v1/privacy/redact", "tags": [ "privacy" ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/privacy/stats": { "get": { "summary": "GET /api/v1/privacy/stats", "tags": [ "privacy" ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/queue/dead-letter": { "get": { "summary": "GET /api/v1/queue/dead-letter", "tags": [ "queue" ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/queue/dead-letter/{id}/replay": { "post": { "summary": "POST /api/v1/queue/dead-letter/{id}/replay", "tags": [ "queue" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/referrals": { "post": { "summary": "POST /api/v1/referrals", "tags": [ "referrals" ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/referrals/me": { "get": { "summary": "GET /api/v1/referrals/me", "tags": [ "referrals" ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/referrals/resolve/{code}": { "get": { "summary": "GET /api/v1/referrals/resolve/{code}", "tags": [ "referrals" ], "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/system/health": { "get": { "summary": "GET /api/v1/system/health", "tags": [ "system" ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/templates": { "get": { "summary": "GET /api/v1/templates", "tags": [ "templates" ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/templates/{id}": { "get": { "summary": "GET /api/v1/templates/{id}", "tags": [ "templates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/templates/{id}/import": { "post": { "summary": "POST /api/v1/templates/{id}/import", "tags": [ "templates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/triggers": { "get": { "summary": "GET /api/v1/triggers", "tags": [ "triggers" ], "responses": { "200": { "description": "Successful response" } } }, "post": { "summary": "POST /api/v1/triggers", "tags": [ "triggers" ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/triggers/schedule": { "post": { "summary": "POST /api/v1/triggers/schedule", "tags": [ "triggers" ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/triggers/schedule/preview": { "post": { "summary": "POST /api/v1/triggers/schedule/preview", "tags": [ "triggers" ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/triggers/schedule/{id}/toggle": { "patch": { "summary": "PATCH /api/v1/triggers/schedule/{id}/toggle", "tags": [ "triggers" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/triggers/webhook": { "post": { "summary": "POST /api/v1/triggers/webhook", "tags": [ "triggers" ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/triggers/workflow/{workflowId}": { "get": { "summary": "GET /api/v1/triggers/workflow/{workflowId}", "tags": [ "triggers" ], "parameters": [ { "name": "workflowId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/triggers/{id}": { "delete": { "summary": "DELETE /api/v1/triggers/{id}", "tags": [ "triggers" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/triggers/{id}/fire": { "post": { "summary": "POST /api/v1/triggers/{id}/fire", "tags": [ "triggers" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/triggers/{id}/toggle": { "patch": { "summary": "PATCH /api/v1/triggers/{id}/toggle", "tags": [ "triggers" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/variables": { "get": { "summary": "GET /api/v1/variables", "tags": [ "variables" ], "responses": { "200": { "description": "Successful response" } } }, "post": { "summary": "POST /api/v1/variables", "tags": [ "variables" ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/variables/{id}": { "delete": { "summary": "DELETE /api/v1/variables/{id}", "tags": [ "variables" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" } } }, "put": { "summary": "PUT /api/v1/variables/{id}", "tags": [ "variables" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/variables/{id}/reveal": { "get": { "summary": "GET /api/v1/variables/{id}/reveal", "tags": [ "variables" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/webhooks/stripe": { "post": { "summary": "POST /api/v1/webhooks/stripe", "tags": [ "webhooks" ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/webhooks/tap": { "post": { "summary": "POST /api/v1/webhooks/tap", "tags": [ "webhooks" ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/workflows": { "get": { "summary": "GET /api/v1/workflows", "tags": [ "workflows" ], "responses": { "200": { "description": "Successful response" } } }, "post": { "summary": "POST /api/v1/workflows", "tags": [ "workflows" ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/workflows/executions/{executionId}": { "get": { "summary": "GET /api/v1/workflows/executions/{executionId}", "tags": [ "workflows" ], "parameters": [ { "name": "executionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/workflows/from-template/{templateId}": { "post": { "summary": "POST /api/v1/workflows/from-template/{templateId}", "tags": [ "workflows" ], "parameters": [ { "name": "templateId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/workflows/import": { "post": { "summary": "POST /api/v1/workflows/import", "tags": [ "workflows" ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/workflows/{id}": { "delete": { "summary": "DELETE /api/v1/workflows/{id}", "tags": [ "workflows" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" } } }, "get": { "summary": "GET /api/v1/workflows/{id}", "tags": [ "workflows" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" } } }, "put": { "summary": "PUT /api/v1/workflows/{id}", "tags": [ "workflows" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/workflows/{id}/execute": { "post": { "summary": "POST /api/v1/workflows/{id}/execute", "tags": [ "workflows" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/workflows/{id}/execution-requirements": { "get": { "summary": "GET /api/v1/workflows/{id}/execution-requirements", "tags": [ "workflows" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/workflows/{id}/executions": { "get": { "summary": "GET /api/v1/workflows/{id}/executions", "tags": [ "workflows" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/workflows/{id}/export": { "get": { "summary": "GET /api/v1/workflows/{id}/export", "tags": [ "workflows" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/zatca/generate": { "post": { "summary": "POST /api/v1/zatca/generate", "tags": [ "zatca" ], "responses": { "200": { "description": "Successful response" } } } }, "/api/v1/zatca/sign": { "post": { "summary": "POST /api/v1/zatca/sign", "tags": [ "zatca" ], "responses": { "200": { "description": "Successful response" } } } }, "/auth/register": { "post": { "tags": [ "auth" ], "security": [], "summary": "Register an account", "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Authentication or authorization failed", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/auth/login": { "post": { "tags": [ "auth" ], "security": [], "summary": "Authenticate with email and password", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Authentication or authorization failed", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/auth/refresh": { "post": { "tags": [ "auth" ], "security": [], "summary": "Rotate a refresh token", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Authentication or authorization failed", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "A concurrent rotation won; retry with the replacement session", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Serializable rotation temporarily unavailable; retry without logging out", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/auth/logout": { "post": { "tags": [ "auth" ], "security": [], "summary": "Revoke one refresh session", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "500": { "description": "Server-side failure", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/auth/logout-all": { "post": { "tags": [ "auth" ], "summary": "Revoke all sessions for the current user", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Authentication or authorization failed", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/auth/sessions": { "get": { "tags": [ "auth" ], "summary": "List active refresh sessions", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Authentication or authorization failed", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/billing/subscription": { "get": { "tags": [ "billing" ], "summary": "Get the current subscription", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Authentication or authorization failed", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/billing/usage": { "get": { "tags": [ "billing" ], "summary": "Get the current usage-period snapshot", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Authentication or authorization failed", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/billing/checkout/tap": { "post": { "tags": [ "billing" ], "summary": "Unavailable: Tap checkout is owner-gated", "responses": { "503": { "description": "Server-side failure", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/billing/checkout/stripe": { "post": { "tags": [ "billing" ], "summary": "Unavailable: Stripe checkout is owner-gated", "responses": { "503": { "description": "Server-side failure", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/billing/manual-activate": { "post": { "tags": [ "billing" ], "summary": "Unavailable: in-platform paid activation is owner-gated", "responses": { "403": { "description": "Authentication or authorization failed", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Server-side failure", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/webhooks/tap": { "post": { "tags": [ "webhooks" ], "security": [], "summary": "Unavailable: Tap event processing is owner-gated", "responses": { "503": { "description": "Server-side failure", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/webhooks/stripe": { "post": { "tags": [ "webhooks" ], "security": [], "summary": "Unavailable: Stripe event processing is owner-gated", "responses": { "503": { "description": "Server-side failure", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/mcp/chat": { "post": { "tags": [ "mcp" ], "summary": "Send a consent-gated MCP chat request", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Authentication or authorization failed", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Authentication or authorization failed", "content": { "application/json": { "schema": { "type": "object" } } } }, "502": { "description": "Server-side failure", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/zatca/generate": { "post": { "tags": [ "zatca" ], "summary": "Generate a local development XML/QR artifact; not clearance or certification", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Authentication or authorization failed", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Authentication or authorization failed", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/zatca/sign": { "post": { "tags": [ "zatca" ], "summary": "Apply a development signature as an administrator; submission is unavailable", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Authentication or authorization failed", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Authentication or authorization failed", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Authentication or authorization failed", "content": { "application/json": { "schema": { "type": "object" } } } } } } } }, "tags": [] }