Bind An Org Key To A Provider
Binds this organisation's own key to a provider it may use: a new API key with the fields its type declares (GET /v1/providers/types), or an existing api_key credential from this organisation's vault. Omitting endpoint keeps the binding's current endpoint override; null clears it.
Authorization
OAuth2AuthorizationCodeBearer In: header
Path Parameters
uuiduuidQuery Parameters
trueRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
A key for a provider, as a new secret or as a credential already in the binding organisation's vault - exactly one of api_key and credential_id. fields carries the payload entries the provider type's catalog entry declares next to the key (for example the AWS access key id and region); endpoint overrides the provider's own for this organisation (an Azure Speech region, another OpenAI-compatible host). Shared by the org binding route and the platform key route.
Response Body
application/json
curl -X PUT "https://example.com/v1/organisations/497f6eca-6276-4993-bfeb-53cbbbba6f08/providers/497f6eca-6276-4993-bfeb-53cbbbba6f08/credential" \ -H "Content-Type: application/json" \ -d '{}'{ "provider_id": "fe3d49af-4061-436b-ae60-f7044f252a44", "bound": true, "endpoint": "string"}