getPricingHistory.md
Get a pricing rule's history
Returns every version of a single rule (current, scheduled, archived, and prior live versions), newest first.
OpenAPI
api-reference/llm-gateway-openapi.yml
get /admin/model-pricing/history
openapi: 3.1.0
info:
title: Barndoor LLM Gateway API
version: 1.0.0
description: >
REST API for the Barndoor LLM Gateway: configure providers, model routes,
pricing, governance, and operate a multi-provider LLM platform
programmatically.
All endpoints in this document are scoped to your organization. They are the
same APIs powering the Barndoor portal under **LLM Configuration**,
**LLM Controls**, and **Settings - My Models**, exposed for teams that
prefer scripting over the UI.
## Base URL
All requests are issued against your Barndoor instance:
``
https://app.barndoor.ai/api/llm-gateway
```
Replace `app.barndoor.ai` with your tenant host if you run on Enterprise.
## Authentication
Endpoints accept a JWT Bearer token issued by your Barndoor identity
provider. Tokens can be obtained interactively via the Barndoor SDK:
```ts
const sdk = await loginInteractive();
```
The token must be sent in the `Authorization` header on every request:
```
Authorization: Bearer eyJhbGciOi...
```
Note: the `bd-...` API keys you create through these endpoints are for
runtime LLM traffic (`/v1/chat/completions`, `/v1/messages`, etc.), not for
administrative calls. Administrative endpoints require a user/admin JWT.
## Permissions
Most endpoints require an `admin` (or higher) role on the calling user.
Read-only endpoints are typically accessible by all authenticated users.
Read-only listings under `/user/...` are scoped to the authenticated user.
## Errors
Errors are returned as JSON with a stable shape:
```json
{ "error": "BadRequest", "message": "request_timeout_secs must be between 1 and 3600" }
```
contact:
name: Barndoor Support
url: https://barndoor.ai
servers:
- url: https://{host}/api/llm-gateway
description: >-
Production / Trial (Barndoor SaaS). The gateway lives on your Barndoor
control-plane host. For Enterprise or self-hosted deployments, replace the
host with your portal hostname — the authoritative value is shown on
Settings → My Models in the portal.
variables:
host:
description: Your Barndoor control-plane (portal) hostname
default: app.barndoor.ai
- url: https://app.barndooruat.com/api/llm-gateway
description: UAT
- url: https://app.barndoordev.com/api/llm-gateway
description: Dev
security:
- BearerAuth: []
tags:
- name: Credentials
description: >-
Reusable upstream credentials (API keys, AWS roles, Vertex service
accounts)
- name: Providers
description: Named upstream providers backed by credentials and a model family
- name: Provider Catalog
description: Read-only catalog of supported upstream provider templates
- name: Model Routes
description: Map client-facing aliases to one or more upstream provider/model pairs
- name: Model Pricing
description: Per-million-token input/output costs for usage and budget reporting
- name: Rate Limits
description: Requests-per-minute and tokens-per-minute caps
- name: Token Budgets
description: Daily, weekly, or monthly token and cost ceilings
- name: Model Access
description: Allowlist or denylist policies for models, providers, or aliases
- name: Smart Models
description: Routing policies that pick a target model based on the request
- name: Governance Configuration
description: Org-wide behavior toggles for the LLM Gateway
- name: Route Health
description: Operational view of upstream route ejection and recovery
- name: API Keys
description: Org-managed gateway API keys (the `bd-...` keys callers send on `/v1/...`)
- name: User
description: Self-service endpoints for the authenticated user
paths:
/admin/model-pricing/history:
get:
tags:
- Model Pricing
summary: Get a pricing rule's history
description: |
Returns every version of a single rule (current, scheduled, archived,
and prior live versions), newest first.
operationId: getModelPricingHistory
parameters:
- name: model_pattern
in: query
required: true
schema:
type: string
example: gpt-4o-mini
- name: model_provider
in: query
required: false
schema:
type: string
responses:
'200':
description: List of pricing versions, newest first
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ModelPricingRule'
components:
schemas:
ModelPricingRule:
type: object
description: |
A single pricing rule version. Each "rule" (logical row) has a stack
of versions; the latest version with `effective_from <= now()` is the
one that bills.
required:
- id
- org_id
- model_pattern
- input_cost_per_million_tokens
- output_cost_per_million_tokens
- effective_from
- sync_mode
- change_source
- is_archived
properties:
id:
type: string
format: uuid
org_id:
type: string
format: uuid
model_provider:
type: string
nullable: true
model_pattern:
type: string
description: Upstream model name (or `*` wildcard)
example: gpt-4o-mini
provider_id:
type: string
format: uuid
nullable: true
description: When set, the rule only applies to routes served by this provider
catalog_slug:
type: string
nullable: true
input_cost_per_million_tokens:
type: number
example: 0.15
output_cost_per_million_tokens:
type: number
example: 0.6
cache_read_cost_per_million_tokens:
type: number
nullable: true
cache_write_cost_per_million_tokens:
type: number
nullable: true
effective_from:
type: string
format: date-time
description: When this version takes effect. Past = active; future = scheduled
sync_mode:
$ref: '#/components/schemas/PricingSyncMode'
change_source:
$ref: '#/components/schemas/PricingChangeSource'
change_reason:
type: string
nullable: true
created_by_user_id:
type: string
format: uuid
nullable: true
created_by_email:
type: string
nullable: true
is_archived:
type: boolean
PricingSyncMode:
type: string
description: |
How the row tracks Barndoor's managed defaults:
- `tracking` — show the user a prompt when defaults change
- `pinned` — never sync; this is your number
- `auto` — silently follow updates to the managed defaults
enum:
- tracking
- pinned
- auto
PricingChangeSource:
type: string
description: How this version of the pricing rule was produced
enum:
- admin_create
- admin_edit
- admin_schedule
- import
- sync_manual
- sync_auto
- admin_archive
- admin_restore
securitySchemes:
BearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
description: |
JWT obtained through Barndoor's authentication flow. Pass the token
verbatim in `Authorization: Bearer <token>`. Use the Barndoor SDK's
`loginInteractive()` helper to obtain a token in scripts and notebooks.