Team Workspaces and API Access
API keys, billing, tasks, assets, and webhook delivery are all scoped to a team workspace.
Yeehoo external APIs are available only to team workspaces. Personal workspaces support personal products and subscriptions, but cannot create or call API keys.
Prerequisite
Create or switch to an active team workspace in the console first. The workspace Owner or Admin can create and manage API keys for that workspace.
An API key is permanently owned by the team workspace in which it is created. The following all belong to that key's team workspace:
- Credit balance, charges, and usage
- Image and video tasks
- Reference uploads and generated assets
- Model permissions, allowed models, and webhook delivery
Integration flow
- Create or switch to a team workspace in the console.
- Create an API key and configure scopes, allowed models, and webhook delivery as needed.
- Call
GET /v1/modelsto confirm the models available to the key. - When using a reference image, call Image Upload first and pass the returned URL to generation.
- For image or video, call
POST /v1/quotefor estimated credits, thenPOST /v1/generationsto create a task. - Poll
GET /v1/tasks/{task_id}for a terminal state or receive a webhook notification.
Do not switch workspaces with a header
/v1/* resolves the team workspace exclusively from the API key in Authorization: Bearer; it does not read X-Yeehoo-Workspace-ID. Supplying or forging that header cannot alter billing, task, or asset ownership.
To use another team workspace, create and use an API key from that workspace.