Skip to main content
Everything the studio does goes through the Devias HTTP API, and anything the studio can do can be done through it. The TypeScript SDK wraps it. This section describes the API for any other language and for what the SDK does underneath.

​
Properties of the API

  • JSON in, JSON out. Requests and responses are JSON.
  • Workspace scoped. Almost every route lives under /api/workspaces/<workspaceId>/, so one server holds many workspaces.
  • One permission check. An API call, the studio, a workflow and an agent all pass the same check. See Access and permissions.
  • Changes are announced. Every write is also an event that can be followed. See Change feed.

​
The OpenAPI document

Every route, with its request and response schemas, is described in one OpenAPI 3.1 document: /reference/api/openapi.json on this site. It includes the routes added by the modules of the reference setup. The core API alone is apps/server/openapi.json in the repository, and the SDK’s types are generated from that file, so the two never disagree. There are no per-route pages in this documentation. The OpenAPI document is the complete and exact list of routes.