Skip to main content
GET
/
api
/
models
/
list
List Models
curl --request GET \
  --url https://api.example.com/api/models/list
{
  "items": [
    {
      "id": "<string>",
      "user_id": "<string>",
      "base_model_id": "<string>",
      "name": "<string>",
      "params": {},
      "meta": {
        "profile_image_url": "<string>",
        "description": "<string>",
        "capabilities": {}
      },
      "access_grants": [
        {}
      ],
      "is_active": true,
      "write_access": true,
      "user": {
        "id": "<string>",
        "name": "<string>",
        "email": "<string>"
      },
      "created_at": 123,
      "updated_at": 123
    }
  ],
  "total": 123
}

​
Query Parameters

​
query
string
Search query to filter models by name, base_model_id, or user information
​
view_option
string
Filter models by ownership:
  • created - Only models created by the current user
  • shared - Only models shared with the current user
​
tag
string
Filter models by tag name
​
order_by
string
Field to sort by:
  • name - Sort by model name
  • created_at - Sort by creation date
  • updated_at - Sort by last update date
​
direction
string
Sort direction:
  • asc - Ascending order
  • desc - Descending order (default)
​
page
integer
default:1
Page number for pagination (30 items per page)

​
Response

​
items
array
Array of model objects with access information
​
id
string
The model’s unique identifier used in API calls
​
user_id
string
ID of the user who created the model
​
base_model_id
string
Optional pointer to the actual model used when proxying requests
​
name
string
Human-readable display name of the model
​
params
object
JSON object containing model parameters
​
meta
object
Metadata about the model
​
profile_image_url
string
URL or data URI for the model’s profile image
​
description
string
User-facing description of the model
​
capabilities
object
Object describing model capabilities
​
access_grants
array
Array of access grant objects defining permissions
​
is_active
boolean
Whether the model is currently active
​
write_access
boolean
Whether the current user has write access to this model
​
user
object
Information about the user who created the model
​
id
string
User ID
​
name
string
User’s display name
​
email
string
User’s email address
​
created_at
integer
Unix timestamp of when the model was created
​
updated_at
integer
Unix timestamp of when the model was last updated
​
total
integer
Total number of models matching the filter criteria

​
Example Request

curl -X GET "https://api.example.com/api/models/list?page=1&order_by=created_at&direction=desc" \
  -H "Authorization: Bearer YOUR_API_KEY"

​
Example Response

{
  "items": [
    {
      "id": "gpt-4-custom",
      "user_id": "user123",
      "base_model_id": "gpt-4",
      "name": "Custom GPT-4",
      "params": {
        "temperature": 0.7,
        "max_tokens": 2000
      },
      "meta": {
        "profile_image_url": "/static/favicon.png",
        "description": "A customized GPT-4 model for specific tasks",
        "capabilities": {
          "vision": true,
          "function_calling": true
        }
      },
      "access_grants": [],
      "is_active": true,
      "write_access": true,
      "user": {
        "id": "user123",
        "name": "John Doe",
        "email": "john@example.com"
      },
      "created_at": 1704067200,
      "updated_at": 1704153600
    }
  ],
  "total": 1
}