Mojo UpDocs

API reference

The public HTTP API of Mojo Up AI Cloud and self-hosted AIOE, generated from the platform's own schemas.

Mojo Up AI Cloud and self-hosted AIOE serve the same HTTP API, from the same code. AI Workbench, its nodes, the mobile app and the consoles all use it. This reference covers the parts meant for use from outside: finding an organisation, signing in, enrolling devices, and the data workbenches exchange with it.

WhereBase address
Mojo Up AI Cloudhttps://ai.mojoup.com.au
Self-hosted AIOEYour AIOE's address, as its discovery document gives it

Requests and responses are JSON. Every request and response shape in this reference comes from the same schemas the platform validates against, so the reference and the platform cannot drift apart. The OpenAPI 3.1 document is at /openapi.json.

Start here

AuthenticationDevice tokens, DPoP, identity provider tokens and Mojo Up AI Cloud sessions.DiscoveryHow a client finds an organisation from a work email.Versions and compatibilityHow the API is versioned, and what changes are safe.

Endpoints

DiscoveryThe public discovery document.OrganisationThe caller's organisation and edition.Cloud sign-inProviders, emailed codes and tokens on Mojo Up AI Cloud.Cloud accountYou, your sign-in methods, and deleting your account.Cloud organisationsTeams, members and invitations.DevicesEnrolling workbenches and nodes, and refreshing their tokens.IngestEvents, usage, audit and tasks from workbenches.CatalogueThe organisation's published templates.PolicyThe rules a workbench enforces.HealthLiveness and readiness probes.

The consoles' administration routes are not part of this reference. They exist to serve the consoles and may change between releases.

Authentication

The three kinds of access token the API accepts, how devices get theirs, and how to choose the organisation on Mojo Up AI Cloud.

On this page

Start hereEndpoints