Overview
This interface is used to return the list of OpenAI compatible models visible to the current API Key.
API details
Constraints
- The caller needs to have an API Key. For more information, see Manage AI API Key.
Request path
GET {BASE_URL}/api/v1/models
Request header
Name |
Required |
Example value |
Description |
|---|---|---|---|
| Authorization | Yes | Bearer {token} | Authorization information |
| Content-Type | No | application/json | Request body format |
Request parameters
Path
None
Query
None
Body
None
Response
Response parameters
Name |
Type |
Description |
|---|---|---|
| success | boolean | Whether the request was successful |
| code | string | Return code |
| message | string | Return information |
| data | object | Business return data |
data
The specific structure of the returned data is unknown.
Request example
curl --request GET '{BASE_URL}/api/v1/models' \
--header 'Authorization: Bearer {token}'
Response example
{
"success": true,
"code": "200",
"message": "successful",
"data": {}
}