نستقطب شركاء تصميم للقطاعات الجديدة — افتح مجالًا جديدًا، واحصل على المنصة بنصف السعر
Nexevo.AI
تسجيل الدخول

API reference

The complete REST surface — 272 endpoints across 56 resources, generated from the live OpenAPI schema (so it matches the running API).

Base URL https://nexevo.ai/v1. Every endpoint requires an API key (Authorization: Bearer sk-ws-…), except the public /v1/public/* and auth endpoints.

The full machine-readable OpenAPI document is available at https://nexevo.ai/openapi.json — import it into Postman, Insomnia, or any OpenAPI tool for the request/response schemas. The index below lists every endpoint; the guides show the common request shapes.

Agent runs

POST/v1/workspaces/{workspace_id}/agent/runsCreate Agent Run
GET/v1/workspaces/{workspace_id}/agent/runsList Agent Runs
GET/v1/workspaces/{workspace_id}/agent/runs/{run_id}Get Agent Run
DELETE/v1/workspaces/{workspace_id}/agent/runs/{run_id}Delete Agent Run
PATCH/v1/workspaces/{workspace_id}/agent/runs/{run_id}Patch Agent Run
POST/v1/workspaces/{workspace_id}/agent/runs/{run_id}/approvals/{approval_id}Resolve Agent Approval
GET/v1/workspaces/{workspace_id}/agent/runs/{run_id}/artifacts.zipDownload Run Artifacts Zip
GET/v1/workspaces/{workspace_id}/agent/runs/{run_id}/attachAttach Agent Run
POST/v1/workspaces/{workspace_id}/agent/runs/{run_id}/cancelCancel Agent Run
POST/v1/workspaces/{workspace_id}/agent/runs/{run_id}/forkFork Agent Run
POST/v1/workspaces/{workspace_id}/agent/runs/{run_id}/resumeResume Agent Run
POST/v1/workspaces/{workspace_id}/agent/runs/{run_id}/shareShare Agent Run
DELETE/v1/workspaces/{workspace_id}/agent/runs/{run_id}/shareUnshare Agent Run

API keys

POST/v1/workspaces/{workspace_id}/api-keysCreate Api Key
GET/v1/workspaces/{workspace_id}/api-keysList Api Keys
DELETE/v1/workspaces/{workspace_id}/api-keys/{key_id}Revoke Api Key

Artifacts

GET/v1/artifacts/proxyProxy Artifact
GET/v1/workspaces/{workspace_id}/artifactsList Artifacts
PATCH/v1/workspaces/{workspace_id}/artifacts/{artifact_id}Favorite Artifact
POST/v1/workspaces/{workspace_id}/artifacts/{artifact_id}/convertConvert Artifact
GET/v1/workspaces/{workspace_id}/artifacts/{artifact_id}/downloadDownload Artifact
POST/v1/workspaces/{workspace_id}/artifacts/previewPreview Artifact

Auth

POST/v1/auth/desktop-handoffDesktop Handoff Start
GET/v1/auth/desktop-handoff/{code}Desktop Handoff Finish
POST/v1/auth/desktop-login/exchangeDesktop Login Exchange
POST/v1/auth/loginLogin
POST/v1/auth/login/verify-2faLogin Verify 2Fa
POST/v1/auth/logoutLogout
GET/v1/auth/oauth/{provider}/startSocial Login Start
POST/v1/auth/oauth/nativeNative Login
GET/v1/auth/oauth/providersConfigured Login Providers
POST/v1/auth/password-reset/confirmPassword Reset Confirm
POST/v1/auth/password-reset/request-codePassword Reset Request Code
POST/v1/auth/password-reset/verify-codePassword Reset Verify Code
POST/v1/auth/signupSignup
POST/v1/auth/signup/request-codeSignup Request Code

Billing

