Get a model by ID

cadenya models retrieve _123

{
  "metadata": {
    "id": "<string>",
    "accountId": "account_01HXKD2E5NQM3T9AYWCFTJHJVF",
    "workspaceId": "workspace_01HXKD2E5NQM3T9AYWCF133E3Q",
    "name": "<string>",
    "externalId": "<string>",
    "labels": {},
    "profileId": "profile_01HXKD2E5NQM3T9AYWCFS0AP08",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  },
  "spec": {
    "provider": "<string>",
    "family": "<string>",
    "maxInputTokens": 123,
    "maxOutputTokens": 123,
    "inputPricePerMillionTokens": "<string>",
    "outputPricePerMillionTokens": "<string>",
    "capabilities": [
      {
        "type": "temperature",
        "temperature": {}
      }
    ],
    "providerModelId": "<string>",
    "cachedInputPricePerMillionTokens": "<string>"
  },
  "state": "STATE_UNSPECIFIED",
  "provenance": "PROVENANCE_UNSPECIFIED",
  "basePricing": {
    "inputPricePerMillionTokens": "<string>",
    "outputPricePerMillionTokens": "<string>",
    "cachedInputPricePerMillionTokens": "<string>"
  },
  "info": {
    "agentVariationCount": 123,
    "aiProviderKey": {
      "metadata": {
        "id": "<string>",
        "accountId": "account_01HXKD2E5NQM3T9AYWCFTJHJVF",
        "workspaceId": "workspace_01HXKD2E5NQM3T9AYWCF133E3Q",
        "name": "<string>",
        "externalId": "<string>",
        "labels": {},
        "profileId": "profile_01HXKD2E5NQM3T9AYWCFS0AP08",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z"
      },
      "spec": {
        "provider": "AI_PROVIDER_UNSPECIFIED",
        "credentials": {
          "type": "apiKey",
          "apiKey": {
            "apiKey": "<string>"
          }
        },
        "config": {
          "type": "openrouter",
          "openrouter": {
            "region": "<string>"
          }
        }
      },
      "info": {
        "enabledModelCount": 123,
        "disabledModelCount": 123,
        "isPromotional": true,
        "modelManagement": "MODEL_MANAGEMENT_UNSPECIFIED",
        "credentialStatus": {
          "type": "<string>",
          "fields": [
            {
              "name": "<string>",
              "sensitive": true,
              "configured": true,
              "value": "<string>"
            }
          ]
        }
      }
    },
    "lastUsedAt": "2023-11-07T05:31:56Z"
  },
  "pricingOverride": {
    "inputPricePerMillionTokens": "<string>",
    "outputPricePerMillionTokens": "<string>",
    "cachedInputPricePerMillionTokens": "<string>"
  }
}

{
  "code": 123,
  "message": "<string>",
  "details": [
    {
      "@type": "type.googleapis.com/google.rpc.ErrorInfo",
      "domain": "api.cadenya.com",
      "reason": "TOKEN_EXPIRED",
      "metadata": {}
    }
  ]
}

GET

workspaces

{workspaceId}

models

{id}

cadenya models retrieve _123

