Skip to main content

Getting started

Every endpoint is scoped to a single project. You authenticate with a project API key, and the key decides both which project you reach and what you may do inside it — there is no credential that spans projects.

Three steps to your first call:

  1. In Project Settings → API keys, create a key and grant it the permissions you need. The secret is shown once — store it somewhere safe.
  2. Send the key in the Authorization header. Pass the key raw, with no Bearer prefix.
  3. Call an endpoint under your project id.

Run a workflow and wait for the result

curl -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: proj.KEY_ID.SECRET" \
  -d '{"runEvent":"run","inputs":{"name":"Ada"}}' \
  {{BASE_URL}}/projects/{{PROJECT_ID}}/workflows/YOUR_WORKFLOW_ID/runsync
Base URL

All paths in these docs are relative to {{BASE_URL}}.