Skip to navigation

Update a cost model

Changes the name, the overrides, the status, and for a custom cost model the kind, declared units and dimensions. Sending overrides replaces the whole list. Provider, model, source and catalog model can’t change. Archiving a cost model stops new rate cards and price rules from using it; costs already recorded keep the version that priced them. In live mode an agent’s write is refused with 403 and proposal_required: put the same object in a config proposal. People change live configuration in the dashboard.

Authentication

AuthorizationBearer

A secret key (rl_sk_test_..., rl_sk_live_...) or a restricted key with limited scopes (rl_rk_test_..., rl_rk_live_...). A restricted key can carry agent: true and an expires_at, and is what a coding agent should hold. Keys end in a checksum so secret scanners can recognize them. People create, roll and revoke keys in the dashboard; GET /v1/api_keys lists them, masked.

Path parameters

cost_modelstringRequired

The cost model ID (cm_...) or its key.

Headers

Runledger-Dry-RunbooleanOptional

Send true to see what the write would do without doing it. The response is the normal body with dry_run: true, changes (path, before, after), warnings and errors added, and nothing is stored. Validation runs as it would for a real write. The request is kept in request logs, tagged Dry run. When the same change is then made for real, its audit event has dry_run_preceded: true.

Request

This endpoint expects an object.
namestringOptional<=128 characters
overrideslist of objectsOptional
Catalog cost models. Replaces the whole list. Send an empty list to remove them all.
kindenumOptional

What the model produces. Open: new values may be added.

unitslist of objectsOptional
dimensionslist of objectsOptional
statusenumOptional
Allowed values:
metadatamap from strings to stringsOptional
Up to 50 keys of your own, with keys up to 40 characters and values up to 500 characters.

Response

The cost model.
idstring
object"cost_model"
keystring
namestring
sourceenum

Where a cost model’s rates come from. catalog: the provider price catalog that Runledger maintains, with your overrides on top. custom: rate cards you enter yourself.

Allowed values:
providerstring
modelstring
statusenum
Allowed values:
unitslist of objects
dimensionslist of objects
livemodeboolean
created_atdatetime
catalog_modelstringOptional

For source: catalog. The catalog model this cost model follows (catm_...).

overrideslist of objectsOptional
Your overrides of the catalog rates. Always empty for a custom cost model.
kindenumOptional

What the model produces. Open: new values may be added.

active_rate_cardstringOptional

The rate card in force now (rc_...). Left out until one is active.

active_rate_card_versionintegerOptional
metadatamap from strings to stringsOptional
Up to 50 keys of your own, with keys up to 40 characters and values up to 500 characters.
actorobjectOptional

Who made a change. Runledger fills it in from the credential, so a client can’t claim to be someone else: an API key always acts as itself, the dashboard calls the API as the signed-in person, and the MCP server passes the client’s name and the person it acts for. A request that sends a Runledger-Actor header is refused with 400 parameter_unknown.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error