API access for account owners

What API access is for

The unified API lets your application consume services under an approved agreement. Your application uses a buyer API key and agreement reference. Supplier credentials stay on the server and are never shown to buyers.

These instructions are for a buyer account consuming purchased inference. Approved model providers have supplier-only access: they configure supply and respond to RFQs, rather than create buyer RFQs, make purchases, or create buyer API keys. Broker management access and a purchasing mandate do not provide the buyer’s API-key screens.

You do not need to write code to own the buyer account. This page explains the setup to coordinate with your application team.

Before creating a key

Check that you have an agreement with the required model and delivery window. Consumption also needs an eligible, configured supplier endpoint and enough available allowance. An API key alone does not create capacity.

Confirm the capability your application needs. Your application can use text chat, supported media chat, embeddings, image generation and batch processing when the agreed supplier route explicitly supports the operation. Some operations require separate usage limits and quoted non-text or batch rates. Catalogue capabilities alone do not enable delivery. Tool calling and standalone video generation are unavailable through the current gateway.

The browser Send an inference request screen is a text-chat test. Coordinate other supported operations with your application team and broker, using the capabilities and terms of your accepted agreement.

Create and hand over access

1. Open API access in the workspace.
2. In the Create an API key panel, give the key a recognizable name, such as the application and environment.
3. Scope it to the intended agreement when appropriate.
4. Select Create API key and save the raw key when it is shown. It is displayed once; later lists contain safe metadata only.
5. Give the application team the key through your organization’s secret-management process, along with the agreement reference and exact model identifier.

Save the one-time key before leaving this screen. Signing out in another tab or changing the signed-in account closes the private view and removes the displayed key from it.

The application team uses the configured gateway base address, the route for its supported operation, the buyer key, and the agreement reference. Keep implementation details in your team’s technical setup rather than sharing secrets in email or RFQ text.

The Make an authorized request panel shows the request shape the application team follows and links to the Send an inference request screen, where you can send one real, charged request from the browser. See Sending an inference request.

Keep each use accountable

Use distinct names for applications or environments so you can identify access later. Review the key list periodically. If a key is no longer needed or may have been exposed, revoke it in API access and replace the application’s credential.

Each buyer member sees and can revoke their own keys. An organization administrator can review and revoke keys issued to other members of that organization. The raw secret is never shown again in either view.

Revocation prevents new authorized requests with that key. It does not erase already recorded consumption.

What the gateway checks

Before dispatch, the service checks the buyer, agreement, model, delivery time, remaining allowance, endpoint capabilities, policy, and capacity limits. It reserves a bounded amount, sends the request to an eligible configured supplier, and reconciles validated usage.

The service must not silently substitute a different model or route outside your accepted supplier constraints. It does not use guessed token counts as final billing data.

If a request fails

Ask your application team for the error code, request reference, and agreement reference. Check the delivery window and remaining available allowance first. Missing supplier configuration needs an operator; repeatedly creating buyer keys will not fix it.

For interrupted or uncertain responses, follow Usage and allowances and Troubleshooting.