GET/v1/workspaces/{workspace_id}/billingGet Billing Summary
POST/v1/workspaces/{workspace_id}/billing/subscribeCreate Subscription
GET/v1/workspaces/{workspace_id}/billing/subscriptionGet Subscription Status
POST/v1/workspaces/{workspace_id}/billing/subscription/cancelCancel Subscription
POST/v1/workspaces/{workspace_id}/billing/subscription/changeChange Subscription
POST/v1/workspaces/{workspace_id}/billing/topupCreate Topup
GET/v1/workspaces/{workspace_id}/billing/topup/{request_id}Get Topup Status
GET/v1/workspaces/{workspace_id}/billing/transactionsList Billing Transactions

Browser

GET/v1/browser/downloadDownload Extension

Byok keys

POST/v1/workspaces/{workspace_id}/byok-keysCreate Byok Key
GET/v1/workspaces/{workspace_id}/byok-keysList Byok Keys
DELETE/v1/workspaces/{workspace_id}/byok-keys/{provider}Delete Byok Key

Chat

POST/v1/chat/completionsOpenai Chat Completions
POST/v1/workspaces/{workspace_id}/chatChat

Cloud

GET/v1/workspaces/{workspace_id}/cloud/{provider}/filesList Files
POST/v1/workspaces/{workspace_id}/cloud/{provider}/importImport File
POST/v1/workspaces/{workspace_id}/cloud/{provider}/saveSave Artifact To Cloud

Cloud desktop

GET/v1/workspaces/{workspace_id}/cloud-desktopList Desktops
POST/v1/workspaces/{workspace_id}/cloud-desktopLaunch Desktop
GET/v1/workspaces/{workspace_id}/cloud-desktop/{desktop_id}Get Desktop
POST/v1/workspaces/{workspace_id}/cloud-desktop/{desktop_id}/stopStop Desktop
GET/v1/workspaces/{workspace_id}/cloud-desktop/tiersList Tiers

Connectors

GET/v1/workspaces/{workspace_id}/connectorsList Connectors
DELETE/v1/workspaces/{workspace_id}/connectors/{provider}Disconnect
GET/v1/workspaces/{workspace_id}/connectors/{provider}/authorizeAuthorize
PUT/v1/workspaces/{workspace_id}/connectors/{provider}/credentialsSave Credentials
POST/v1/workspaces/{workspace_id}/connectors/local_browser/connect-tokenIssue Connect Token
GET/v1/workspaces/{workspace_id}/connectors/local_browser/statusLocal Browser Status
POST/v1/workspaces/{workspace_id}/connectors/local_computer/connect-tokenIssue Connect Token
GET/v1/workspaces/{workspace_id}/connectors/local_computer/statusLocal Computer Status

Conversations

GET/v1/workspaces/{workspace_id}/conversationsList Conversations
POST/v1/workspaces/{workspace_id}/conversationsCreate Conversation
GET/v1/workspaces/{workspace_id}/conversations/{conversation_id}Get Conversation
PATCH/v1/workspaces/{workspace_id}/conversations/{conversation_id}Rename Conversation
DELETE/v1/workspaces/{workspace_id}/conversations/{conversation_id}Delete Conversation
POST/v1/workspaces/{workspace_id}/conversations/{conversation_id}/messagesAppend Message
POST/v1/workspaces/{workspace_id}/conversations/{conversation_id}/shareShare Conversation
DELETE/v1/workspaces/{workspace_id}/conversations/{conversation_id}/shareUnshare Conversation

Corpora

GET/v1/workspaces/{workspace_id}/corporaList Corpora
POST/v1/workspaces/{workspace_id}/corporaCreate Corpus
DELETE/v1/workspaces/{workspace_id}/corpora/{slug}Delete Corpus
POST/v1/workspaces/{workspace_id}/corpora/{slug}/ingest-batchIngest Batch
POST/v1/workspaces/{workspace_id}/corpora/{slug}/itemsAdd Corpus Item
POST/v1/workspaces/{workspace_id}/corpora/{slug}/uploadUpload Corpus File

Cs connectors

