مستندات API
این فهرست از فایل openapi.yaml مخزن ساخته میشود. روش، مسیر و خلاصه همان فایل است. سند خام روی openapi.yaml سرور است.
امنیت سراسری سند، bearer یا کلید API است. مسیرهایی که security خالی دارند عمومیاند. ورود با کلید API فقط از شبکهٔ خصوصی پذیرفته میشود. POST /api/auth/token برای موضوع دلخواه توکن نمیسازد و فقط کاربر موجود را با اجازهٔ platform_admin امضا میکند.
تعداد عملیات خواندهشده از فایل: 294
294 مسیر از 294
GET /health
Liveness + capability matrix
health · عمومی
GET /openapi.yaml
OpenAPI document
health · عمومی
POST /api/auth/login
Password login, or break-glass API key from a private network
auth · عمومی
GET /api/auth/whoami
Current principal
auth · نیاز به ورود
POST /api/auth/token
Mint a JWT for an existing user (platform admin only)
auth · نیاز به ورود
GET /api/dashboard/snapshot
Dashboard aggregate snapshot
dashboard · نیاز به ورود
GET /api/agents
List projected agents for the caller's tenant
agents · نیاز به ورود
POST /api/agents
Create an agent (operator+)
agents · نیاز به ورود
GET /api/agents/{id}
Get one projected agent (tenant-owned)
agents · نیاز به ورود
DELETE /api/agents/{id}
Destroy an agent (admin only)
agents · نیاز به ورود
POST /api/agents/{id}/start
Start agent lifecycle (operator+)
agents · نیاز به ورود
POST /api/agents/{id}/pause
Pause a running agent (operator+)
agents · نیاز به ورود
POST /api/agents/{id}/resume
Resume a paused agent (operator+)
agents · نیاز به ورود
POST /api/agents/{id}/stop
Stop an agent gracefully (operator+)
agents · نیاز به ورود
GET /api/agents/{id}/history
Lifecycle state-machine transition history
agents · نیاز به ورود
GET /api/control/kill-switch
Kill switch status
control · نیاز به ورود
POST /api/control/kill-switch/trigger
Trigger emergency stop (admin)
control · نیاز به ورود
POST /api/control/kill-switch/reset
Reset kill switch (admin)
control · نیاز به ورود
GET /api/control/approvals
List approvals (durable store preferred)
control · نیاز به ورود
GET /api/control/approvals/pending
List pending approvals
control · نیاز به ورود
POST /api/control/approvals/{id}/decide
Decide an approval (operator+)
control · نیاز به ورود
GET /api/simulations
List simulations
simulations · نیاز به ورود
POST /api/simulations
Create simulation (operator+)
simulations · نیاز به ورود
POST /api/simulations/{id}/start
Start simulation
simulations · نیاز به ورود
POST /api/simulations/{id}/stop
Stop simulation
simulations · نیاز به ورود
POST /api/nlu/parse
Parse natural language intent/entities
nlu · نیاز به ورود
GET /api/knowledge-graph
Knowledge graph snapshot (Memory SSOT, tenant-filtered)
knowledge · نیاز به ورود
POST /api/knowledge-graph/nodes
Create KG node (Operator+)
knowledge · نیاز به ورود
PATCH /api/knowledge-graph/nodes/{id}
Update KG node (Operator+)
knowledge · نیاز به ورود
DELETE /api/knowledge-graph/nodes/{id}
Hard-delete KG node (Admin)
knowledge · نیاز به ورود
POST /api/knowledge-graph/edges
Create KG edge (Operator+)
knowledge · نیاز به ورود
DELETE /api/knowledge-graph/edges/{id}
Delete KG edge (Operator+)
knowledge · نیاز به ورود
GET /api/knowledge-graph/query
Query / search KG (Viewer+)
knowledge · نیاز به ورود
GET /api/knowledge-graph/path
Shortest path between nodes (Viewer+)
knowledge · نیاز به ورود
POST /api/knowledge-graph/infer
Transitive inference on a relation (Operator+)
knowledge · نیاز به ورود
GET /api/knowledge-graph/export
Export tenant-scoped knowledge graph JSON (Operator+)
knowledge · نیاز به ورود
POST /api/knowledge-graph/import
Import knowledge graph JSON (Operator+)
knowledge · نیاز به ورود
POST /api/missions/e2e
Run Phase 0 mission vertical slice (operator+)
missions · نیاز به ورود
POST /api/compose
Route a prompt via model router (operator+)
composer · نیاز به ورود
GET /api/compose/status
Which model backends are configured
composer · نیاز به ورود
POST /api/policy/dry-run
Dry-run a versioned policy pack (operator+)
policy · نیاز به ورود
GET /api/policy/example-pack
Example versioned policy pack
policy · نیاز به ورود
POST /api/evals/record
Record an eval/replay case (operator+)
evals · نیاز به ورود
POST /api/evals/run
Run all recorded eval cases (operator+)
evals · نیاز به ورود
POST /api/cloud/inventory-sync
Opt-in fleet inventory hash sync (admin; AIOS_CLOUD_PLANE=1)
cloud · نیاز به ورود
GET /api/cloud/policy-pull
Opt-in policy pull stub (admin; AIOS_CLOUD_PLANE=1)
cloud · نیاز به ورود
GET /api/a2a/agent-card
A2A v1.0 Agent Card (HMAC-signed; not SPIFFE)
a2a · عمومی
GET /.well-known/agent-card.json
A2A v1.0 well-known agent card
a2a · عمومی
GET /.well-known/agent.json
Well-known Agent Card alias
a2a · عمومی
POST /api/a2a
A2A JSON-RPC (SendMessage, SendStreamingMessage, GetTask, ListTasks, CancelTask, SubscribeToTask)
a2a · نیاز به ورود
GET /api/a2a/agents/{id}/agent-card.json
Per-agent A2A v1.0 card
a2a · نیاز به ورود
GET /api/groups
List agent groups in the caller organization
a2a · نیاز به ورود
POST /api/groups
Create a personal or organizational agent group
a2a · نیاز به ورود
GET /api/groups/{id}
Get one group, its members, and the transcript
a2a · نیاز به ورود
POST /api/groups/{id}/discuss
Run a capped group discussion and return a summary or decision
a2a · نیاز به ورود
POST /api/a2a/external
Register an external A2A agent by URL
a2a · نیاز به ورود
POST /api/a2a/external/{id}/message
SendMessage to a registered external A2A agent
a2a · نیاز به ورود
POST /api/bots/{id}/mcp
MCP JSON-RPC server for one local agent
a2a · نیاز به ورود
GET /api/auth/oidc/login
OIDC authorize URL (requires AIOS_OIDC_ISSUER + CLIENT_ID)
auth · عمومی
GET /api/auth/oidc/callback
OIDC callback / token exchange stub
auth · عمومی
POST /api/sync/export
Opt-in multi-site sync envelope (hashes only, no secrets)
sync · نیاز به ورود
GET /api/marketplace/templates
List signed templates in the local on-disk registry
marketplace · نیاز به ورود
POST /api/marketplace/templates/install
Install a verified signed template to the install directory
marketplace · نیاز به ورود
POST /api/marketplace/templates/seed-demo
Publish a signed demo IT Ops template (admin)
marketplace · نیاز به ورود
PUT /api/marketplace/seller/payout-account
Store the seller sheba in the vault
marketplace · نیاز به ورود
GET /api/marketplace/seller/payout-account
Whether a payout account is stored
marketplace · نیاز به ورود
GET /api/marketplace/seller/revenue
Seller revenue ledger
marketplace · نیاز به ورود
GET /api/marketplace/listings
Approved store listings
marketplace · نیاز به ورود
POST /api/marketplace/listings
Publish a user listing from a professional template
marketplace · نیاز به ورود
GET /api/marketplace/listings/{id}
One listing the caller may see
marketplace · نیاز به ورود
PATCH /api/marketplace/listings/{id}
Change price or version of an unsealed listing
marketplace · نیاز به ورود
POST /api/marketplace/listings/{id}/purchase
Buy an approved listing
marketplace · نیاز به ورود
GET /api/marketplace/listings/{id}/reviews
Ratings for a listing
marketplace · نیاز به ورود
POST /api/marketplace/listings/{id}/reviews
Rate a purchased listing
marketplace · نیاز به ورود
POST /api/marketplace/listings/{id}/share
Private add-to-my-agents link
marketplace · نیاز به ورود
GET /api/marketplace/admin/queue
Listings waiting for platform review
marketplace · نیاز به ورود
POST /api/marketplace/admin/listings
Publish a platform listing
marketplace · نیاز به ورود
POST /api/marketplace/admin/listings/{id}/approve
Approve a pending listing
marketplace · نیاز به ورود
POST /api/marketplace/admin/listings/{id}/reject
Reject a pending listing
marketplace · نیاز به ورود
POST /api/marketplace/admin/settlements
Record a manual settlement
marketplace · نیاز به ورود
GET /api/marketplace/purchases/{id}
Purchase plus revenue-ledger rows
marketplace · نیاز به ورود
POST /api/marketplace/purchases/{id}/install
Install a paid listing into the buyer org
marketplace · نیاز به ورود
POST /api/marketplace/purchases/{id}/refund
Refund a purchase and archive the installed agent
marketplace · نیاز به ورود
GET /api/marketplace/share/{token}
Preview a private share link
marketplace · نیاز به ورود
POST /api/marketplace/share/{token}/add
Add the shared listing to my agents
marketplace · نیاز به ورود
GET /api/marketplace/org/agents
Agents in the caller org
marketplace · نیاز به ورود
POST /api/marketplace/org/agents/{id}/share
Share one org agent by a private link
marketplace · نیاز به ورود
POST /api/connectors/servicenow/export
ServiceNow-shaped inventory export (NON-PRODUCTION until configured)
connectors · نیاز به ورود
POST /api/connectors/salesforce/export
Salesforce-shaped inventory export (NON-PRODUCTION until configured)
connectors · نیاز به ورود
GET /api/chaos/status
Dev-only chaos config (armed only when AIOS_ENV=development|dev)
chaos · نیاز به ورود
POST /api/chaos/probe
Probe tool-call chaos gate (may return 503)
chaos · نیاز به ورود
POST /api/llm/compose
Feature-flagged LLM gateway compose (quota, route, PII redaction)
llm · نیاز به ورود
GET /api/llm/models
List cached LLM model catalog (from SQLite)
llm · نیاز به ورود
POST /api/llm/models
Sync model catalog from provider /models (or AvalAI public list)
llm · نیاز به ورود
GET /api/llm/usage
Recent LLM usage and cost rows
llm · نیاز به ورود
GET /api/llm/status
Provider configuration status and model role defaults
llm · نیاز به ورود
POST /api/llm/chat
Non-streaming chat completion via aios-llm
llm · نیاز به ورود
POST /api/llm/chat/stream
SSE streaming chat completion
llm · نیاز به ورود
POST /api/llm/embeddings
Create embeddings
llm · نیاز به ورود
POST /api/llm/tool-roundtrip
Demo tool-call roundtrip (get_weather)
llm · نیاز به ورود
GET /api/bots
List bots for the caller's tenant
bots · نیاز به ورود
POST /api/bots
Create a bot (lifecycle agent + BotProfile)
bots · نیاز به ورود
GET /api/bots/gallery
First-run questions and up to three agents the caller can create
bots · نیاز به ورود
GET /api/knowledge-packs
List professional knowledge packs
bots · نیاز به ورود
GET /api/knowledge-packs/{id}
Read one knowledge pack, its sources, and its short quotations
bots · نیاز به ورود
POST /api/knowledge-packs/{id}/retrieve
Rerank pack chunks for a query
bots · نیاز به ورود
GET /api/templates
List the eight professional templates
bots · نیاز به ورود
GET /api/templates/{id}
Read one professional template
bots · نیاز به ورود
POST /api/templates/{id}/eval
Score an answer against the template pack
bots · نیاز به ورود
POST /api/bots/{id}/avatar
Store an avatar upload as metadata
bots · نیاز به ورود
POST /api/bots/{id}/setup/preview
Preview a settings patch without saving
bots · نیاز به ورود
POST /api/bots/{id}/setup/propose
Propose settings and open an approval card
bots · نیاز به ورود
GET /api/bots/{id}/config
List draft and published config versions
bots · نیاز به ورود
POST /api/bots/{id}/config/draft
Save a config draft without applying it
bots · نیاز به ورود
POST /api/bots/{id}/config/publish
Apply a version and record a new published row
bots · نیاز به ورود
POST /api/bots/{id}/config/rollback
Restore an earlier config version
bots · نیاز به ورود
GET /api/bots/{id}/config/diff
Field diff between two config versions
bots · نیاز به ورود
POST /api/bots/{id}/archive
Archive an agent
bots · نیاز به ورود
POST /api/bots/{id}/hide
Hide an agent from the default list
bots · نیاز به ورود
POST /api/bots/{id}/copy
Copy an agent profile into a new agent
bots · نیاز به ورود
POST /api/bots/{id}/threads/{tid}/archive
Archive a conversation
bots · نیاز به ورود
POST /api/bots/{id}/threads/{tid}/messages/{mid}/feedback
Like or dislike a message
bots · نیاز به ورود
POST /api/bots/{id}/files
Upload a file if the bot owner's org policy allows files
bots · نیاز به ورود
POST /api/bots/{id}/threads/{tid}/attachments
Store a thread attachment under the plan file-volume cap
bots · نیاز به ورود
GET /api/bots/{id}/threads/{tid}/attachments
List thread attachments
bots · نیاز به ورود
POST /api/bots/{id}/knowledge
Ingest a file or public URL into the bot knowledge base
bots · نیاز به ورود
GET /api/bots/{id}/knowledge
List knowledge sources and processing status
bots · نیاز به ورود
GET /api/bots/{id}/knowledge/{sid}
Chunk preview for one knowledge source
bots · نیاز به ورود
POST /api/bots/{id}/knowledge/retrieve
Retrieval test
bots · نیاز به ورود
POST /api/bots/{id}/knowledge/ask
Answer from knowledge with citations
bots · نیاز به ورود
POST /api/stt
Transcribe speech
llm · نیاز به ورود
POST /api/tts
Optional text to speech
llm · نیاز به ورود
POST /api/bots/{id}/desktop/sessions
Start the cloud desktop on demand
bots · نیاز به ورود
GET /api/bots/{id}/desktop
Live desktop WebSocket for noVNC
bots · نیاز به ورود
POST /api/bots/{id}/desktop/input
Take or release control of the cloud desktop
bots · نیاز به ورود
POST /api/bots/{id}/recordings
Start recording the user's actions on the cloud desktop
bots · نیاز به ورود
GET /api/bots/{id}/recordings/{rid}
Read a recording and pull new steps
bots · نیاز به ورود
PATCH /api/bots/{id}/recordings/{rid}
Name steps, turn inputs into variables, and mark approval
bots · نیاز به ورود
POST /api/bots/{id}/recordings/{rid}/stop
Stop recording and open review
bots · نیاز به ورود
POST /api/bots/{id}/recordings/{rid}/save
Save the reviewed flow as a confirmed skill
bots · نیاز به ورود
POST /api/bots/{id}/device/sessions
Open a device-control session
bots · نیاز به ورود
GET /api/bots/{id}
Get bot by id
bots · نیاز به ورود
PATCH /api/bots/{id}
Update bot profile fields
bots · نیاز به ورود
DELETE /api/bots/{id}
Delete bot (Admin) and destroy lifecycle agent
bots · نیاز به ورود
GET /api/bots/{id}/threads
List threads for a bot
bots · نیاز به ورود
POST /api/bots/{id}/threads
Create a chat thread
bots · نیاز به ورود
GET /api/bots/{id}/threads/{tid}
Get thread
bots · نیاز به ورود
DELETE /api/bots/{id}/threads/{tid}
Delete thread
bots · نیاز به ورود
GET /api/bots/{id}/threads/{tid}/runs/{rid}/trace
Per-run trace with steps, artifacts, and specialist children
bots · نیاز به ورود
GET /api/bots/{id}/artifacts/{aid}
Artifact metadata
bots · نیاز به ورود
GET /api/bots/{id}/artifacts/{aid}/content
Download an artifact (image, video, or file)
bots · نیاز به ورود
GET /api/bots/{id}/threads/{tid}/messages
Paginated message history
bots · نیاز به ورود
POST /api/bots/{id}/threads/{tid}/messages
Send user message; stream assistant reply as SSE
bots · نیاز به ورود
POST /api/bots/{id}/threads/{tid}/runs/{rid}/cancel
Cancel an in-flight run
bots · نیاز به ورود
GET /api/bots/{id}/memories
List bot memories
memory · نیاز به ورود
POST /api/bots/{id}/memories
Create a memory
memory · نیاز به ورود
GET /api/bots/{id}/memories/search
Search memories by text
memory · نیاز به ورود
POST /api/bots/{id}/memories/recall
Recall memories+lessons for a query (prompt injection preview)
memory · نیاز به ورود
GET /api/bots/{id}/memories/{mid}
Get one memory
memory · نیاز به ورود
PATCH /api/bots/{id}/memories/{mid}
Edit a memory
memory · نیاز به ورود
DELETE /api/bots/{id}/memories/{mid}
Delete a memory
memory · نیاز به ورود
POST /api/bots/{id}/memories/{mid}/pin
Pin or unpin a memory
memory · نیاز به ورود
POST /api/bots/{id}/feedback
Store thumbs up/down/correction lesson
memory · نیاز به ورود
GET /api/bots/{id}/lessons
List recent lessons
memory · نیاز به ورود
GET /api/bots/{id}/skills
List bot skills, including recorded flows in flow_json
memory · نیاز به ورود
POST /api/bots/{id}/skills
Draft a pending skill (SKILL.md)
memory · نیاز به ورود
POST /api/bots/{id}/skills/{sid}/confirm
Confirm a pending skill
memory · نیاز به ورود
POST /api/bots/{id}/skills/{sid}/reject
Reject a pending skill
memory · نیاز به ورود
POST /api/bots/{id}/memory/consolidate
Consolidate old episodes (LLM summary + forgetting)
memory · نیاز به ورود
POST /api/auth/setup
Create the first owner (platform admin). Fails once any user exists.
auth · عمومی
POST /api/auth/signup
Self-signup onto the free plan. The new org is not a platform admin.
auth، billing · عمومی
GET /api/auth/otp/status
Which SMS providers are configured. Never returns keys.
auth · عمومی
POST /api/auth/otp/request
Send a phone OTP (hash stored, 2 minute TTL, 5 attempts, rate limit per phone and IP). The code is not returned.
auth · عمومی
POST /api/auth/otp/verify
Verify OTP. Creates a personal org on first use (not platform admin) or logs in. Password is optional. Pending phone invitations are accepted.
auth · عمومی
GET /api/orgs
Organizations the caller belongs to. active marks the JWT org.
auth · نیاز به ورود
POST /api/orgs
Create a personal or business workspace. Caller becomes owner. Free plan, no extra signup credit.
auth · نیاز به ورود
POST /api/orgs/switch
Set the active organization and mint a new access JWT. Refresh token is unchanged.
auth · نیاز به ورود
GET /api/orgs/invitations
Pending invitations for the active org (owner or admin)
auth · نیاز به ورود
POST /api/orgs/invitations
Invite a phone number into an organization (default active org)
auth · نیاز به ورود
POST /api/orgs/invitations/{id}/accept
Accept an invitation when the account phone matches
auth · نیاز به ورود
DELETE /api/orgs/invitations/{id}
Revoke a pending invitation in the active org
auth · نیاز به ورود
GET /api/orgs/members
Members of the active org (owner or admin)
auth · نیاز به ورود
GET /api/orgs/seats
Purchased seats of plan pro or team
auth · نیاز به ورود
GET /api/orgs/budgets
Monthly member budgets in micro-USD
auth · نیاز به ورود
PUT /api/orgs/budgets/{user_id}
Set one member's monthly micro-USD quota
auth · نیاز به ورود
GET /api/orgs/policies
Organization default policy and the effective policy
auth · نیاز به ورود
PUT /api/orgs/policies
Replace the organization default policy
auth · نیاز به ورود
GET /api/orgs/policies/{user_id}
Member policy override and the effective policy
auth · نیاز به ورود
PUT /api/orgs/policies/{user_id}
Replace one member's policy override
auth · نیاز به ورود
DELETE /api/orgs/policies/{user_id}
Remove a member policy override
auth · نیاز به ورود
GET /api/orgs/usage
Usage in the current period by employee and by agent
auth · نیاز به ورود
POST /api/auth/refresh
Rotate the refresh token and issue a new 15-minute access JWT
auth · عمومی
POST /api/auth/logout
Revoke a refresh token
auth · عمومی
GET /api/auth/devices
List devices for the current user
auth · نیاز به ورود
POST /api/auth/devices
Register a device
auth · نیاز به ورود
DELETE /api/auth/devices/{id}
Revoke a device
auth · نیاز به ورود
GET /api/vault/secrets
List secret metadata for the caller org (no plaintext)
vault · نیاز به ورود
POST /api/vault/secrets
Store a secret. Plaintext is encrypted and never returned.
vault · نیاز به ورود
GET /api/vault/secrets/{name}
Secret metadata. Another org's name is 404.
vault · نیاز به ورود
DELETE /api/vault/secrets/{name}
Delete a secret in the caller org
vault · نیاز به ورود
GET /api/connectors
List connectors in the caller org
connectors · نیاز به ورود
POST /api/connectors
Register a connector
connectors · نیاز به ورود
GET /api/connectors/{id}
Get a connector. Another org's id is 404.
connectors · نیاز به ورود
DELETE /api/connectors/{id}
Delete a connector in the caller org
connectors · نیاز به ورود
GET /api/bots/{id}/routines
List routines for a bot in the caller org
routines · نیاز به ورود
POST /api/bots/{id}/routines
Create a routine
routines · نیاز به ورود
GET /api/bots/{id}/routines/{rid}
Get a routine. Cross-tenant ids return 404.
routines · نیاز به ورود
PATCH /api/bots/{id}/routines/{rid}
Update a routine
routines · نیاز به ورود
DELETE /api/bots/{id}/routines/{rid}
Delete a routine
routines · نیاز به ورود
GET /api/bots/{id}/routines/{rid}/history
Routine fire history
routines · نیاز به ورود
POST /api/bots/{id}/routines/{rid}/confirm
Confirm a proposed routine
routines · نیاز به ورود
POST /api/bots/{id}/routines/{rid}/reject
Reject a proposed routine
routines · نیاز به ورود
POST /api/bots/{id}/threads/{tid}/runs/{rid}/resume
Resume a run that is waiting on approval or was interrupted
bots · نیاز به ورود
GET /api/billing/plans
Public plan catalog (پایه، حرفهای، ویژه) and payment providers
billing · عمومی
GET /api/billing/me
Caller org balance in Toman, plan, ledger, orders, and invoices
billing · نیاز به ورود
GET /api/billing/invoices
Persian invoices for the caller org
billing · نیاز به ورود
GET /api/billing/invoices/{id}/pdf
Download a Persian invoice PDF
billing · نیاز به ورود
POST /api/billing/checkout
Start a top-up, plan, or seat checkout (sandbox or Zarinpal)
billing · نیاز به ورود
GET /api/billing/sandbox/pay
Sandbox payment page. Disabled when AIOS_ENV=production.
billing · عمومی
GET /api/billing/zarinpal/callback
Zarinpal v4 callback. Merchant id is vault secret zarinpal_merchant_id (env fallback).
billing · عمومی
PATCH /api/admin/model-prices/{id}
Set price, tier override, enabled flag, or markup (platform admin)
billing، llm · نیاز به ورود
PATCH /api/admin/billing/tax
Set the invoice tax percent (platform admin)
billing · نیاز به ورود
GET /api/llm/catalog
Model catalog filtered by the caller plan tier
llm · نیاز به ورود
GET /ws
Authenticated WebSocket dashboard stream
dashboard · نیاز به ورود
POST /api/social/connectors
Store a messenger token in the vault and register the connector
social · نیاز به ورود
POST /api/social/connectors/{id}/webhook
Register the connector webhook with the network
social · نیاز به ورود
GET /api/social/posts
List the social calendar for the caller org
social · نیاز به ورود
POST /api/social/posts
Draft a post, select the S5 image or video specialist, and open an approval card
social · نیاز به ورود
POST /api/social/posts/{id}/approve
Approve the card so the scheduled routine may publish
social · نیاز به ورود
POST /api/social/posts/{id}/reject
Reject the card and disable the routine
social · نیاز به ورود
POST /api/social/comments
Reply with the comment template, or hand a complaint to a human
social · نیاز به ورود
POST /api/social/templates
Save a comment reply template
social · نیاز به ورود
POST /api/social/webhook/{network}/{connector_id}
Inbound messenger update
social · عمومی
POST /api/widgets
Create an embeddable RTL chat widget
social · نیاز به ورود
POST /api/widgets/{id}/messages
Public widget message
social · عمومی
GET /widget/{id}
RTL chat page
social · عمومی
GET /widget/{id}/embed.js
Embed script for the RTL chat widget
social · عمومی
GET /api/admin/plans
List plans, the USD rate, and default models
platform-admin · نیاز به ورود
PATCH /api/admin/plans/{id}
Update a plan price
platform-admin · نیاز به ورود
GET /api/admin/models
Model catalog with tier, price, and markup
platform-admin · نیاز به ورود
PATCH /api/admin/models/{id}
Set a model tier override, enabled flag, or markup
platform-admin · نیاز به ورود
GET /api/admin/defaults
Default models and the USD rate
platform-admin · نیاز به ورود
PATCH /api/admin/defaults
Set the default chat model or the USD IRR rate
platform-admin · نیاز به ورود
GET /api/admin/users
List users without password hashes
platform-admin · نیاز به ورود
GET /api/admin/orgs
List organizations and their plan ids
platform-admin · نیاز به ورود
GET /api/admin/subscriptions
List subscriptions
platform-admin · نیاز به ورود
GET /api/admin/payments
List payment orders without authority tokens
platform-admin · نیاز به ورود
GET /api/admin/refunds
List refunded marketplace purchases
platform-admin · نیاز به ورود
GET /api/admin/invoices
List invoices and the tax percent
platform-admin · نیاز به ورود
GET /api/admin/tax
Read the tax percent
platform-admin · نیاز به ورود
PATCH /api/admin/tax
Set the tax percent
platform-admin · نیاز به ورود
GET /api/admin/marketplace
Marketplace listings and the revenue ledger
platform-admin · نیاز به ورود
GET /api/admin/settlements
List manual settlements
platform-admin · نیاز به ورود
POST /api/admin/settlements
Record a manual settlement
platform-admin · نیاز به ورود
GET /api/admin/templates
List professional templates
platform-admin · نیاز به ورود
GET /api/admin/knowledge-packs
List knowledge packs without presenting them as approved law
platform-admin · نیاز به ورود
GET /api/admin/settings/sms
SMS provider status
platform-admin · نیاز به ورود
GET /api/admin/settings/payments
Payment provider status
platform-admin · نیاز به ورود
GET /api/admin/nodes
Local API host capacity
platform-admin · نیاز به ورود
POST /api/devices/pairing-codes
Issue a pairing code and QR payload
devices · نیاز به ورود
POST /api/devices/pair
Redeem a pairing code for a device token
devices · نیاز به ورود
GET /api/devices/paired
List paired computers for the active organization
devices · نیاز به ورود
GET /api/devices/paired/{id}
Paired device status and active session
devices · نیاز به ورود
PATCH /api/devices/paired/{id}
Update read-only mode, command execution, and allowed folders
devices · نیاز به ورود
DELETE /api/devices/paired/{id}
Unpair a computer
devices · نیاز به ورود
GET /api/devices/{id}/link
Outbound device WebSocket
devices · نیاز به ورود
GET /api/admin/devices
Paired user devices
platform-admin · نیاز به ورود
GET /api/admin/licenses
Issued on-prem licenses
platform-admin · نیاز به ورود
POST /api/admin/licenses/{id}/revoke
Revoke an issued license
platform-admin · نیاز به ورود
POST /api/admin/llm-providers
Store an LLM provider on the SaaS edition
platform-admin · نیاز به ورود
GET /api/admin/audit
Audit log
platform-admin · نیاز به ورود
GET /api/admin/feature-flags
Feature flags
platform-admin · نیاز به ورود
PATCH /api/admin/feature-flags/{key}
Toggle a feature flag
platform-admin · نیاز به ورود
GET /api/admin/observability
Usage, cost, latency, errors, tool success, approval rate, and feedback
platform-admin · نیاز به ورود
POST /api/admin/observability/export
Export an observability span
platform-admin · نیاز به ورود
GET /api/admin/evals
List stored eval fixtures for agents
platform-admin · نیاز به ورود
POST /api/admin/evals
Store one eval fixture
platform-admin · نیاز به ورود
POST /api/admin/evals/run
Score one stored fixture version
platform-admin · نیاز به ورود
POST /api/licenses/checkout
Buy an on-prem license
licenses · نیاز به ورود
GET /api/licenses
Licenses bought by the caller's organization
licenses · نیاز به ورود
GET /api/licenses/{id}
One license file
licenses · نیاز به ورود
POST /api/licenses/{id}/activate
Bind an issued license to an installation
licenses · نیاز به ورود
GET /api/licenses/{id}/bundle
Signed install checksum for a license holder
licenses · نیاز به ورود
GET /api/licenses/public-key
Ed25519 license verification key
licenses · نیاز به ورود
GET /api/onprem/license
Offline status of the installed on-prem license
licenses · نیاز به ورود
POST /api/onprem/license
Install a signed license on the on-prem edition
licenses · نیاز به ورود
GET /api/org/llm-providers
Organization LLM providers
onprem · نیاز به ورود
POST /api/org/llm-providers
Store an OpenAI-compatible, AvalAI, or Anthropic provider
onprem · نیاز به ورود
DELETE /api/org/llm-providers/{id}
Remove an organization LLM provider and its vault key
onprem · نیاز به ورود
GET /api/org/sso
Organization OIDC settings
onprem · نیاز به ورود
PUT /api/org/sso
Configure OIDC for the on-prem edition
onprem · نیاز به ورود
GET /api/auth/sso/start
Start on-prem OIDC login
onprem · نیاز به ورود
GET /api/auth/sso/callback
Finish on-prem OIDC login
onprem · نیاز به ورود
POST /api/admin/evals/compare
Compare two eval versions
platform-admin · نیاز به ورود