Skip to content
General Augment Docs

List Models

GET
/api/v3/models
curl --request GET \
  --url https://example.com/api/v3/models

Return only models selectable under current lifecycle, binding, region, and capability.

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
project_id
Any of:
string format: uuid
region
Any of:
string
>= 1 characters <= 80 characters
capability
Any of:
Array<string>
<= 20 items

Header Parameters

Section titled “Header Parameters”
X-Admin-Key
Any of:
string

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
ModelCatalogResponseV3

Versioned model catalog filtered by runtime authority and capability.

object
catalog_fingerprint
required
Catalog Fingerprint
string
catalog_version
required
Catalog Version
string
/^[0-9]{4}-[0-9]{2}-[0-9]{2}\.[1-9][0-9]*$/
default_reasons
required
ModelCatalogDefaultReasonsV3

Eligibility reasons for each nullable effective default.

object
balanced
Balanced
Array<string>
complex
Complex
Array<string>
simple
Simple
Array<string>
defaults
required
ModelCatalogDefaultsV3

Effective defaults after applying the requested runtime context.

object
balanced
required
Any of:
string
complex
required
Any of:
string
simple
required
Any of:
string
excluded
required
Excluded
Array<object>
ModelCatalogExcludedV3

Redacted reason a catalog model was excluded from a projection.

object
id
required
Id
string
reasons
required
Reasons
Array<string>
>= 1 items
items
required
Items
Array<object>
ModelCatalogItemV3

One model eligible for the requested runtime selection context.

object
availability_basis
required
Availability Basis
string
Allowed value: provider_documented_unprobed
binding_source
required
Binding Source
string
Allowed values: platform project_byok
capabilities
required
Capabilities
Array<string>
id
required
Id
string
kind
required
Kind
string
Allowed values: chat embedding
lifecycle
required
Lifecycle
string
Allowed values: selectable pinned_only disabled
pricing
required
Pricing
Array<object>
ModelCatalogPricingV3

Effective pricing exposed to authenticated operators.

object
cache_read_usd_per_million
required
Cache Read Usd Per Million
number
cache_write_usd_per_million
required
Cache Write Usd Per Million
number
effective_from
required
Effective From
string
effective_to
Any of:
string
input_usd_per_million
required
Input Usd Per Million
number
output_usd_per_million
required
Output Usd Per Million
number
provider
required
Provider
string
regions
required
Regions
Array<string>
semantic_tiers
required
Semantic Tiers
Array<string>
Allowed values: simple balanced complex
project_id
required
Any of:
string
region
required
Region
string
requested_capabilities
required
Requested Capabilities
Array<string>
schema_version
required
Schema Version
string
Allowed value: model-catalog.v1
Example
{
  "items": [
    {
      "availability_basis": "provider_documented_unprobed",
      "binding_source": "platform",
      "kind": "chat",
      "lifecycle": "selectable",
      "semantic_tiers": [
        "simple"
      ]
    }
  ],
  "schema_version": "model-catalog.v1"
}

401

Section titled “401”

Authentication failed with a resumable next action.

Media typeapplication/json
ManagementErrorEnvelope

FastAPI error envelope shared by v3 management endpoints.

object
detail
required
ManagementErrorResponse

One bounded error with a coding-agent-safe recovery action.

object
affected_resource
Any of:
string
message
required
Message
string
next_action
Any of:
string
operation_id
Any of:
string format: uuid
phase
Any of:
string
reason_code
required
Reason Code
string
Examplegenerated
{
  "detail": {
    "affected_resource": "example",
    "message": "example",
    "next_action": "example",
    "operation_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "phase": "example",
    "reason_code": "example"
  }
}

403

Section titled “403”

The authenticated actor lacks the required Project authority.

Media typeapplication/json
ManagementErrorEnvelope

FastAPI error envelope shared by v3 management endpoints.

object
detail
required
ManagementErrorResponse

One bounded error with a coding-agent-safe recovery action.

object
affected_resource
Any of:
string
message
required
Message
string
next_action
Any of:
string
operation_id
Any of:
string format: uuid
phase
Any of:
string
reason_code
required
Reason Code
string
Examplegenerated
{
  "detail": {
    "affected_resource": "example",
    "message": "example",
    "next_action": "example",
    "operation_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "phase": "example",
    "reason_code": "example"
  }
}

404

Section titled “404”

The scoped management resource was not found.

Media typeapplication/json
ManagementErrorEnvelope

FastAPI error envelope shared by v3 management endpoints.

object
detail
required
ManagementErrorResponse

One bounded error with a coding-agent-safe recovery action.

object
affected_resource
Any of:
string
message
required
Message
string
next_action
Any of:
string
operation_id
Any of:
string format: uuid
phase
Any of:
string
reason_code
required
Reason Code
string
Examplegenerated
{
  "detail": {
    "affected_resource": "example",
    "message": "example",
    "next_action": "example",
    "operation_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "phase": "example",
    "reason_code": "example"
  }
}

409

Section titled “409”

A stable management invariant prevented progress.

Media typeapplication/json
ManagementErrorEnvelope

FastAPI error envelope shared by v3 management endpoints.

object
detail
required
ManagementErrorResponse

One bounded error with a coding-agent-safe recovery action.

object
affected_resource
Any of:
string
message
required
Message
string
next_action
Any of:
string
operation_id
Any of:
string format: uuid
phase
Any of:
string
reason_code
required
Reason Code
string
Examplegenerated
{
  "detail": {
    "affected_resource": "example",
    "message": "example",
    "next_action": "example",
    "operation_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "phase": "example",
    "reason_code": "example"
  }
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}