GET/v1/workspaces/{workspace_id}/cs-connectorsList Cs Connectors
POST/v1/workspaces/{workspace_id}/cs-connectorsCreate Cs Connector
PATCH/v1/workspaces/{workspace_id}/cs-connectors/{connector_id}Set Cs Connector Enabled
DELETE/v1/workspaces/{workspace_id}/cs-connectors/{connector_id}Delete Cs Connector

Custom connectors

GET/v1/workspaces/{workspace_id}/custom-connectorsList Custom Connectors
POST/v1/workspaces/{workspace_id}/custom-connectorsCreate Custom Connector
GET/v1/workspaces/{workspace_id}/custom-connectors/{connector_id}Get Custom Connector
PATCH/v1/workspaces/{workspace_id}/custom-connectors/{connector_id}Set Custom Connector Enabled
DELETE/v1/workspaces/{workspace_id}/custom-connectors/{connector_id}Delete Custom Connector
POST/v1/workspaces/{workspace_id}/custom-connectors/{connector_id}/refreshRefresh Mcp Connector
POST/v1/workspaces/{workspace_id}/custom-connectors/mcpCreate Mcp Connector

Data sources

GET/v1/workspaces/{workspace_id}/data-sourcesList Data Sources

Distillation

POST/v1/workspaces/{workspace_id}/distillation/exportCreate Distillation Export
GET/v1/workspaces/{workspace_id}/distillation/exportsList Distillation Exports
GET/v1/workspaces/{workspace_id}/distillation/exports/{export_id}/downloadDownload Distillation Export
GET/v1/workspaces/{workspace_id}/distillation/samplesList Distillation Samples
PATCH/v1/workspaces/{workspace_id}/distillation/samples/{sample_id}Patch Distillation Sample
GET/v1/workspaces/{workspace_id}/distillation/statusDistillation Status

Escalations

GET/v1/workspaces/{workspace_id}/escalationsList Escalations
POST/v1/workspaces/{workspace_id}/escalations/{escalation_id}/resolveResolve Escalation

Events

GET/v1/workspaces/{workspace_id}/eventsUser Event Stream

Generate

POST/v1/workspaces/{workspace_id}/generate/imageSubmit Image Endpoint
GET/v1/workspaces/{workspace_id}/generate/image/{task_id}Image Status Endpoint
GET/v1/workspaces/{workspace_id}/generate/pricingGeneration Pricing
POST/v1/workspaces/{workspace_id}/generate/speechSpeech Endpoint
POST/v1/workspaces/{workspace_id}/generate/videoSubmit Video Endpoint
GET/v1/workspaces/{workspace_id}/generate/video/{task_id}Video Status Endpoint

Guardrails

GET/v1/workspaces/{workspace_id}/guardrailsList Ws Guardrails
POST/v1/workspaces/{workspace_id}/guardrailsUpsert Ws Guardrail
PATCH/v1/workspaces/{workspace_id}/guardrails/{rule_id}Set Ws Guardrail Enabled
DELETE/v1/workspaces/{workspace_id}/guardrails/{rule_id}Delete Ws Guardrail

Health

GET/v1/healthHealth

Invites

GET/v1/invites/{token}Preview Invite
POST/v1/invites/{token}/acceptAccept Invite
POST/v1/workspaces/{workspace_id}/invitesCreate Invite
GET/v1/workspaces/{workspace_id}/invitesList Invites
DELETE/v1/workspaces/{workspace_id}/invites/{invite_id}Revoke Invite

Logs

GET/v1/workspaces/{workspace_id}/logsList Logs
POST/v1/workspaces/{workspace_id}/logs/{trace_id}/ratingRate Dispatch

MCP

POST/v1/mcpMcp Endpoint

Account (me)

