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 |
/incentive-programs |
listIncentivePrograms |
POST |
/incentive-programs |
optimizeIncentiveProgram |
GET |
/incentive-programs/{id} |
getIncentivePrograms |
PATCH |
/incentive-programs/{id} |
supersedeIncentivePrograms |
GET |
/incentive-programs/{id}/evidence |
getIncentiveEvidence |
List incentive programs#
GET /incentive-programs
Operation ID: listIncentivePrograms
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 | IncentiveProgram | — |
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.
Measure an incentive program against frozen baseline evidence and prepare a non-executing review workflow#
POST /incentive-programs
Operation ID: optimizeIncentiveProgram
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 | IncentiveProgram | — |
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 |
Optimization plus operational-proposal or gated typed-adapter review evidence; no execution occurs | application/json: object |
400 |
Baseline, confidence, or adapter evidence failed closed | No response body declared |
201 application/json body
object — Additional properties rejected
| Field | Required at this level | Type | Description and constraints |
|---|---|---|---|
data |
Yes | IncentiveOptimizationResult | — |
Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.
Get one incentive programs aggregate#
GET /incentive-programs/{id}
Operation ID: getIncentivePrograms
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 | IncentiveProgram | — |
Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.
Revoke an incentive-program result without replacing its evidence#
PATCH /incentive-programs/{id}
Operation ID: supersedeIncentivePrograms
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 |
— |
If-Match |
header | Yes | string |
— |
id |
path | Yes | string |
— |
Request body#
Required: yes.
application/json
object — Additional properties rejected
| Field | Required at this level | Type | Description and constraints |
|---|---|---|---|
status |
No | string |
Allowed: REVOKED |
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 |
|---|---|---|
200 |
Append-only bounded supersession accepted with deterministic evidence | application/json: object |
400 |
Payload or safety transition is outside this bounded operation | No response body declared |
409 |
Typed authority workflow is required | 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 | IncentiveProgram | — |
Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.
Read optimization and preparation events bound to an exact incentive program generation#
GET /incentive-programs/{id}/evidence
Operation ID: getIncentiveEvidence
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 |
— |
resourceVersion |
query | Yes | string |
Pattern: ^0x[0-9a-fA-F]{64}$ |
Responses#
| Status | Description | Content type and schema |
|---|---|---|
200 |
Historical program evidence; unbound legacy events are counted without assigning them to a generation | application/json: object |
404 |
The exact incentive program generation is unavailable to this organization | No response body declared |
200 application/json body
object — Additional properties rejected
| Field | Required at this level | Type | Description and constraints |
|---|---|---|---|
data |
Yes | object |
Additional properties rejected |
data.schemaVersion |
Yes | Constant incentive-evidence-view-v1 |
— |
data.program |
Yes | All of: RecordEnvelope; object |
— |
data.program.allOf[2].payload |
Yes | IncentiveProgram | — |
data.events |
Yes | Array of OperatingSystemEvent | — |
data.unboundEventCount |
Yes | integer |
Minimum: 0 |
data.executionPerformed |
Yes | Constant false |
— |
data.executionAuthorityGranted |
Yes | Constant false |
— |
Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.