List model providers
GET
/v1/model-providersAuthorization
AuthorizationBearer token · headerrequiredQuery parameters
limitinteger<int64>min 1 · max 200
afterstring<uuid>Rows past this id in `order`'s direction: a page's `next_cursor`.
beforestring<uuid>Rows just before this id, still in `order`'s direction: a page's `prev_cursor`.
orderOrderParamNewest first when omitted.
Allowed:
ascdesctypeModelProviderTypeParamOnly the providers of this type: `platform` for those the deployment
runs, `byok` for the workspace's own. Both when omitted.
Allowed:
platformbyokHeader parameters
Kikuvi-Workspacestring<uuid>Workspace to list from. Required for a user caller; implied by the key for an API key caller.
Responses
200One page, newest first unless order=asc.
itemsModelProviderBody[]requiredShow propertiesHide properties
Array of
ModelProviderBodyOne of:
object
created_atstring<date-time>requireddescriptionstringrequireddisplay_namestringrequiredformatModelProviderFormatBodyrequiredThe wire format a provider speaks, which decides the shape of the model
settings an agent config may carry for it.
Allowed:
anthropicopenai_responsesidstring<uuid>requiredupdated_atstring<date-time>requiredWhen the provider last changed: a rename, a new endpoint, or a new key.
modelsPlatformModelBody[]requiredModels available through this platform provider.
Show propertiesHide properties
Array of
PlatformModelBodydescriptionstringrequireddisplay_namestringrequiredmodelstringrequiredpriceany | ModelPriceBodyrequiredShow propertiesHide properties
One of:
any
anyModelPriceBody
One of:
object
formatstringrequiredAllowed:
anthropicper_tokenAnthropicPriceBodyrequiredShow propertiesHide properties
cache_readinteger<int64>requiredcache_writeinteger<int64>requiredinputinteger<int64>requiredoutputinteger<int64>requiredobject
formatstringrequiredAllowed:
openai_responsesper_tokenOpenaiResponsesPriceBodyrequired`input` prices the input neither read from nor written to the cache,
`cached_input` the part read and `cache_write` the part written; `output`
prices every output token, reasoning included.
Show propertiesHide properties
cache_writeinteger<int64>requiredcached_inputinteger<int64>requiredinputinteger<int64>requiredoutputinteger<int64>requiredtypestringrequiredAllowed:
platformobject
created_atstring<date-time>requireddescriptionstringrequireddisplay_namestringrequiredformatModelProviderFormatBodyrequiredThe wire format a provider speaks, which decides the shape of the model
settings an agent config may carry for it.
Allowed:
anthropicopenai_responsesidstring<uuid>requiredupdated_atstring<date-time>requiredWhen the provider last changed: a rename, a new endpoint, or a new key.
base_urlstringrequiredWhere the proxy sends this provider's calls, as the workspace set
it. Its API key never comes back.
workspace_idstring<uuid>requiredtypestringrequiredAllowed:
byoknext_cursorstring<uuid> | nullrequiredPass back as `after` for the next page; `null` on the last page.
prev_cursorstring<uuid> | nullrequiredPass back as `before` for the previous page; `null` on the first page.
400Bad limit, cursor, order, or type, a malformed workspace header, or a user caller with no workspace header.
errorErrorDetailrequiredWhat went wrong: a `code` to branch on and a `message` to show. The
message is written for a person and may change; the code will not.
Show propertiesHide properties
codeErrorCoderequiredThe machine-readable half of an error response, and the field a client
branches on. Closed: every error carries exactly one of these.
Allowed:
unauthorizedforbiddennot_foundinvalid_requestconflictclient_outdatedprecondition_failedtoo_many_requestsinternalmessagestringrequired401Missing, malformed, or invalid bearer token.
errorErrorDetailrequiredWhat went wrong: a `code` to branch on and a `message` to show. The
message is written for a person and may change; the code will not.
Show propertiesHide properties
codeErrorCoderequiredThe machine-readable half of an error response, and the field a client
branches on. Closed: every error carries exactly one of these.
Allowed:
unauthorizedforbiddennot_foundinvalid_requestconflictclient_outdatedprecondition_failedtoo_many_requestsinternalmessagestringrequired403Caller lacks model_provider.read, or an API key's Kikuvi-Workspace header names another workspace.
errorErrorDetailrequiredWhat went wrong: a `code` to branch on and a `message` to show. The
message is written for a person and may change; the code will not.
Show propertiesHide properties
codeErrorCoderequiredThe machine-readable half of an error response, and the field a client
branches on. Closed: every error carries exactly one of these.
Allowed:
unauthorizedforbiddennot_foundinvalid_requestconflictclient_outdatedprecondition_failedtoo_many_requestsinternalmessagestringrequired404No such workspace, or the caller cannot see it.
errorErrorDetailrequiredWhat went wrong: a `code` to branch on and a `message` to show. The
message is written for a person and may change; the code will not.
Show propertiesHide properties
codeErrorCoderequiredThe machine-readable half of an error response, and the field a client
branches on. Closed: every error carries exactly one of these.
Allowed:
unauthorizedforbiddennot_foundinvalid_requestconflictclient_outdatedprecondition_failedtoo_many_requestsinternalmessagestringrequired