Consultar la lista de modelos de la plataforma
Consultar la lista de modelos de la plataforma
Permite consultar la lista de modelos de la plataforma; al proporcionar el ID de la organización, se pueden consultar los modelos realmente disponibles para dicha organización.
Mediante esta interfaz, se puede consultar la lista de modelos de la plataforma; al proporcionar org_id, se devuelven los modelos realmente disponibles para dicha organización, incluidos los modelos configurados por la propia organización.
Método de solicitud
GET
URL de la solicitud
https://api.${endpoint}/v1/model/list
Autenticación de la solicitud
Utiliza la autenticación Basic con DevKey / DevSecret a nivel de cuenta.
Solicitud
Ejemplo de solicitud
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}'
Este bloque de código en una ventana flotante
Cabeceras de la solicitud
| Campo | Tipo | Descripción |
|---|---|---|
| Authorization | Basic ${BASIC_TOKEN} | Basic Token resultante de codificar DevKey:DevSecret en Base64. |
Parámetros de la solicitud (Query Parameters)
| Campo | Tipo | Descripción | Obligatorio |
|---|---|---|---|
| org_id | String | ID de la organización. Al proporcionarlo, se verifica la pertenencia a la organización y se devuelven los modelos disponibles para dicha organización. | true |
| agent_type | String | Tipo de Agent. Admite AGENT, FLOW_AGENT, LOOP_AGENT, WORKFLOW; |
true |
Respuesta
Ejemplo de respuesta
{
"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"]
}
]
}
}
}
Este bloque de código en una ventana flotante
Respuesta correcta
| Campo | Tipo | Descripción |
|---|---|---|
| model_name | String | Nombre de visualización del modelo. |
| aiModelVersion | String | Nombre de la versión del modelo. |
| modelId | String | ID de la versión del modelo, utilizado al referenciar el modelo en otras interfaces. |
| capabilities | String[] | Lista de capacidades del modelo. |
Respuesta fallida
| Campo | Tipo | Descripción |
|---|---|---|
| code | Integer | Código de error. |
| message | String | Detalles del error. |
Códigos de estado
| Código de estado | Descripción |
|---|---|
| 200 | Correcto |
| 400 | Error de parámetros |
| 401 | No autorizado |
| 403 | Permisos insuficientes |
| 429 | Demasiadas solicitudes |
| 500 | Error del servidor |
