Chrono

GET/api/v1/chrono/analytics/{resource_id}

Resource_analytics

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

resource_id*string

Query Parameters

window?string

Window expression such as 7d, 24h (informational; analytics are computed live).

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/chrono/analytics/string"

{  "active_states": 0,  "at_cap": 0,  "at_zero": 0,  "average_value": 0.1,  "resource_id": "string",  "window": "string"}

GET/api/v1/chrono/definitions

List_definitions

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Query Parameters

page?integer

1-indexed page number.

Formatint64

Range0 <= value

page_size?integer

Page size.

Formatint64

Range0 <= value

sort_order?string

Sort order by created_at (asc or desc).

Value in

"asc"
"desc"

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/chrono/definitions"

{  "definitions": [    {      "cap": 0.1,      "composition": "multiplicative",      "created_at": 0,      "curve": {        "rate_per_second": 0.1,        "round": "floor",        "type": "linear"      },      "description": "string",      "id": "string",      "initial_value": 0.1,      "name": "string",      "offers": [        {          "effect": {            "cap_extension": 0,            "duration_seconds": 0,            "permanent": true,            "refill": "string",            "regen_multiplier": 0          },          "id": "string",          "price": {            "amount": 0.1,            "currency": "string"          }        }      ],      "overflow": {        "bank_cap": 0.1,        "convert_rate": 0,        "drain_order": "value_first",        "mode": "discard"      },      "reset": {        "at_local_time": "string",        "fallback_offset_minutes": 0,        "reset_to": "cap",        "schedule": "none"      },      "tags": [        "string"      ],      "updated_at": 0,      "version": 0    }  ],  "pagination": {    "has_more": true,    "page": 0,    "page_size": 0,    "total": 0  }}

POST/api/v1/chrono/definitions

Create_definition

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Create a new resource definition (admin only).

cap*number

Maximum active value.

Formatdouble

composition?null|

curve*|||||

Regeneration curve.

description?|

Optional description.

id*string

Stable identifier for the definition (e.g. res_energy).

initial_value*number

Value assigned when a user's state is first created.

Formatdouble

name*string

Human-facing name.

offers?array<>

Purchasable refill/boost offers.

overflow?null|

reset?null|

tags?array<string>

Free-form tags.

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/chrono/definitions" \  -H "Content-Type: application/json" \  -d '{    "cap": 0.1,    "curve": {      "rate_per_second": 0.1,      "type": "linear"    },    "id": "string",    "initial_value": 0.1,    "name": "string"  }'

{  "cap": 0.1,  "composition": "multiplicative",  "created_at": 0,  "curve": {    "rate_per_second": 0.1,    "round": "floor",    "type": "linear"  },  "description": "string",  "id": "string",  "initial_value": 0.1,  "name": "string",  "offers": [    {      "effect": {        "cap_extension": 0,        "duration_seconds": 0,        "permanent": true,        "refill": "string",        "regen_multiplier": 0      },      "id": "string",      "price": {        "amount": 0.1,        "currency": "string"      }    }  ],  "overflow": {    "bank_cap": 0.1,    "convert_rate": 0,    "drain_order": "value_first",    "mode": "discard"  },  "reset": {    "at_local_time": "string",    "fallback_offset_minutes": 0,    "reset_to": "cap",    "schedule": "none"  },  "tags": [    "string"  ],  "updated_at": 0,  "version": 0}

GET/api/v1/chrono/definitions/{resource_id}

Get_definition

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

resource_id*string

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/chrono/definitions/string"

{  "cap": 0.1,  "composition": "multiplicative",  "created_at": 0,  "curve": {    "rate_per_second": 0.1,    "round": "floor",    "type": "linear"  },  "description": "string",  "id": "string",  "initial_value": 0.1,  "name": "string",  "offers": [    {      "effect": {        "cap_extension": 0,        "duration_seconds": 0,        "permanent": true,        "refill": "string",        "regen_multiplier": 0      },      "id": "string",      "price": {        "amount": 0.1,        "currency": "string"      }    }  ],  "overflow": {    "bank_cap": 0.1,    "convert_rate": 0,    "drain_order": "value_first",    "mode": "discard"  },  "reset": {    "at_local_time": "string",    "fallback_offset_minutes": 0,    "reset_to": "cap",    "schedule": "none"  },  "tags": [    "string"  ],  "updated_at": 0,  "version": 0}

DELETE/api/v1/chrono/definitions/{resource_id}

