Query Platform Model List

Supports querying the platform model list; passing an organization ID returns the models actually available to that organization.

You can use this endpoint to query the platform model list; passing org_id returns the models actually available to that organization, including the organization's self-configured models.

Request Method

GET

Request URL

https://api.${endpoint}/v1/model/list

Request Authentication

Uses account-level DevKey / DevSecret Basic authentication.

Request

Request Example

curl -X GET 'https://api.${endpoint}/v1/model/list?org_id=p-xxxx&agent_type=LOOP_AGENT' \ -H 'Authorization: Basic ${BASIC_TOKEN}'

                      
                      curl -X GET 'https://api.${endpoint}/v1/model/list?org_id=p-xxxx&agent_type=LOOP_AGENT' \
  -H 'Authorization: Basic ${BASIC_TOKEN}'

This code block in the floating window

Request Headers

Field	Type	Description
Authorization	Basic ${BASIC_TOKEN}	The Basic Token obtained by Base64-encoding `DevKey:DevSecret`.

Request Parameters (Query Parameters)

Parameter	Type	Description	required
org_id	String	Organization ID. When provided, organization membership is verified and the models available to that organization are returned.	true
agent_type	String	Agent type. Supports `AGENT`, `FLOW_AGENT`, `LOOP_AGENT`, `WORKFLOW`;	true

Response

Response Example

{ "code": 0, "message": "OK", "data": { "CHAT": { "OPEN_AI": [ { "model_name": "GPT-4o", "aiModelVersion": "gpt-4o", "modelId": "mv-xxxx", "capabilities": ["pluginSupport", "ImageRecognition", "jsonSchema"] } ] } } }

                      
                      {
  "code": 0,
  "message": "OK",
  "data": {
    "CHAT": {
      "OPEN_AI": [
        {
          "model_name": "GPT-4o",
          "aiModelVersion": "gpt-4o",
          "modelId": "mv-xxxx",
          "capabilities": ["pluginSupport", "ImageRecognition", "jsonSchema"]
        }
      ]
    }
  }
}

This code block in the floating window

Success Response

Field	Type	Description
model_name	String	Model display name.
aiModelVersion	String	Model version name.
modelId	String	Model version ID, used when other endpoints reference the model.
capabilities	String[]	List of model capabilities.

Failure Response

Field	Type	Description
code	Integer	Error code.
message	String	Error details.

Status Codes

Status Code	Description
200	Success
400	Parameter error
401	Unauthorized
403	Insufficient permissions
429	Too many requests
500	Server error