Authentication
One API key gives your integration access to the Boardwalk API. Its permissions determine which endpoints it can use, and its organization determines which records it can read.
Authentication
Create a key in the console and send it in the Authorization: Bearer header. Keep the key on your server or in an environment variable; never put it in browser code or commit it to source control.
curl https://api.boardwalk.cloud/v1/models \
-H "Authorization: Bearer $BOARDWALK_API_KEY"GET /v1/catalog/models and the public OpenAPI schema need no key. Catalog discovery returns the same public models whether or not you send credentials.
Key permissions
Select only the permissions your integration needs. For a read-only key, leave inference:write unchecked. To change permissions, create a replacement key and revoke the old one.
| Permission | Access |
|---|---|
inference:write | Run inference, tokenize, and read receipts. |
requests:read | Read all organization requests and receipts. |
models:read | Read models, configurations, and checked revisions. |
models:write | Activate revisions, stop/resume serving, and delete models. |
deployments:read | Read deployment history, details, and phase events. |
deployments:write | Preview, submit, and cancel deployments. |
floors:read | Read reserved capacity and published rates. |
floors:write | Change reserved capacity. |
audit:read | Read the full audit trail, including every member's events. |
Missing or invalid credentials return 401. A valid key without the required permission returns 403. Each endpoint reference lists its required permission.
An activating deployment needs both deployments:write and models:write. With only deployment write permission, submit serve: false to prepare a candidate. Resuming a model also needs both scopes because it may start a deployment. Write permissions do not automatically grant reads.
Inference, deployments, and reserved capacity can spend credits. New management permissions are unchecked when creating a key. Deployment source reads use the key creator’s Hugging Face connection; connect that account in the console for gated or private repositories. Writes need a key whose creator is still active.
Organization access
Your key selects the organization. Read scopes cover that organization's records, including other members' activity. A record outside your organization returns 404. A suspended organization returns 403 with org_inactive.
Management reads, stopping, deleting, and capacity reductions work at zero credits. An organization may deploy one model before its first purchase. Another model, and a capacity increase, need credits. Inference needs sufficient credits and capacity. Management reads have their own request budget; honor Retry-After on 429. See rate limits and retries.