Skip to content
OperadeDocs

Search documentation

Type to search documentation.

Documentation
Copy page
Open raw Markdown

List models

List the agent models and capabilities currently recognized by Operade.

Endpoint

GET/api/v1/models

Authentication

Operation classAuthenticationMinimum roleAPI key
dashboard-session-apiDashboard session cookie; mutations also require X-CX-Request: 1.sessionNot allowed

Parameters

This operation has no path, query, or header parameters.

Request body

This operation has no request body.

Example

cURL
curl --request GET 'https://operade.ai/api/v1/models' \
  --cookie 'cx_session=YOUR_SESSION_COOKIE'

Responses

StatusDescriptionContent
4XXHandled client errorapplication/json: ErrorResponse
200Successful Responseapplication/json: ModelListResponse

4XX application/json response schema

Field pathTypeReferenceFormatNullableRequiredEnumDescription
$objectErrorResponse—NoYes——
errorobjectErrorItem—NoYes——
error.codestring——NoYes——
error.detailsobject——NoNo——
error.messagestring——NoYes——

200 application/json response schema

Field pathTypeReferenceFormatNullableRequiredEnumDescription
$objectModelListResponse—NoYes——
itemsarray<ModelItem>——NoYes——
items[]objectModelItem—NoYes——
items[].adapter_activeboolean——NoYes——
items[].context_limitinteger——NoYes——
items[].default_temperaturenumber——NoYes——
items[].idstring——NoYes——
items[].input_price_per_millionnumber——NoYes——
items[].output_price_per_millionnumber——NoYes——
items[].temperature_adjustableboolean——NoYes——

Response example

Response body JSON
{
  "items": []
}

Errors

Reviewed common and route-declared errors are summarized here; the list is not exhaustive. Start with the distributed error index to find each code's canonical domain page.

StatusCodeDescription
401unauthenticatedAuthentication is missing, invalid, or revoked.
On this page
  1. Endpoint
  2. Authentication
  3. Parameters
  4. Request body
  5. Example
  6. Responses
  7. 4XX application/json response schema
  8. 200 application/json response schema
  9. Response example
  10. Errors
  11. Related operations