Paths on this page are relative to /api/liquidity-studio/v2. Authentication and required headers vary by operation.
API reference overview · OpenAPI download
Operations on this page#
| Method | Path | Operation |
|---|---|---|
GET |
/treasury-entries/{id}/versions |
listTreasuryLedgerEntryVersions |
GET |
/treasury-entries |
listTreasuryEntries |
POST |
/treasury-entries |
createTreasuryEntries |
GET |
/treasury-entries/{id} |
getTreasuryEntries |
GET |
/capital-requirements |
listCapitalRequirements |
POST |
/capital-requirements |
createCapitalRequirements |
GET |
/capital-requirements/{id} |
getCapitalRequirements |
GET |
/treasury-stress-tests |
listTreasuryStressTests |
POST |
/treasury-stress-tests |
createTreasuryStressTests |
GET |
/treasury-stress-tests/{id} |
getTreasuryStressTests |
POST |
/treasury-entries/{id}/refresh |
refreshTreasuryLedgerEntry |
POST |
/treasury-entries/{id}/retire |
retireTreasuryLedgerEntry |
POST |
/capital-requirements/{id}/seed-intent |
seedIssuerIntentFromCapitalStudy |
POST |
/capital-requirements/{id}/seed-launch-plan |
seedLaunchPlanFromCapitalStudy |
POST |
/capital-requirements/{id}/reservations |
reserveTreasuryFromCapitalStudy |
List immutable versions of a treasury ledger entry#
GET /treasury-entries/{id}/versions
Operation ID: listTreasuryLedgerEntryVersions
Authentication: __Host-klineo_session cookie (sessionCookie)
Requires current interactive session and workspace membership; service credentials are not accepted unless an explicit service scope is declared. Research and directory bookmarks grant no signing, custody or execution authority.
Parameters#
| Name | Location | Required | Type | Description and constraints |
|---|---|---|---|---|
x-klineo-organization-id |
header | Yes | string |
Min length: 1; Max length: 160 |
id |
path | Yes | string |
— |
cursor |
query | No | string |
Min length: 8; Max length: 256 |
limit |
query | No | integer |
Default: 100; Minimum: 1; Maximum: 100 |
Responses#
| Status | Description | Content type and schema |
|---|---|---|
200 |
List immutable versions of a treasury ledger entry | application/json: object |
default |
Invalid input, access denied, source/storage failure or deadline exceeded. Workspace authentication errors may use the shared API envelope; bounded route failures expose a message. Rate-limit responses may be plain text. | application/json: object |
200 response headers
| Header | Required | Type | Description and constraints |
|---|---|---|---|
Cache-Control |
Yes | Constant private, no-store |
— |
200 application/json body
object — Additional properties rejected
| Field | Required at this level | Type | Description and constraints |
|---|---|---|---|
data |
Yes | TreasuryLedgerVersionPage | — |
Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.
default application/json body
object — Additional properties rejected
| Field | Required at this level | Type | Description and constraints |
|---|---|---|---|
error |
Yes | ApiError | — |
Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.
List treasury ledger entries#
GET /treasury-entries
Operation ID: listTreasuryEntries
Authentication: __Host-klineo_session cookie (sessionCookie)
Parameters#
| Name | Location | Required | Type | Description and constraints |
|---|---|---|---|---|
x-klineo-organization-id |
header | Yes | string |
— |
cursor |
query | No | string |
Opaque cursor returned in the previous response metadata. |
limit |
query | No | integer |
Default: 50; Minimum: 1; Maximum: 100 |
Responses#
| Status | Description | Content type and schema |
|---|---|---|
200 |
Latest tenant-isolated aggregate versions | application/json: object |
200 application/json body
object — Additional properties rejected
| Field | Required at this level | Type | Description and constraints |
|---|---|---|---|
data |
Yes | Array of All of: RecordEnvelope; object |
— |
data[].allOf[2].payload |
Yes | TreasuryBucket | — |
meta |
Yes | object |
Additional properties rejected |
meta.count |
Yes | integer |
Minimum: 0 |
meta.hasMore |
Yes | boolean |
— |
meta.nextCursor |
No | string |
— |
Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.
Append a fresh signed oracle-bound economic capital container#
POST /treasury-entries
Operation ID: createTreasuryEntries
Authentication: __Host-klineo_session cookie (sessionCookie)
Parameters#
| Name | Location | Required | Type | Description and constraints |
|---|---|---|---|---|
Idempotency-Key |
header | Yes | string |
Min length: 8; Max length: 160 |
x-klineo-organization-id |
header | Yes | string |
— |
Request body#
Required: yes.
application/json
object — Additional properties rejected
| Field | Required at this level | Type | Description and constraints |
|---|---|---|---|
payload |
Yes | TreasuryBucket | — |
status |
No | OperatingSystemRecordStatus | — |
evidenceHashes |
No | Array of Hash | Max items: 256 |
reason |
Yes | string |
Min length: 3; Max length: 500 |
Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.
Responses#
| Status | Description | Content type and schema |
|---|---|---|
201 |
Reconciled ledger entry | application/json: object |
409 |
Stale oracle generation or duplicate observation/container/obligation | No response body declared |
201 application/json body
object — Additional properties rejected
| Field | Required at this level | Type | Description and constraints |
|---|---|---|---|
data |
Yes | All of: RecordEnvelope; object |
— |
data.allOf[2].payload |
Yes | TreasuryBucket | — |
Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.
Get one treasury ledger entries aggregate#
GET /treasury-entries/{id}
Operation ID: getTreasuryEntries
Authentication: __Host-klineo_session cookie (sessionCookie)
Parameters#
| Name | Location | Required | Type | Description and constraints |
|---|---|---|---|---|
x-klineo-organization-id |
header | Yes | string |
— |
id |
path | Yes | string |
— |
Responses#
| Status | Description | Content type and schema |
|---|---|---|
200 |
Current immutable aggregate version | application/json: object |
404 |
Not found | No response body declared |
200 response headers
| Header | Required | Type | Description and constraints |
|---|---|---|---|
ETag |
Yes | string |
— |
200 application/json body
object — Additional properties rejected
| Field | Required at this level | Type | Description and constraints |
|---|---|---|---|
data |
Yes | All of: RecordEnvelope; object |
— |
data.allOf[2].payload |
Yes | TreasuryBucket | — |
Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.
List capital requirement studies#
GET /capital-requirements
Operation ID: listCapitalRequirements
Authentication: __Host-klineo_session cookie (sessionCookie)
Parameters#
| Name | Location | Required | Type | Description and constraints |
|---|---|---|---|---|
x-klineo-organization-id |
header | Yes | string |
— |
cursor |
query | No | string |
Opaque cursor returned in the previous response metadata. |
limit |
query | No | integer |
Default: 50; Minimum: 1; Maximum: 100 |
Responses#
| Status | Description | Content type and schema |
|---|---|---|
200 |
Latest tenant-isolated aggregate versions | application/json: object |
200 application/json body
object — Additional properties rejected
| Field | Required at this level | Type | Description and constraints |
|---|---|---|---|
data |
Yes | Array of All of: RecordEnvelope; object |
— |
data[].allOf[2].payload |
Yes | CapitalRequirementStudy | — |
meta |
Yes | object |
Additional properties rejected |
meta.count |
Yes | integer |
Minimum: 0 |
meta.hasMore |
Yes | boolean |
— |
meta.nextCursor |
No | string |
— |
Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.
Create capital requirement studies#
POST /capital-requirements
Operation ID: createCapitalRequirements
Authentication: __Host-klineo_session cookie (sessionCookie)
Parameters#
| Name | Location | Required | Type | Description and constraints |
|---|---|---|---|---|
Idempotency-Key |
header | Yes | string |
Min length: 8; Max length: 160 |
x-klineo-organization-id |
header | Yes | string |
— |
Request body#
Required: yes.
application/json
Responses#
| Status | Description | Content type and schema |
|---|---|---|
201 |
Append-only aggregate created | application/json: object |
201 application/json body
object — Additional properties rejected
| Field | Required at this level | Type | Description and constraints |
|---|---|---|---|
data |
Yes | All of: RecordEnvelope; object |
— |
data.allOf[2].payload |
Yes | CapitalRequirementStudy | — |
Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.
Get one capital requirement studies aggregate#
GET /capital-requirements/{id}
Operation ID: getCapitalRequirements
Authentication: __Host-klineo_session cookie (sessionCookie)
Parameters#
| Name | Location | Required | Type | Description and constraints |
|---|---|---|---|---|
x-klineo-organization-id |
header | Yes | string |
— |
id |
path | Yes | string |
— |
Responses#
| Status | Description | Content type and schema |
|---|---|---|
200 |
Current immutable aggregate version | application/json: object |
404 |
Not found | No response body declared |
200 response headers
| Header | Required | Type | Description and constraints |
|---|---|---|---|
ETag |
Yes | string |
— |
200 application/json body
object — Additional properties rejected
| Field | Required at this level | Type | Description and constraints |
|---|---|---|---|
data |
Yes | All of: RecordEnvelope; object |
— |
data.allOf[2].payload |
Yes | CapitalRequirementStudy | — |
Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.
List treasury stress studies#
GET /treasury-stress-tests
Operation ID: listTreasuryStressTests
Authentication: __Host-klineo_session cookie (sessionCookie)
Parameters#
| Name | Location | Required | Type | Description and constraints |
|---|---|---|---|---|
x-klineo-organization-id |
header | Yes | string |
— |
cursor |
query | No | string |
Opaque cursor returned in the previous response metadata. |
limit |
query | No | integer |
Default: 50; Minimum: 1; Maximum: 100 |
Responses#
| Status | Description | Content type and schema |
|---|---|---|
200 |
Latest tenant-isolated aggregate versions | application/json: object |
200 application/json body
object — Additional properties rejected
| Field | Required at this level | Type | Description and constraints |
|---|---|---|---|
data |
Yes | Array of All of: RecordEnvelope; object |
— |
data[].allOf[2].payload |
Yes | TreasuryStressStudy | — |
meta |
Yes | object |
Additional properties rejected |
meta.count |
Yes | integer |
Minimum: 0 |
meta.hasMore |
Yes | boolean |
— |
meta.nextCursor |
No | string |
— |
Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.
Run all seven deterministic shocks using the server-side ledger, launch unlocks, and current policy#
POST /treasury-stress-tests
Operation ID: createTreasuryStressTests
Authentication: __Host-klineo_session cookie (sessionCookie)
Parameters#
| Name | Location | Required | Type | Description and constraints |
|---|---|---|---|---|
Idempotency-Key |
header | Yes | string |
Min length: 8; Max length: 160 |
x-klineo-organization-id |
header | Yes | string |
— |
Request body#
Required: yes.
application/json
Responses#
| Status | Description | Content type and schema |
|---|---|---|
201 |
Immutable seven-shock stress suite with policy-valid mitigations only | application/json: object |
409 |
Required reconciled server evidence unavailable | No response body declared |
201 application/json body
object — Additional properties rejected
| Field | Required at this level | Type | Description and constraints |
|---|---|---|---|
data |
Yes | All of: RecordEnvelope; object |
— |
data.allOf[2].payload |
Yes | TreasuryStressStudy | — |
Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.
Get one treasury stress studies aggregate#
GET /treasury-stress-tests/{id}
Operation ID: getTreasuryStressTests
Authentication: __Host-klineo_session cookie (sessionCookie)
Parameters#
| Name | Location | Required | Type | Description and constraints |
|---|---|---|---|---|
x-klineo-organization-id |
header | Yes | string |
— |
id |
path | Yes | string |
— |
Responses#
| Status | Description | Content type and schema |
|---|---|---|
200 |
Current immutable aggregate version | application/json: object |
404 |
Not found | No response body declared |
200 response headers
| Header | Required | Type | Description and constraints |
|---|---|---|---|
ETag |
Yes | string |
— |
200 application/json body
object — Additional properties rejected
| Field | Required at this level | Type | Description and constraints |
|---|---|---|---|
data |
Yes | All of: RecordEnvelope; object |
— |
data.allOf[2].payload |
Yes | TreasuryStressStudy | — |
Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.
Append a fresh signed observation for an existing immutable treasury container identity#
POST /treasury-entries/{id}/refresh
Operation ID: refreshTreasuryLedgerEntry
Authentication: __Host-klineo_session cookie (sessionCookie)
Parameters#
| Name | Location | Required | Type | Description and constraints |
|---|---|---|---|---|
Idempotency-Key |
header | Yes | string |
Min length: 8; Max length: 160 |
x-klineo-organization-id |
header | Yes | string |
— |
id |
path | Yes | string |
— |
If-Match |
header | Yes | string |
Pattern: ^"[^"\\ ]+"$ |
Request body#
Required: yes.
application/json
Responses#
| Status | Description | Content type and schema |
|---|---|---|
200 |
Refreshed active treasury-container generation | application/json: object |
400 |
Immutable identity changed or observation time regressed | No response body declared |
409 |
Container is inactive or signed evidence is stale, duplicate, or unavailable | No response body declared |
412 |
Strong precondition failed | No response body declared |
200 application/json body
object — Additional properties rejected
| Field | Required at this level | Type | Description and constraints |
|---|---|---|---|
data |
Yes | All of: RecordEnvelope; object |
— |
data.allOf[2].payload |
Yes | TreasuryBucket | — |
Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.
Append a revoked treasury-container generation with immutable retirement evidence#
POST /treasury-entries/{id}/retire
Operation ID: retireTreasuryLedgerEntry
Authentication: __Host-klineo_session cookie (sessionCookie)
Parameters#
| Name | Location | Required | Type | Description and constraints |
|---|---|---|---|---|
Idempotency-Key |
header | Yes | string |
Min length: 8; Max length: 160 |
x-klineo-organization-id |
header | Yes | string |
— |
id |
path | Yes | string |
— |
If-Match |
header | Yes | string |
Pattern: ^"[^"\\ ]+"$ |
Request body#
Required: yes.
application/json
TreasuryLedgerRetirementRequest
Responses#
| Status | Description | Content type and schema |
|---|---|---|
200 |
Retired treasury-container generation | application/json: object |
409 |
Container is not active | No response body declared |
412 |
Strong precondition failed | No response body declared |
200 application/json body
object — Additional properties rejected
| Field | Required at this level | Type | Description and constraints |
|---|---|---|---|
data |
Yes | All of: RecordEnvelope; object |
— |
data.allOf[2].payload |
Yes | TreasuryBucket | — |
Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.
Create or append an issuer-intent version from a completed reproducible capital study#
POST /capital-requirements/{id}/seed-intent
Operation ID: seedIssuerIntentFromCapitalStudy
Authentication: __Host-klineo_session cookie (sessionCookie)
Conditional version precondition: targetIssuerIntentId is supplied.
Parameters#
| Name | Location | Required | Type | Description and constraints |
|---|---|---|---|---|
Idempotency-Key |
header | Yes | string |
Min length: 8; Max length: 160 |
x-klineo-organization-id |
header | Yes | string |
— |
id |
path | Yes | string |
— |
If-Match |
header | No | string |
Pattern: ^"[^"\\ ]+"$ |
Request body#
Required: yes.
application/json
Responses#
| Status | Description | Content type and schema |
|---|---|---|
201 |
Validated intent evidence; no execution authority | application/json: object |
201 application/json body
object — Additional properties rejected
| Field | Required at this level | Type | Description and constraints |
|---|---|---|---|
data |
Yes | All of: RecordEnvelope; object |
— |
data.allOf[2].payload |
Yes | IssuerIntent | — |
Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.
Create or append a launch-plan draft using deterministic capital-study outputs#
POST /capital-requirements/{id}/seed-launch-plan
Operation ID: seedLaunchPlanFromCapitalStudy
Authentication: __Host-klineo_session cookie (sessionCookie)
Conditional version precondition: targetLaunchPlanId is supplied.
Parameters#
| Name | Location | Required | Type | Description and constraints |
|---|---|---|---|---|
Idempotency-Key |
header | Yes | string |
Min length: 8; Max length: 160 |
x-klineo-organization-id |
header | Yes | string |
— |
id |
path | Yes | string |
— |
If-Match |
header | No | string |
Pattern: ^"[^"\\ ]+"$ |
Request body#
Required: yes.
application/json
Responses#
| Status | Description | Content type and schema |
|---|---|---|
201 |
Draft launch plan; no activation or execution | application/json: object |
201 application/json body
object — Additional properties rejected
| Field | Required at this level | Type | Description and constraints |
|---|---|---|---|
data |
Yes | All of: RecordEnvelope; object |
— |
data.allOf[2].payload |
Yes | LaunchPlan | — |
Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.
Append a signed offchain treasury reservation without moving funds#
POST /capital-requirements/{id}/reservations
Operation ID: reserveTreasuryFromCapitalStudy
Authentication: __Host-klineo_session cookie (sessionCookie)
Parameters#
| Name | Location | Required | Type | Description and constraints |
|---|---|---|---|---|
Idempotency-Key |
header | Yes | string |
Min length: 8; Max length: 160 |
x-klineo-organization-id |
header | Yes | string |
— |
id |
path | Yes | string |
— |
Request body#
Required: yes.
application/json
Responses#
| Status | Description | Content type and schema |
|---|---|---|
201 |
Future-committed ledger container with signed oracle evidence | application/json: object |
409 |
Stale oracle generation or duplicate economic container | No response body declared |
201 application/json body
object — Additional properties rejected
| Field | Required at this level | Type | Description and constraints |
|---|---|---|---|
data |
Yes | All of: RecordEnvelope; object |
— |
data.allOf[2].payload |
Yes | TreasuryBucket | — |
Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.