List models

models.list(workspace_id, **kwargs) -> CursorPagination<Model { metadata, spec } >

GET/v1/workspaces/{workspaceId}/models

Lists all models in the workspace

ParametersExpand Collapse

workspace_id: String

bundle_key: String

Filter by bundle_key — return only resources owned by this bundle.

cursor: String

Pagination cursor from previous response

limit: Integer

Maximum number of results to return

formatint32

prefix: String

Filter by name prefix

query: String

Free-form search query

sort_order: String

Sort order for results (asc or desc by creation time)

status: :MODEL_STATUS_UNSPECIFIED | :MODEL_STATUS_ENABLED | :MODEL_STATUS_DISABLED

Filter by model status

formatenum

One of the following:

:MODEL_STATUS_UNSPECIFIED

:MODEL_STATUS_ENABLED

:MODEL_STATUS_DISABLED

ReturnsExpand Collapse

class Model { metadata, spec }

metadata: ResourceMetadata { id, account_id, created_at, 6 more }

Standard metadata for persistent, named resources (e.g., agents, tools, prompts)

id: String

Unique identifier for the resource (prefixed ULID, e.g., “agent_01HXK…”)

account_id: String

Account this resource belongs to for multi-tenant isolation (prefixed ULID)

created_at: Time

Timestamp when this resource was created

formatdate-time

name: String

Human-readable name for the resource (e.g., “Customer Support Agent”, “Email Tool”) Required for resources that users interact with directly

profile_id: String

ID of the actor (user or service account) that created this resource

workspace_id: String

Workspace this resource belongs to for organizational grouping (prefixed ULID)

bundle_key: String

Optional bundle ownership key. When set, indicates the resource is managed by a configuration bundle identified by this key. Used by BulkWorkspaceResources.Apply to track which resources belong to which bundle for reconciliation / soft-delete on re-apply.

external_id: String

External ID for the resource (e.g., a workflow ID from an external system)

labels: Hash[Symbol, String]

Arbitrary key-value pairs for categorization and filtering Examples: {“environment”: “production”, “team”: “platform”, “version”: “v2”}

spec: ModelSpec { family, input_price_per_million_tokens, max_input_tokens, 4 more }

Model specification

family: String

The model family (e.g., “claude-sonnet-4.6”, “gpt-5.4”, “gemini-2.5-flash”)

input_price_per_million_tokens: String

Cost per million input tokens in cents (e.g., 300 = $3.00)

max_input_tokens: Integer

Maximum number of input tokens the model supports

formatint32

max_output_tokens: Integer

Maximum number of output tokens the model can generate

formatint32

output_price_per_million_tokens: String

Cost per million output tokens in cents (e.g., 1500 = $15.00)

provider: String

The model provider (e.g., “anthropic”, “openai”, “google”)

status: :MODEL_STATUS_UNSPECIFIED | :MODEL_STATUS_ENABLED | :MODEL_STATUS_DISABLED

The status of the model in the workspace

formatenum

One of the following:

:MODEL_STATUS_UNSPECIFIED

:MODEL_STATUS_ENABLED

:MODEL_STATUS_DISABLED

List models

require "cadenya"

cadenya = Cadenya::Client.new(api_key: "My API Key")

page = cadenya.models.list("workspaceId")

puts(page)

{
  "items": [
    {
      "metadata": {
        "id": "id",
        "accountId": "accountId",
        "createdAt": "2019-12-27T18:11:19.117Z",
        "name": "name",
        "profileId": "profileId",
        "workspaceId": "workspaceId",
        "bundleKey": "bundleKey",
        "externalId": "externalId",
        "labels": {
          "foo": "string"
        }
      },
      "spec": {
        "family": "family",
        "inputPricePerMillionTokens": "inputPricePerMillionTokens",
        "maxInputTokens": 0,
        "maxOutputTokens": 0,
        "outputPricePerMillionTokens": "outputPricePerMillionTokens",
        "provider": "provider",
        "status": "MODEL_STATUS_UNSPECIFIED"
      }
    }
  ],
  "pagination": {
    "nextCursor": "nextCursor",
    "total": 0
  }
}

Returns Examples

{
  "items": [
    {
      "metadata": {
        "id": "id",
        "accountId": "accountId",
        "createdAt": "2019-12-27T18:11:19.117Z",
        "name": "name",
        "profileId": "profileId",
        "workspaceId": "workspaceId",
        "bundleKey": "bundleKey",
        "externalId": "externalId",
        "labels": {
          "foo": "string"
        }
      },
      "spec": {
        "family": "family",
        "inputPricePerMillionTokens": "inputPricePerMillionTokens",
        "maxInputTokens": 0,
        "maxOutputTokens": 0,
        "outputPricePerMillionTokens": "outputPricePerMillionTokens",
        "provider": "provider",
        "status": "MODEL_STATUS_UNSPECIFIED"
      }
    }
  ],
  "pagination": {
    "nextCursor": "nextCursor",
    "total": 0
  }
}