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 |
/strategies |
listStrategies |
POST |
/strategies |
createStrategies |
GET |
/strategies/{id} |
getStrategies |
PATCH |
/strategies/{id} |
supersedeStrategies |
GET |
/strategy-packages |
listStrategyPackages |
POST |
/strategy-packages |
createStrategyPackageCandidate |
GET |
/strategy-packages/{id} |
getStrategyPackages |
POST |
/strategies/legacy-wrappers |
wrapLegacyStrategyDefinition |
POST |
/strategies/{id}/proposal-admissions |
admitStrategyProposal |
GET |
/strategies/{id}/evidence |
getStrategyEvidence |
POST |
/strategy-packages/{id}/approve |
approveStrategyPackage |
POST |
/strategy-packages/{id}/seed-strategy |
seedStrategyFromApprovedPackage |
POST |
/strategy-packages/{id}/revoke |
revokeStrategyPackage |
List strategy definitions#
GET /strategies
Operation ID: listStrategies
Authentication: __Host-klineo_session cookie (sessionCookie) OR OAuth bearer token with strategies:validate (serviceCredential)
Service scope: strategies:validate. Session access and workspace roles are evaluated separately.
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 | StrategyDefinitionV2 | — |
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 strategy definitions#
POST /strategies
Operation ID: createStrategies
Authentication: __Host-klineo_session cookie (sessionCookie) OR OAuth bearer token with strategies:validate (serviceCredential)
Service scope: strategies:validate. Session access and workspace roles are evaluated separately.
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 | StrategyDefinitionV2Input | — |
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 |
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 | object |
Additional properties rejected |
data.strategy |
Yes | All of: RecordEnvelope; object |
— |
data.strategy.allOf[2].payload |
Yes | StrategyDefinitionV2 | — |
data.compilation |
Yes | StrategyCompilation | — |
Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.
Get one strategy definitions aggregate#
GET /strategies/{id}
Operation ID: getStrategies
Authentication: __Host-klineo_session cookie (sessionCookie) OR OAuth bearer token with strategies:validate (serviceCredential)
Service scope: strategies:validate. Session access and workspace roles are evaluated separately.
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 | StrategyDefinitionV2 | — |
Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.
Supersede a declarative strategy only after deterministic compilation#
PATCH /strategies/{id}
Operation ID: supersedeStrategies
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 |
|---|---|---|---|
payload |
No | StrategyDefinitionV2Input | — |
status |
No | string |
Allowed: DRAFT, VALIDATED, PAUSED, 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 | object |
Additional properties rejected |
data.strategy |
Yes | All of: RecordEnvelope; object |
— |
data.strategy.allOf[2].payload |
Yes | StrategyDefinitionV2 | — |
data.compilation |
Yes | StrategyCompilation | — |
data.compilationEvidence |
Yes | OperatingSystemEvent | — |
Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.
List curated strategy packages#
GET /strategy-packages
Operation ID: listStrategyPackages
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 | StrategyPackage | — |
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 an immutable declarative candidate restricted to Digital Twin use#
POST /strategy-packages
Operation ID: createStrategyPackageCandidate
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 | StrategyPackageCandidate | — |
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 |
Candidate with server-derived package content hash and no network, signing, or activation surface | 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 | StrategyPackage | — |
Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.
Get one curated strategy packages aggregate#
GET /strategy-packages/{id}
Operation ID: getStrategyPackages
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 | StrategyPackage | — |
Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.
Wrap immutable v1 Bootstrap, Maintain, or Diversify evidence in the declarative v2 schema#
POST /strategies/legacy-wrappers
Operation ID: wrapLegacyStrategyDefinition
Authentication: __Host-klineo_session cookie (sessionCookie) OR OAuth bearer token with strategies:validate (serviceCredential)
Service scope: strategies:validate. Session access and workspace roles are evaluated separately.
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 |
|---|---|---|---|
simulationId |
Yes | string |
Min length: 3; Max length: 160 |
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 |
Validated compatibility definition without rewriting history | application/json: object |
201 application/json body
object — Additional properties rejected
| Field | Required at this level | Type | Description and constraints |
|---|---|---|---|
data |
Yes | object |
Additional properties rejected |
data.strategy |
Yes | All of: RecordEnvelope; object |
— |
data.strategy.allOf[2].payload |
Yes | StrategyDefinitionV2 | — |
data.compilation |
Yes | StrategyCompilation | — |
data.sourceArtifactHash |
Yes | Hash | — |
data.proposalAuthorityGranted |
Yes | Constant false |
— |
Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.
Derive all eight proposal-admission checks from immutable server-side evidence#
POST /strategies/{id}/proposal-admissions
Operation ID: admitStrategyProposal
Authentication: __Host-klineo_session cookie (sessionCookie) OR OAuth bearer token with strategies:validate (serviceCredential)
Service scope: strategies:validate. Session access and workspace roles are evaluated separately.
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
StrategyProposalAdmissionRequest
Responses#
| Status | Description | Content type and schema |
|---|---|---|
201 |
Signed oracle-bound admission event | application/json: object |
409 |
One or more checks 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 | object |
Additional properties rejected |
data.admission |
Yes | OperatingSystemEvent | — |
data.validation |
Yes | StrategyProposalAdmission | — |
data.proposalAuthorityGranted |
Yes | Constant false |
— |
Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.
Read exact strategy admission events and their immutable study generations#
GET /strategies/{id}/evidence
Operation ID: getStrategyEvidence
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 |
Read-only historical evidence; missing study generations remain null | application/json: object |
404 |
The exact strategy 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 strategy-evidence-view-v1 |
— |
data.strategy |
Yes | All of: RecordEnvelope; object |
— |
data.strategy.allOf[2].payload |
Yes | StrategyDefinitionV2 | — |
data.admissions |
Yes | Array of object |
— |
data.admissions[].event |
Yes | OperatingSystemEvent | — |
data.admissions[].study |
Yes | At least one of: All of: RecordEnvelope; object; null |
— |
data.admissions[].study.anyOf[1].allOf[2].payload |
Yes | SimulationStudy | — |
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.
Verify independent named reviews and a current signed strategy-registry generation#
POST /strategy-packages/{id}/approve
Operation ID: approveStrategyPackage
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
StrategyPackageApprovalRequest
Responses#
| Status | Description | Content type and schema |
|---|---|---|
200 |
Cryptographically approved package version | application/json: object |
400 |
Review, registry, scope, freshness, or signature evidence invalid | 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 | StrategyPackage | — |
Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.
Enter standard activation preparation only from a currently verifiable approved package#
POST /strategy-packages/{id}/seed-strategy
Operation ID: seedStrategyFromApprovedPackage
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 |
|---|---|---|
201 |
Validated strategy definition with package lineage and no execution authority | application/json: object |
409 |
Package is candidate, revoked, or no longer current | No response body declared |
201 application/json body
object — Additional properties rejected
| Field | Required at this level | Type | Description and constraints |
|---|---|---|---|
data |
Yes | object |
Additional properties rejected |
data.strategy |
Yes | All of: RecordEnvelope; object |
— |
data.strategy.allOf[2].payload |
Yes | StrategyDefinitionV2 | — |
data.sourcePackageId |
Yes | string |
Min length: 3; Max length: 160 |
data.sourcePackageVersion |
Yes | integer |
Minimum: 1 |
data.sourcePackageResourceVersion |
Yes | Hash | — |
data.sourcePackageArtifactHash |
Yes | Hash | — |
data.safetyEnvelopeHash |
Yes | Hash | — |
data.executionAuthorityGranted |
Yes | Constant false |
— |
data.standardProposalSimulationApprovalSafeFlowRequired |
Yes | Constant true |
— |
Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.
Immediately revoke activation eligibility while retaining evidence#
POST /strategy-packages/{id}/revoke
Operation ID: revokeStrategyPackage
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
object — Additional properties rejected
| Field | Required at this level | Type | Description and constraints |
|---|---|---|---|
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 revoked package version | application/json: object |
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 | StrategyPackage | — |
Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.