Documentation

Build on the Supervisor operating layer

Use the same workspace data, schedules, integrations, and supervised runs that power the Supervisor apps.

Getting started

The platform model

A workspace is the authorization and data boundary for a team. Members connect sources, store operating context, schedule recurring work, and inspect the durable runs created by Supervisor.

Every authenticated request is checked against the key owner, current workspace membership, and role. A workspace restriction on a key limits access further. It never grants membership by itself.

workspace: The team boundary for data, members, integrations, and runs
job: A recurring instruction with a cron expression and timezone
run: A durable record of interactive, scheduled, or automated work
connection: A configured source or signed inbound connection

import json
import os
import urllib.request

url = "https://api.trysupervisor.com/workspaces/user/me"
request = urllib.request.Request(url, method="GET")
request.add_header("Authorization", f"Bearer {os.environ['SUPERVISOR_API_KEY']}")
request.add_header("Content-Type", "application/json")

with urllib.request.urlopen(request) as response:
    result = json.load(response)
    print(json.dumps(result, indent=2))

Choose the first API path

Start by listing the workspaces visible to the API key owner. Keep the returned workspace id and use it in the scoped routes documented in the API reference.