GET/v1/meGet Me
PATCH/v1/meUpdate Me
POST/v1/me/2fa/disableDisable 2Fa
POST/v1/me/2fa/enableEnable 2Fa
POST/v1/me/2fa/setupSetup 2Fa
POST/v1/me/avatarUpload Avatar
GET/v1/me/brain/graphGet User Graph
GET/v1/me/brain/graph/backlinks/{point_id}Get User Backlinks
POST/v1/me/brain/graph/linkCreate User Link
POST/v1/me/delete/confirmConfirm Account Deletion
POST/v1/me/delete/requestRequest Account Deletion
POST/v1/me/devicesRegister Device
DELETE/v1/me/devicesUnregister All Devices
DELETE/v1/me/devices/{token}Unregister Device
POST/v1/me/email/confirmConfirm Email Change
POST/v1/me/email/send-current-codeSend Current Email Code
POST/v1/me/email/send-new-codeSend New Email Code
POST/v1/me/email/verify-currentVerify Current Email
GET/v1/me/identitiesList Identities
DELETE/v1/me/identities/{provider}Unlink Identity
GET/v1/me/identities/{provider}/linkLink Start
GET/v1/me/inviteGet Invite
GET/v1/me/notificationsMy Notifications
POST/v1/me/notifications/seenMark Notifications Seen
POST/v1/me/sessions/revoke-othersRevoke Other Sessions

Members

GET/v1/workspaces/{workspace_id}/membersList Members
PATCH/v1/workspaces/{workspace_id}/members/{user_id}/roleChange Member Role

Memory

POST/v1/workspaces/{workspace_id}/memorySave Memory
GET/v1/workspaces/{workspace_id}/memoryList Memory
DELETE/v1/workspaces/{workspace_id}/memoryPurge Memory
DELETE/v1/workspaces/{workspace_id}/memory/{point_id}Forget Memory
GET/v1/workspaces/{workspace_id}/memory/episodesList Episodes
GET/v1/workspaces/{workspace_id}/memory/episodes/{run_id}/membersList Episode Members
GET/v1/workspaces/{workspace_id}/memory/facetsList Workspace Facets
GET/v1/workspaces/{workspace_id}/memory/facets/{facet_id}/membersList Facet Members
GET/v1/workspaces/{workspace_id}/memory/graphGet Workspace Graph
GET/v1/workspaces/{workspace_id}/memory/graph/backlinks/{point_id}Get Workspace Backlinks
POST/v1/workspaces/{workspace_id}/memory/graph/linkCreate Workspace Link
GET/v1/workspaces/{workspace_id}/memory/graph/point-entitiesList Point Entities
GET/v1/workspaces/{workspace_id}/memory/searchSearch Memory

Messages

POST/v1/messagesAnthropic Messages

Monitoring

GET/v1/monitoring/metricsMetrics

Notifications

GET/v1/notificationsAdmin List Notifications
POST/v1/notificationsAdmin Create Notification
DELETE/v1/notifications/{notification_id}Admin Delete Notification

Oauth

GET/v1/oauth/{provider}/callbackOauth Callback

Pack eval

POST/v1/workspaces/{workspace_id}/pack-evalRun Pack Eval

Pack evals

GET/v1/workspaces/{workspace_id}/pack-evalsList Pack Evals
GET/v1/workspaces/{workspace_id}/pack-evals/trendPack Eval Trend

Personalization

GET/v1/workspaces/{workspace_id}/personalizationGet Personalization
DELETE/v1/workspaces/{workspace_id}/personalizationReset Personalization
POST/v1/workspaces/{workspace_id}/personalization/refreshRefresh Personalization

Playbooks

GET/v1/workspaces/{workspace_id}/playbooksList My Playbooks
GET/v1/workspaces/{workspace_id}/playbooks/{slug}Get My Playbook
DELETE/v1/workspaces/{workspace_id}/playbooks/{slug}Delete My Playbook
POST/v1/workspaces/{workspace_id}/playbooks/from-run/{run_id}Save Run As Playbook

Projects

