← How-to guides

Your first API call

Create an organization and app, enable a tool, exchange your credential for a token, and run a pipeline — end to end in five steps.

This guide takes you from zero to a working pipeline call. It assumes the API is reachable (locally, run pnpm seed:local then pnpm dev:local).

1. Create an organization

Open the Console and create an org. You’re the owner.

2. Create an application

Under Applications → New application, give it a name. You’ll get a client_id and a one-time client_secret. The secret is shown once — keep it on your server, never in the browser.

3. Enable a tool

Go to Marketplace, choose your app in the picker, and click Enable on a tool. That tool’s pipeline is now on the app’s allow-list.

4. Exchange your credential for a token

curl -X POST "$API/auth/token" \
  -u "$CLIENT_ID:$CLIENT_SECRET" \
  -H "Content-Type: application/json" \
  -d '{"subject":"user@acme.com","pipelines":["translate-string"]}'
# → { "token": "eyJ…", "token_type": "Bearer", "expires_in": 900 }

5. Run a pipeline

curl -X POST "$API/tickets" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"mode":"pipeline","pipeline_id":"translate-string","inputs":{"text":"Hello","target_language":"zh-TW"}}'
# → { "ticket_id": "01J…", "status": "QUEUED" } — then poll GET /tickets/:id

That’s it. See the FAQ for quotas and token lifetimes.