Skip to main content

Documentation Index

Fetch the complete documentation index at: https://libretto.sh/docs/llms.txt

Use this file to discover all available pages before exploring further.

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

All documented Libretto Cloud API routes in this section are POST requests. Authenticated routes use:
  • x-api-key: <api-key>
  • Content-Type: application/json
  • a JSON body shaped like { "json": { ... } }
For example: 
curl -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.

Authentication

Public account-creation endpoints.

Sessions

Create and close cloud browser sessions.

Deployments and Workflows

Upload bundles, build workflows, and inspect workflow state.

Jobs and Logs

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

Credentials

Store and manage cloud credentials.

Webhooks

Configure tenant-level job result webhooks.

Schedules

Run workflows on a recurring cron-based interval.