Configure the client's own AI models (BYOK)
Set the client's Bring-Your-Own-Key AI provider configuration per scope. The request body is an object keyed by scope (orchestrator, text, image); a scope set to null clears it. Providers and capabilities are validated against a fixed catalogue. When a scope uses BYOK, its calls are billed to the client's own provider and do NOT consume PlanVortex AI credits, but the plan still has to include AI credits to use the feature. API keys are stored encrypted and never returned; the response client only exposes provider, model and has_api_key per scope. Requires the client:update permission.
Request
- Base URL: https://api.planvortex.com/v1.0.0
- URL: https://api.planvortex.com/v1.0.0/clients/{id_client}/ai-settings
- Auth: one of:
- HTTP bearer
- OAuth 2 (client credentials, token URL https://api.planvortex.com/v1.0.0/oauth/token)
Path parameters
Client identifier
Request body
Response
Successful operation. Returns the client with the sanitized ai_settings (no API keys).
Example response
{
"client": {
"_id": "66d04a6a427f4c43b9d97f54"
}
}Changes
No recorded changes to this operation across all 1 revision of this API.