Skip to main content
Welcome to the Neza Ready-to-use API documentation. These endpoints let you launch workflows, run published AI apps, and monitor or cancel queued tasks programmatically. Every route under /api/openapi requires an API key that you can create from your Neza account.

OpenAPI specification

The Mintlify playground below is powered by this OpenAPI file.

​
Base URL

https://platform.neza.video/api
  • All endpoints live under the /openapi prefix (for example POST /api/openapi/webapp/run).
  • Use the sandbox server http://localhost:3000/api while testing locally.

​
Authentication

Every request must include an Authorization header that contains your API key: 
Authorization: Bearer <YOUR_API_KEY>
If the header is missing or the key is disabled, the API returns a 401 response with an error message.

​
Available capabilities

  • Account snapshot – inspect the wallet balance and how many workflow tasks you currently have in the queue.
  • Workflow execution – trigger a workflow directly by passing the workflowId and its variable values.
  • Webapp execution – reuse a published AI application by referencing its webappId.
  • Task management – poll task status, fetch generated files, or cancel a long running job.
Use the navigation on the left to explore the interactive reference for each endpoint.