{
  "metadata": {
    "id": "<string>",
    "accountId": "account_01HXKD2E5NQM3T9AYWCFTJHJVF",
    "workspaceId": "workspace_01HXKD2E5NQM3T9AYWCF133E3Q",
    "name": "<string>",
    "externalId": "<string>",
    "labels": {},
    "profileId": "profile_01HXKD2E5NQM3T9AYWCFS0AP08",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  },
  "spec": {
    "provider": "<string>",
    "family": "<string>",
    "maxInputTokens": 123,
    "maxOutputTokens": 123,
    "inputPricePerMillionTokens": "<string>",
    "outputPricePerMillionTokens": "<string>",
    "capabilities": [
      {
        "type": "temperature",
        "temperature": {}
      }
    ],
    "providerModelId": "<string>",
    "cachedInputPricePerMillionTokens": "<string>"
  },
  "state": "STATE_UNSPECIFIED",
  "provenance": "PROVENANCE_UNSPECIFIED",
  "basePricing": {
    "inputPricePerMillionTokens": "<string>",
    "outputPricePerMillionTokens": "<string>",
    "cachedInputPricePerMillionTokens": "<string>"
  },
  "info": {
    "agentVariationCount": 123,
    "aiProviderKey": {
      "metadata": {
        "id": "<string>",
        "accountId": "account_01HXKD2E5NQM3T9AYWCFTJHJVF",
        "workspaceId": "workspace_01HXKD2E5NQM3T9AYWCF133E3Q",
        "name": "<string>",
        "externalId": "<string>",
        "labels": {},
        "profileId": "profile_01HXKD2E5NQM3T9AYWCFS0AP08",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z"
      },
      "spec": {
        "provider": "AI_PROVIDER_UNSPECIFIED",
        "credentials": {
          "type": "apiKey",
          "apiKey": {
            "apiKey": "<string>"
          }
        },
        "config": {
          "type": "openrouter",
          "openrouter": {
            "region": "<string>"
          }
        }
      },
      "info": {
        "enabledModelCount": 123,
        "disabledModelCount": 123,
        "isPromotional": true,
        "modelManagement": "MODEL_MANAGEMENT_UNSPECIFIED",
        "credentialStatus": {
          "type": "<string>",
          "fields": [
            {
              "name": "<string>",
              "sensitive": true,
              "configured": true,
              "value": "<string>"
            }
          ]
        }
      }
    },
    "lastUsedAt": "2023-11-07T05:31:56Z"
  },
  "pricingOverride": {
    "inputPricePerMillionTokens": "<string>",
    "outputPricePerMillionTokens": "<string>",
    "cachedInputPricePerMillionTokens": "<string>"
  }
}

{
  "code": 123,
  "message": "<string>",
  "details": [
    {
      "@type": "type.googleapis.com/google.rpc.ErrorInfo",
      "domain": "api.cadenya.com",
      "reason": "TOKEN_EXPIRED",
      "metadata": {}
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

workspaceId

string

required

Workspace ID.

Example:

"workspace_01HXKD2E5NQM3T9AYWCF133E3Q"

string

required

Model ID

Example:

"model_01HXKD2E5NQM3T9AYWCFKJ4GED"

Response

metadata

object

required

Resource metadata

Show child attributes

spec

object

required

Model specification

Show child attributes

state

enum<string>

required

read-only

Whether the model is usable in this workspace. Output only. Use the :enable and :disable actions to transition.

Available options:

STATE_UNSPECIFIED,

STATE_ENABLED,

STATE_DISABLED

provenance

enum<string>

required

read-only

Where this definition came from. Output only; set at creation. Synced models reject edits to metadata.name and spec, manually entered models accept them.

Available options:

PROVENANCE_UNSPECIFIED,

PROVENANCE_SYNCED_FROM_PROVIDER,

PROVENANCE_MANUALLY_ENTERED

basePricing

object

required

The rates before any customer override: the catalog rate for a synced model, the entered rate for a manually entered one. Output only. When a side matches the spec price, an override may still be present; inspect pricing_override field presence to determine whether an override is set.

Show child attributes

info

object

Server-populated info (e.g. the AI provider this model routes through). Populated on reads when requested; see ListModelsRequest.include_info.

Show child attributes

pricingOverride

object

Customer price overrides. Output only here; set through UpdateModel with pricing_override.* mask paths. When an override is present, spec's price fields already reflect it (they are the effective prices).

Show child attributes

Overview

Tool Sets

Tools

Tool Set Secrets

Agents

Agent Variations

Agent Schedules

Objectives

Widgets

Widget Sessions

Tenants

Memory Layers

Memory Entries

Models

Uploads

Workspaces

Workspace Secrets

Workspace Admin

Accounts

API Keys

AI Provider Keys

Webhook Events

Get a model by ID

Authorizations

Path Parameters

Response