GET/v1/workspaces/{workspace_id}/projectsList Projects
POST/v1/workspaces/{workspace_id}/projectsCreate Project
GET/v1/workspaces/{workspace_id}/projects/{project_id}Get Project
PATCH/v1/workspaces/{workspace_id}/projects/{project_id}Update Project
DELETE/v1/workspaces/{workspace_id}/projects/{project_id}Delete Project
GET/v1/workspaces/{workspace_id}/projects/{project_id}/connectorsGet Project Connectors
PUT/v1/workspaces/{workspace_id}/projects/{project_id}/connectorsPut Project Connectors
GET/v1/workspaces/{workspace_id}/projects/{project_id}/contextProject Context
GET/v1/workspaces/{workspace_id}/projects/{project_id}/filesList Files
POST/v1/workspaces/{workspace_id}/projects/{project_id}/filesUpload File
DELETE/v1/workspaces/{workspace_id}/projects/{project_id}/files/{file_id}Delete File
GET/v1/workspaces/{workspace_id}/projects/{project_id}/files/{file_id}/urlFile Download Url
GET/v1/workspaces/{workspace_id}/projects/{project_id}/membersList Project Members
POST/v1/workspaces/{workspace_id}/projects/{project_id}/membersAdd Project Member
PATCH/v1/workspaces/{workspace_id}/projects/{project_id}/members/{member_user_id}Update Project Member
DELETE/v1/workspaces/{workspace_id}/projects/{project_id}/members/{member_user_id}Remove Project Member
GET/v1/workspaces/{workspace_id}/projects/{project_id}/skillsGet Project Skills
PUT/v1/workspaces/{workspace_id}/projects/{project_id}/skillsPut Project Skills
POST/v1/workspaces/{workspace_id}/projects/{project_id}/transfer-ownerTransfer Project Owner

Prompts

GET/v1/workspaces/{workspace_id}/promptsList Prompts
POST/v1/workspaces/{workspace_id}/promptsCreate Prompt
GET/v1/workspaces/{workspace_id}/prompts/{prompt_id}Get Prompt
PATCH/v1/workspaces/{workspace_id}/prompts/{prompt_id}Update Prompt
DELETE/v1/workspaces/{workspace_id}/prompts/{prompt_id}Delete Prompt
POST/v1/workspaces/{workspace_id}/prompts/{prompt_id}/rollbackRollback Prompt
GET/v1/workspaces/{workspace_id}/prompts/{prompt_id}/versionsList Prompt Versions

Public

POST/v1/public/contactSubmit Contact
GET/v1/public/fx-ratePublic Fx Rate
POST/v1/public/payments/airwallex/webhookAirwallex Webhook
POST/v1/public/payments/antom/webhookAntom Webhook
POST/v1/public/payments/stripe/subscription-webhookStripe Subscription Webhook
POST/v1/public/payments/stripe/webhookStripe Webhook
GET/v1/public/plansPublic Plans
GET/v1/public/pricingPublic Pricing
GET/v1/public/share/{token}Get Public Share

Render

POST/v1/workspaces/{workspace_id}/renderRender Document

Route

POST/v1/workspaces/{workspace_id}/routeRoute Turn

Schedules

GET/v1/workspaces/{workspace_id}/schedulesList Schedules
POST/v1/workspaces/{workspace_id}/schedulesCreate Schedule
GET/v1/workspaces/{workspace_id}/schedules/{schedule_id}Get Schedule
PATCH/v1/workspaces/{workspace_id}/schedules/{schedule_id}Update Schedule
DELETE/v1/workspaces/{workspace_id}/schedules/{schedule_id}Delete Schedule
POST/v1/workspaces/{workspace_id}/schedules/{schedule_id}/run-nowRun Schedule Now
GET/v1/workspaces/{workspace_id}/schedules/{schedule_id}/runsList Schedule Runs

Search

GET/v1/workspaces/{workspace_id}/searchSearch

Skill library

