API ReferenceAI Providers

Create AI Provider

View as Markdown

Create an AI provider with provider credentials and model defaults. Name is optional and defaults server-side; pass test=true to verify credentials before saving.

Authentication

AuthorizationBearer

Use Bearer <api-key>.

Request

This endpoint expects an object.
providerenumRequired
apiKeystringOptional>=1 character
baseUrlstringOptionalformat: "uri"
defaultModelstringOptionalformat: "^[A-Za-z0-9_.:/-]+(?:\/[A-Za-z0-9_.:/-]+)*$"
namestringOptional1-200 characters
statusenumOptional
subaccountIdstring or nullOptional>=1 character
testbooleanOptional

Response

Created
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
409
Conflict Error
429
Too Many Requests Error