See also the Cloud Agent Server v1 API.

In general, input parameters can be provided either by form parameters or as the entries in one JSON object sent in a POST body. The one exception is the parameter file in /install-remix-file/<ws>, which must be a form parameter. Note that form parameters must be passed as a URL-encoded body (application/x-www-form-urlencoded content type) or a multi-part form; query parameters are not accepted unless explicitly noted.

All requests (except for running agents that allow anonymous access) require a token (JWT) in HTTP header Authorization: Bearer $TOKEN.

In case of an error, the entry points respond with a JSON error object of one of the following shapes:

• {"kind": "run_error", "run_error": JSON_OBJECT}, when the Mix execution failed in an agent.
• {"ok": false", "kind": "message", "message": STRING}, when something else failed.

Additionally, error types are signaled using the HTTP response status.

GET /

A "hello world" endpoint that serves as a health check. The message includes the mixer build number.

GET /ws/

Lists workspaces and any workspace-level permissions associated with them. Returns all workspaces you are an admin of.

GET /ws/<ws>

Lists the apps in a particular workspace, including any app-level permissions granted. You must be an admin of this workspace.

POST /ws

Creates a workspace. The name of the workspace is given by optional parameter name, and a random string by default. When successful, it responds with JSON object {"ok": true}.

Success result:

{
  "ok": true,
  "name": <string> // name of the new workspace
}

DELETE /ws/<ws>