API ReferenceAI Providers

Update AI Provider

View as Markdown
Update an AI provider label, credentials, default model, or enabled state. Use this when rotating model credentials or changing the default model for hosted execution.

Authentication

AuthorizationBearer

Use Bearer <api-key>.

Path parameters

aiProviderIdstringRequired

Request

This endpoint expects an object.
apiKeystring or nullOptional>=1 character
baseUrlstring or nullOptionalformat: "uri"
defaultModelstring or nullOptionalformat: "^[A-Za-z0-9_.:/-]+(?:\/[A-Za-z0-9_.:/-]+)*$"
namestringOptional1-200 characters
statusenumOptional

Response

OK
createdAtdatetime
hasApiKeyboolean
idstringformat: "^[A-Za-z0-9_-]{1,64}$"
namestring1-200 characters
providerenum
statusenum
updatedAtdatetime
baseUrlstringformat: "uri"
defaultModelstringformat: "^[A-Za-z0-9_.:/-]+(?:\/[A-Za-z0-9_.:/-]+)*$"
modelslist of objects
subaccountIdstring>=1 character

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
429
Too Many Requests Error