Get Model List

Endpoint: GET /v1/models
  • When user is logged in, get the available list under the user group; when user is not logged in, get the available list under the default group.
  • If there is an Authorization field in the header, query the model list configured under the token corresponding to the key.
Response Example:
{
  "data": [
    {
      "id": "gpt-4o-mini",
      "object": "model",
      "created": 1626777600,
      "owned_by": "OpenAI",
      "permission": [
        {
          "id": "modelperm-LwHkVFn8AcMItP432fKKDIKJ",
          "object": "model_permission",
          "created": 1626777600,
          "allow_create_engine": true,
          "allow_sampling": true,
          "allow_logprobs": true,
          "allow_search_indices": false,
          "allow_view": true,
          "allow_fine_tuning": false,
          "organization": "*",
          "group": null,
          "is_blocking": false
        }
      ],
      "root": "gpt-4o-mini",
      "parent": null
    }
  ]
}

Response Results

Status CodeStatus Code MeaningDescriptionData Model
200OKnoneInline

Response Data Structure

Status Code 200
NameTypeRequiredConstraintChinese NameDescription
» data[object]truenonenone
»» idstringtruenoneModel IDnone
»» objectstringtruenonemodelnone
»» createdintegertruenoneCreation Timenone
»» owned_bystringtruenoneDevelopernone
»» permission[object]¦nulltruenonenone
»»» idstringtruenonenone
»»» objectstringtruenonenone
»»» createdintegertruenonenone
»»» allow_create_enginebooleantruenonenone
»»» allow_samplingbooleantruenonenone
»»» allow_logprobsbooleantruenonenone
»»» allow_search_indicesbooleantruenonenone
»»» allow_viewbooleantruenonenone
»»» allow_fine_tuningbooleantruenonenone
»»» organizationstringtruenonenone
»»» groupnulltruenonenone
»»» is_blockingbooleantruenonenone
»» rootstringtruenoneModel Namenone
»» parentnulltruenoneParent Nodenone

Get Model Information

Endpoint: GET /v1/models/:model

Request Parameters

NameLocationTypeRequiredDescription
modelpathstringYesModel ID
Response Example:
200 Response
{
  "id": "string",
  "object": "string",
  "created": 0,
  "owned_by": "string",
  "permission": [
    {
      "id": "string",
      "object": "string",
      "created": 0,
      "allow_create_engine": true,
      "allow_sampling": true,
      "allow_logprobs": true,
      "allow_search_indices": true,
      "allow_view": true,
      "allow_fine_tuning": true,
      "organization": "string",
      "group": null,
      "is_blocking": true
    }
  ],
  "root": "string",
  "parent": null
}

Response Results

Status CodeStatus Code MeaningDescriptionData Model
200OKnoneInline

Response Data Structure

Status Code 200
NameTypeRequiredConstraintChinese NameDescription
idstringtruenoneModel IDnone
objectstringtruenonemodelnone
createdintegertruenoneCreation Timenone
owned_bystringtruenoneDevelopernone
permission[object]truenonenone
» idstringfalsenonenone
» objectstringfalsenonenone
» createdintegerfalsenonenone
» allow_create_enginebooleanfalsenonenone
» allow_samplingbooleanfalsenonenone
» allow_logprobsbooleanfalsenonenone
» allow_search_indicesbooleanfalsenonenone
» allow_viewbooleanfalsenonenone
» allow_fine_tuningbooleanfalsenonenone
» organizationstringfalsenonenone
» groupnullfalsenonenone
» is_blockingbooleanfalsenonenone
rootstringtruenoneModel Namenone
parentnulltruenoneParent Nodenone