Skip to main content
GET
/
models
List the organization's models
curl --request GET \
  --url https://api.samsa.ai/public/v1/models \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "is_ready": true,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "category": "style",
      "thumbnail_url": "https://cdn.samsa.ai/models/…/thumbnail.webp?X-Amz-Signature=…"
    }
  ],
  "pagination": {
    "limit": 123,
    "offset": 123,
    "has_more": true
  }
}
Returns a page of the models owned by your organization, most recently created first. Filter by category (style, object, person, setting) and/or status, and paginate with limit and offset. The response includes a pagination object (limit, offset, has_more). Requires the models.read scope.

Authorizations

​
Authorization
string
header
required

Organization API key as a bearer token: Authorization: Bearer samsa_sk_....

Headers

​
authorization
string | null

Query Parameters

​
category
enum<string> | null

Filter to a single category. Public model category (ADR §8.2).

Maps to the internal ModelType stored in models.type (NOT the separate models.category column). setting is the public name for internal SCENE; the others are a straight upper/lower-case swap. Internal BASE is never exposed publicly.

Available options:
style,
object,
person,
setting
​
status
enum<string> | null

Filter to a single creation status. Public model creation / readiness status — the lower-cased internal status.

Available options:
pending,
processing,
completed,
failed
​
limit
integer
default:20

Maximum number of models to return (1-100).

Required range: 1 <= x <= 100
​
offset
integer
default:0

Number of models to skip.

Required range: x >= 0

Response

Successful Response

GET /models response — one page of the organization's models.

​
data
PublicModelSummary · object[]
required
​
pagination
Pagination · object
required

Offset-pagination metadata for list responses.