Delete_definition

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

resource_id*string

Response Body

`application/json`

curl -X DELETE "https://example.com/api/v1/chrono/definitions/string"

{  "message": "string",  "resource_id": "string"}

PUT/api/v1/chrono/definitions/{resource_id}

Update_definition

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

resource_id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Update an existing resource definition (admin only). Bumps the version.

cap?|

New cap.

Formatdouble

composition?null|

curve?null||||||

description?|

New description.

initial_value?|

New initial value.

Formatdouble

name?|

New name.

offers?array<>|

New offers.

overflow?null|

reset?null|

tags?array<string>|

New tags.

Response Body

`application/json`

curl -X PUT "https://example.com/api/v1/chrono/definitions/string" \  -H "Content-Type: application/json" \  -d '{}'

{  "cap": 0.1,  "composition": "multiplicative",  "created_at": 0,  "curve": {    "rate_per_second": 0.1,    "round": "floor",    "type": "linear"  },  "description": "string",  "id": "string",  "initial_value": 0.1,  "name": "string",  "offers": [    {      "effect": {        "cap_extension": 0,        "duration_seconds": 0,        "permanent": true,        "refill": "string",        "regen_multiplier": 0      },      "id": "string",      "price": {        "amount": 0.1,        "currency": "string"      }    }  ],  "overflow": {    "bank_cap": 0.1,    "convert_rate": 0,    "drain_order": "value_first",    "mode": "discard"  },  "reset": {    "at_local_time": "string",    "fallback_offset_minutes": 0,    "reset_to": "cap",    "schedule": "none"  },  "tags": [    "string"  ],  "updated_at": 0,  "version": 0}

POST/api/v1/chrono/definitions/{resource_id}/simulate

Simulate_definition

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

resource_id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Simulate a definition against a synthetic timeline (no user state touched).

events*array<>

Timeline of synthetic events.

initial_value?|

