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 |
/autonomy-policies |
listAutonomyPolicies |
POST |
/autonomy-policies |
createAutonomyPolicies |
GET |
/autonomy-policies/{id} |
getAutonomyPolicies |
PATCH |
/autonomy-policies/{id} |
supersedeAutonomyPolicies |
GET |
/policy-intent-drafts |
listPolicyIntentDrafts |
POST |
/policy-intent-drafts |
createPolicyIntentDrafts |
GET |
/policy-intent-drafts/{id} |
getPolicyIntentDrafts |
POST |
/policy-intent-drafts/{id}/compile |
compilePolicyIntent |
POST |
/policy-intent-drafts/structured |
createStructuredPolicyIntentDraft |
POST |
/policy-checks |
checkAutonomyPolicy |
List autonomy policies#
GET /autonomy-policies
Operation ID: listAutonomyPolicies
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 | AutonomyPolicy | — |
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 or expand autonomy using server-reconciled exact v2 Safe-envelope evidence#
POST /autonomy-policies
Operation ID: createAutonomyPolicies
Authentication: __Host-klineo_session cookie (sessionCookie)
Conditional version precondition: A current policy already exists for payload.vaultId.
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 | No | string |
Pattern: ^"[^"\\ ]+"$ |
Request body#
Required: yes.
application/json
object — Additional properties rejected
| Field | Required at this level | Type | Description and constraints |
|---|---|---|---|
payload |
Yes | AutonomyPolicyInput | — |
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 |
Policy admitted with server-derived approval time and Safe transaction hash where authority expands | application/json: object |
400 |
Caller supplied derived Safe proof fields or policy validation failed | No response body declared |
401 |
Authority expansion requires recent interactive reauthentication | No response body declared |
409 |
Signed release or exact finalized/reconciled v2 Safe envelope is unavailable | No response body declared |
201 application/json body
object — Additional properties rejected
| Field | Required at this level | Type | Description and constraints |
|---|---|---|---|
data |
Yes | Exactly one of: All of: RecordEnvelope; object; object |
— |
data.oneOf[1].allOf[2].payload |
Yes | AutonomyPolicy | — |
data.oneOf[2].policy |
Yes | All of: RecordEnvelope; object |
— |
data.oneOf[2].policy.allOf[2].payload |
Yes | AutonomyPolicy | — |
data.oneOf[2].safeAuthorityEvidence |
Yes | OperatingSystemEvent | — |
Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.
Get one autonomy policies aggregate#
GET /autonomy-policies/{id}
Operation ID: getAutonomyPolicies
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 | AutonomyPolicy | — |
Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.
Immediately pause, revoke, or narrow policy authority; expansion uses the typed Safe workflow#
PATCH /autonomy-policies/{id}
Operation ID: supersedeAutonomyPolicies
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 | AutonomyPolicy | — |
status |
No | string |
Allowed: ACTIVE, 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 | All of: RecordEnvelope; object |
— |
data.allOf[2].payload |
Yes | AutonomyPolicy | — |
Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.
List natural-language policy drafts#
GET /policy-intent-drafts
Operation ID: listPolicyIntentDrafts
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 | PolicyIntentDraft | — |
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 natural-language policy drafts#
POST /policy-intent-drafts
Operation ID: createPolicyIntentDrafts
Authentication: __Host-klineo_session cookie (sessionCookie) OR OAuth bearer token with policies:compile (serviceCredential)
Service scope: policies:compile. 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
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 | PolicyDraftResult | — |
Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.
Get one natural-language policy drafts aggregate#
GET /policy-intent-drafts/{id}
Operation ID: getPolicyIntentDrafts
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 | PolicyIntentDraft | — |
Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.
Deterministically compile a non-executable policy draft#
POST /policy-intent-drafts/{id}/compile
Operation ID: compilePolicyIntent
Authentication: __Host-klineo_session cookie (sessionCookie) OR OAuth bearer token with policies:compile (serviceCredential)
Service scope: policies:compile. 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
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 |
Exact deterministic interpretation | application/json: object |
200 application/json body
object — Additional properties rejected
| Field | Required at this level | Type | Description and constraints |
|---|---|---|---|
data |
Yes | PolicyCompilationResult | — |
Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.
Create a deterministic typed policy draft without an AI provider#
POST /policy-intent-drafts/structured
Operation ID: createStructuredPolicyIntentDraft
Authentication: __Host-klineo_session cookie (sessionCookie) OR OAuth bearer token with policies:compile (serviceCredential)
Service scope: policies:compile. 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
Responses#
| Status | Description | Content type and schema |
|---|---|---|
201 |
Manual structured draft and exact compilation preview | application/json: object |
201 application/json body
object — Additional properties rejected
| Field | Required at this level | Type | Description and constraints |
|---|---|---|---|
data |
Yes | PolicyDraftResult | — |
Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.
Validate a manually structured policy and persist non-executable evidence#
POST /policy-checks
Operation ID: checkAutonomyPolicy
Authentication: __Host-klineo_session cookie (sessionCookie) OR OAuth bearer token with policies:check (serviceCredential)
Service scope: policies:check. 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
Responses#
| Status | Description | Content type and schema |
|---|---|---|
201 |
Deterministic policy check and immutable evidence | application/json: object |
201 application/json body
object — Additional properties rejected
| Field | Required at this level | Type | Description and constraints |
|---|---|---|---|
data |
Yes | PolicyCheckResult | — |
Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.