Libretto Cloud API

Use the Libretto Cloud HTTP API to create accounts, manage deployments, run workflows, and inspect results.

The Libretto Cloud API base URL is https://api.libretto.sh.

Request format

Most Libretto Cloud API routes in this section are POST requests. Published workflow catalogue and bookmark routes also use GET and DELETE.

Authenticated routes use:

x-api-key: <api-key>
Content-Type: application/json
JSON request bodies for state-changing requests

The RPC routes documented in this section wrap input as { "json": { ... } }. Catalogue routes use direct JSON bodies as shown on the Workflow catalogue page.

For example:

12345678curl -X POST "https://api.libretto.sh/v1/jobs/get" \
  -H "x-api-key: $LIBRETTO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "json": {
      "id": "<job-id>"
    }
  }'

Authentication rules

POST /v1/auth/* routes are public and do not require x-api-key.
All other POST /v1/* routes require x-api-key.
The API key must belong to a verified user account.

Use the Libretto Cloud authentication page to sign up, log in, invite users, and issue API keys.

Included routes

This section documents the public /v1/* routes exposed by Libretto Cloud in this checkout. Billing is managed through the plans flow and does not currently expose public /v1/billing/* routes here.

Sessions

Create and close cloud browser sessions.

Recordings

Generate temporary recording URLs.

Deployments and Workflows

Upload bundles, build workflows, and inspect workflow state.

Jobs and Logs

Start jobs, poll results, inspect debug reports, and fetch logs.

Workflow catalogue

Search, run, and save workflows shared by other tenants.

Credentials

Store and manage cloud credentials.

SMS OTP

Provision SMS inbox numbers and wait for portal OTP codes in workflows.

Webhooks

Configure tenant-level job result webhooks.

Schedules

Run workflows on a recurring cron-based interval.

Ask AI about this page