GET/v1/skill-libraryList Platform Skill Library
POST/v1/skill-libraryCreate Platform Skill
GET/v1/skill-library/{slug}Get Platform Skill Library Item
PATCH/v1/skill-library/{slug}/editEdit Platform Skill
GET/v1/workspaces/{workspace_id}/skill-libraryList Skill Library
GET/v1/workspaces/{workspace_id}/skill-library/{slug}Get Skill Library Item
PATCH/v1/workspaces/{workspace_id}/skill-library/{slug}Set Skill Enabled
DELETE/v1/workspaces/{workspace_id}/skill-library/{slug}Delete Skill
PATCH/v1/workspaces/{workspace_id}/skill-library/{slug}/agency-editEdit Agency Role
GET/v1/workspaces/{workspace_id}/skill-library/{slug}/fileGet Skill Library Resource
POST/v1/workspaces/{workspace_id}/skill-library/importImport Skill
POST/v1/workspaces/{workspace_id}/skill-library/uploadUpload Skill

Skills

GET/v1/skillsList Skills
POST/v1/skillsCreate Skill
GET/v1/skills/_candidatesList Skill Candidates
GET/v1/skills/{slug}Get Skill
POST/v1/skills/{slug}/collectCollect Skill Samples
POST/v1/skills/{slug}/compileCompile Skill Playbook
POST/v1/skills/{slug}/curateCurate Skill Samples
POST/v1/skills/{slug}/dpo-exportExport Skill Dpo
POST/v1/skills/{slug}/exportExport Skill Dataset
POST/v1/skills/{slug}/promotePromote Skill To Official
GET/v1/skills/{slug}/samplesList Skill Samples
GET/v1/skills/{slug}/samples/{sample_id}Get Skill Sample
POST/v1/skills/{slug}/samples/{sample_id}/annotateAnnotate Skill Sample
GET/v1/workspaces/{workspace_id}/skillsList Workspace Skills

Support cases

GET/v1/workspaces/{workspace_id}/support-casesList Support Cases
GET/v1/workspaces/{workspace_id}/support-cases/{case_id}Get Support Case
POST/v1/workspaces/{workspace_id}/support-cases/{case_id}/closeClose Support Case

Tools

GET/v1/toolsList Tools
GET/v1/tools/{name}Get Tool
POST/v1/tools/{name}/invokeInvoke Tool

Trajectory

GET/v1/workspaces/{workspace_id}/trajectory/analyticsGet Trajectory Analytics
GET/v1/workspaces/{workspace_id}/trajectory/skill-healthGet Skill Health

Transcribe

POST/v1/workspaces/{workspace_id}/transcribeTranscribe Audio

Transfer owner

POST/v1/workspaces/{workspace_id}/transfer-ownerTransfer Workspace Owner

Uploads

POST/v1/workspaces/{workspace_id}/uploadsUpload

Vertical pack

GET/v1/workspaces/{workspace_id}/vertical-packGet Workspace Binding
PUT/v1/workspaces/{workspace_id}/vertical-packBind Workspace Pack
DELETE/v1/workspaces/{workspace_id}/vertical-packUnbind Workspace Pack

Vertical packs

GET/v1/workspaces/{workspace_id}/vertical-packsList Active Pack Catalog

Webhooks

GET/v1/workspaces/{workspace_id}/webhooksList Webhooks
POST/v1/workspaces/{workspace_id}/webhooksCreate Webhook
PATCH/v1/workspaces/{workspace_id}/webhooks/{webhook_id}Update Webhook
DELETE/v1/workspaces/{workspace_id}/webhooks/{webhook_id}Delete Webhook
GET/v1/workspaces/{workspace_id}/webhooks/{webhook_id}/deliveriesList Deliveries
POST/v1/workspaces/{workspace_id}/webhooks/{webhook_id}/testTest Webhook
POST/webhooks/agentbay/{token}Agentbay Webhook

Workspace

PUT/v1/workspaces/{workspace_id}Update Workspace
GET/v1/workspaces/{workspace_id}Get Workspace

Workspaces

POST/v1/workspacesCreate Workspace