ioy.ai
Sign inGet the starter
Template guide

Connect the reference API

Learn the API once, then ship the same contract with your independent SaaS.

What this API belongs to

This API executes reference SaaS tasks and reads quota. It does not create a new project or provision Cloudflare resources. Project generation uses the local generator and saas-launch skill.

Create a test key

Run the local demo, verify your account and open API keys. Create a key with only the scopes required: quota:read, jobs:read and, for creation, jobs:write. Save the displayed value privately; it is shown once and stored hashed. This key is separate from the model provider key.

Make your first call

Read OpenAPI and the operation reference. Send Authorization: Bearer <your-saas-key>. Set your client's origin to the running app; do not append /api/v1 to SAAS_API_URL.

  1. Query GET /api/v1/quota.
  2. Create POST /api/v1/jobs with kind, prompt and a stable Idempotency-Key.
  3. Query GET /api/v1/jobs/:id until a final state.
  4. Fetch /api/v1/jobs/:id/result only after success and inspect the actual output.

Keep one operation key for identical retries. For an unknown outcome, query the original task rather than creating a second paid request. Follow the product Skill guide for the supplied CLI.

Publish your own contract

After changing your business module, update openapi.json, run sdk:build and skill:pack, then test authentication, scopes, idempotency, quota and output downloads in the new product. Disabling apiEnabled closes external keys and hides API/Skill content; the signed-in website can still use its task flow.