Skip to content
Get started

List models

client.Models.List(ctx, query) (*CursorPagination[Model], error)
GET/v1/models

Lists all models in the workspace

ParametersExpand Collapse
query ModelListParams
Cursor param.Field[string]optional

Pagination cursor from previous response

Limit param.Field[int64]optional

Maximum number of results to return

formatint32
Prefix param.Field[string]optional

Filter by name prefix

SortOrder param.Field[string]optional

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

Status param.Field[ModelListParamsStatus]optional

Filter by model status

formatenum
const ModelListParamsStatusModelStatusUnspecified ModelListParamsStatus = "MODEL_STATUS_UNSPECIFIED"
const ModelListParamsStatusModelStatusEnabled ModelListParamsStatus = "MODEL_STATUS_ENABLED"
const ModelListParamsStatusModelStatusDisabled ModelListParamsStatus = "MODEL_STATUS_DISABLED"
ReturnsExpand Collapse
type Model struct{…}

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

ID string

Unique identifier for the resource (prefixed ULID, e.g., "agent_01HXK...")

AccountID string

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

CreatedAt 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

ProfileID string

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

WorkspaceID string

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

ExternalID stringoptional

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

Labels map[string, string]optional

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

Model specification

Family stringoptional

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

InputPricePerMillionTokens stringoptional

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

MaxInputTokens int64optional

Maximum number of input tokens the model supports

formatint32
MaxOutputTokens int64optional

Maximum number of output tokens the model can generate

formatint32
OutputPricePerMillionTokens stringoptional

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

Provider stringoptional

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

Status ModelSpecStatusoptional

The status of the model in the workspace

formatenum
One of the following:
const ModelSpecStatusModelStatusUnspecified ModelSpecStatus = "MODEL_STATUS_UNSPECIFIED"
const ModelSpecStatusModelStatusEnabled ModelSpecStatus = "MODEL_STATUS_ENABLED"
const ModelSpecStatusModelStatusDisabled ModelSpecStatus = "MODEL_STATUS_DISABLED"

List models

package main

import (
  "context"
  "fmt"

  "github.com/cadenya/cadenya-go"
  "github.com/cadenya/cadenya-go/option"
)

func main() {
  client := cadenya.NewClient(
    option.WithAPIKey("My API Key"),
  )
  page, err := client.Models.List(context.TODO(), cadenya.ModelListParams{

  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", page)
}
{
  "items": [
    {
      "metadata": {
        "id": "id",
        "accountId": "accountId",
        "createdAt": "2019-12-27T18:11:19.117Z",
        "name": "name",
        "profileId": "profileId",
        "workspaceId": "workspaceId",
        "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",
        "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
  }
}