Optional starting value override (defaults to the definition's initial_value).

Formatdouble

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/chrono/definitions/string/simulate" \  -H "Content-Type: application/json" \  -d '{    "events": [      {        "at": 0      }    ]  }'

{  "resource_id": "string",  "trace": [    {      "at": 0,      "bank_value": 0.1,      "event": "string",      "value": 0.1    }  ]}

GET/api/v1/chrono/me/resources

List_my_resources

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/chrono/me/resources"

{  "states": [    {      "bank_value": 0.1,      "cap_extension": 0.1,      "converted_total": 0.1,      "created_at": "2019-08-24T14:15:22Z",      "definition_version": 0,      "id": "string",      "last_reset_at": 0,      "last_timestamp": 0,      "last_value": 0.1,      "modifiers": [        {          "expires_at": 0,          "factor": 0.1,          "id": "string",          "kind": "regen_multiplier",          "source": "string"        }      ],      "resource_id": "string",      "updated_at": "2019-08-24T14:15:22Z",      "user_id": "string"    }  ],  "user_id": "string"}

GET/api/v1/chrono/resources/{resource_id}

Read_resource

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

resource_id*string

Query Parameters

tz_offset_minutes?integer

Caller's UTC offset in minutes for timezone-anchored resets. Falls back to the definition's fallback_offset_minutes when absent.

Formatint32

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/chrono/resources/string"

{  "bank_value": 0.1,  "cap": 0.1,  "converted_total": 0.1,  "modifiers": [    {      "expires_at": 0,      "factor": 0.1,      "id": "string",      "kind": "regen_multiplier",      "source": "string"    }  ],  "resource_id": "string",  "seconds_to_full": 0,  "seconds_to_next_unit": 0,  "value": 0.1}

POST/api/v1/chrono/resources/{resource_id}/materialize

Materialize_resource

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

resource_id*string

Query Parameters

tz_offset_minutes?integer

Caller's UTC offset in minutes for timezone-anchored resets. Falls back to the definition's fallback_offset_minutes when absent.

Formatint32

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/chrono/resources/string/materialize"

{  "accrued_after_diminishing": 0.1,  "accrued_raw": 0.1,  "away_seconds": 0,  "banked_overflow": 0.1,  "clipped_by_cap": 0.1,  "converted_overflow": 0.1,  "final_value": 0.1,  "modifiers_applied": [    "string"  ],  "resource_id": "string"}

POST/api/v1/chrono/resources/{resource_id}/modifiers

Attach_modifier

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

resource_id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Attach a modifier to the caller's resource state.

duration_seconds*integer

Lifetime in seconds; the modifier expires this many seconds from now.

Formatint64

factor*number

Multiplier or magnitude (e.g. 2.0 for 2x regen, or units of cap extension).

Formatdouble

kind*ModifierKind

Kind of modifier.

Value in

"regen_multiplier"
"cap_extension"
"idle_boost"

source*string

Audit source for the modifier.

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/chrono/resources/string/modifiers" \  -H "Content-Type: application/json" \  -d '{    "duration_seconds": 0,    "factor": 0.1,    "kind": "regen_multiplier",    "source": "string"  }'

{  "modifier": {    "expires_at": 0,    "factor": 0.1,    "id": "string",    "kind": "regen_multiplier",    "source": "string"  },  "resource_id": "string"}

DELETE/api/v1/chrono/resources/{resource_id}/modifiers/{modifier_id}

Remove_modifier

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

resource_id*string

modifier_id*string

Response Body

`application/json`

curl -X DELETE "https://example.com/api/v1/chrono/resources/string/modifiers/string"

{  "message": "string",  "modifier_id": "string",  "resource_id": "string"}

POST/api/v1/chrono/resources/{resource_id}/refill

Refill_resource

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

resource_id*string

Query Parameters

tz_offset_minutes?integer

Caller's UTC offset in minutes for timezone-anchored resets. Falls back to the definition's fallback_offset_minutes when absent.

Formatint32

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Grant or restore value on the caller's resource.

allow_overflow?boolean

Whether the grant may exceed the cap (routed to the overflow bank).

amount*number

Amount to grant.

Formatdouble

idempotency_key?|

Optional idempotency key.

source*string

Audit source for the grant (e.g. treasury:txn_99a1, admin_grant).

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/chrono/resources/string/refill" \  -H "Content-Type: application/json" \  -d '{    "amount": 0.1,    "source": "string"  }'

{  "bank_value": 0.1,  "granted": 0.1,  "resource_id": "string",  "value": 0.1}

POST/api/v1/chrono/resources/{resource_id}/refill/purchase

Purchase_offer

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

resource_id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Purchase a paid refill/boost offer; settles through Treasury.

offer_id*string

Identifier of the offer declared on the definition.

treasury_txn*string

Reference to the settled Treasury transaction backing the purchase.

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/chrono/resources/string/refill/purchase" \  -H "Content-Type: application/json" \  -d '{    "offer_id": "string",    "treasury_txn": "string"  }'

{  "bank_value": 0.1,  "cap_extension": 0.1,  "offer_id": "string",  "resource_id": "string",  "treasury_txn": "string",  "value": 0.1}

POST/api/v1/chrono/resources/{resource_id}/spend

Spend_resource

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

resource_id*string

Query Parameters

tz_offset_minutes?integer

Caller's UTC offset in minutes for timezone-anchored resets. Falls back to the definition's fallback_offset_minutes when absent.

Formatint32

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Atomic check-and-debit against the caller's resource.

amount*number

Amount to spend.

Formatdouble

idempotency_key?|

Optional idempotency key to make the spend safe to retry.

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/chrono/resources/string/spend" \  -H "Content-Type: application/json" \  -d '{    "amount": 0.1  }'

{  "bank_value": 0.1,  "resource_id": "string",  "spent": 0.1,  "value": 0.1}

GET/api/v1/chrono/users/{user_id}/resources

List_user_resources

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

user_id*string

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/chrono/users/string/resources"

{  "states": [    {      "bank_value": 0.1,      "cap_extension": 0.1,      "converted_total": 0.1,      "created_at": "2019-08-24T14:15:22Z",      "definition_version": 0,      "id": "string",      "last_reset_at": 0,      "last_timestamp": 0,      "last_value": 0.1,      "modifiers": [        {          "expires_at": 0,          "factor": 0.1,          "id": "string",          "kind": "regen_multiplier",          "source": "string"        }      ],      "resource_id": "string",      "updated_at": "2019-08-24T14:15:22Z",      "user_id": "string"    }  ],  "user_id": "string"}

Chrono

200application/json

403

404

200application/json

201application/json

400

403

409

200application/json

404

200application/json

403

404

200application/json

400

403

404

200application/json

400

404

200application/json

200application/json

404

200application/json

404

201application/json

400

404

200application/json

404

200application/json

400

404

200application/json

400

404

200application/json

400

404

409

200application/json

403

On this page

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`