Issuer intents, launches and unlocks

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`	`/intents`	listIntents
`POST`	`/intents`	createIntents
`GET`	`/intents/{id}`	getIntents
`PATCH`	`/intents/{id}`	supersedeIntents
`GET`	`/launch-plans`	listLaunchPlans
`POST`	`/launch-plans`	createLaunchPlans
`GET`	`/launch-plans/{id}`	getLaunchPlans
`GET`	`/unlock-impacts`	listUnlockImpacts
`POST`	`/unlock-impacts`	createUnlockImpacts
`GET`	`/unlock-impacts/{id}`	getUnlockImpacts
`POST`	`/launch-plans/{id}/timeline-events`	appendLaunchTimelineEvent
`GET`	`/launch-plans/{id}/timeline`	getLaunchTimeline
`POST`	`/launch-plans/{id}/timeline-events/{eventId}/complete`	completeLaunchTimelineEvent
`POST`	`/launch-plans/{id}/seed-workspace`	seedLaunchWorkspace

List issuer intents#

GET /intents

Operation ID: listIntents

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	IssuerIntent	—
`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 issuer intents#

POST /intents

Operation ID: createIntents

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	IssuerIntent	—
`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.intent`	Yes	All of: RecordEnvelope; `object`	—
`data.intent.allOf[2].payload`	Yes	IssuerIntent	—
`data.capitalRequirement`	Yes	All of: RecordEnvelope; `object`	—
`data.capitalRequirement.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 issuer intents aggregate#

GET /intents/{id}

Operation ID: getIntents

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	IssuerIntent	—

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

Supersede an intent and recompute immutable deterministic capital evidence#

PATCH /intents/{id}

Operation ID: supersedeIntents

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	IssuerIntent	—
`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.intent`	Yes	All of: RecordEnvelope; `object`	—
`data.intent.allOf[2].payload`	Yes	IssuerIntent	—
`data.capitalRequirement`	Yes	All of: RecordEnvelope; `object`	—
`data.capitalRequirement.allOf[2].payload`	Yes	CapitalRequirementStudy	—
`data.validationEvidence`	Yes	OperatingSystemEvent	—

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

List launch plans#

GET /launch-plans

Operation ID: listLaunchPlans

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	LaunchPlan	—
`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 launch plans#

POST /launch-plans

Operation ID: createLaunchPlans

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

LaunchPlanRequest

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	LaunchPlan	—

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

Get one launch plans aggregate#

GET /launch-plans/{id}

Operation ID: getLaunchPlans

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	LaunchPlan	—

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

List unlock impact studies#

GET /unlock-impacts

Operation ID: listUnlockImpacts

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	UnlockImpact	—
`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 a correlation-aware unlock study and queue four explicit downstream materializations#

POST /unlock-impacts

Operation ID: createUnlockImpacts

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

UnlockImpactRequest

Responses#

Status	Description	Content type and schema
`201`	Immutable unlock impact with p5/p50/p95 ranges, lineage events, and fenced jobs	`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.id`	Yes	`string`	—
`data.organizationId`	Yes	`string`	—
`data.recordType`	Yes	OperatingSystemRecordType	—
`data.version`	Yes	`integer`	Minimum: `1`
`data.status`	Yes	OperatingSystemRecordStatus	—
`data.payload`	Yes	UnlockImpact	—
`data.artifactHash`	Yes	Hash	—
`data.evidenceHashes`	Yes	Array of Hash	—
`data.createdBy`	Yes	`string`	—
`data.reason`	Yes	`string`	—
`data.requestId`	Yes	`string`	—
`data.createdAt`	Yes	`string`	Format: `date-time`
`data.updatedAt`	Yes	`string`	Format: `date-time`
`data.supersedesVersion`	No	`integer`	Minimum: `1`
`data.resourceVersion`	Yes	Hash	—
`data.downstream`	Yes	`object`	Additional properties rejected
`data.downstream.events`	Yes	Array of OperatingSystemEvent	—
`data.downstream.jobs`	Yes	Array of OperatingSystemJob	—

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

Get one unlock impact studies aggregate#

GET /unlock-impacts/{id}

Operation ID: getUnlockImpacts

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	UnlockImpact	—

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

Append a PLANNED dependency-aware event; completion is available only through the approval route#

POST /launch-plans/{id}/timeline-events

Operation ID: appendLaunchTimelineEvent

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

TimelineEventRequest

Responses#

Status	Description	Content type and schema
`201`	Planned timeline event appended	`application/json`: `object`
`400`	Caller attempted to inject completion or another lifecycle state	No response body declared

201 application/json body

object — Additional properties rejected

Field	Required at this level	Type	Description and constraints
`data`	Yes	OperatingSystemEvent	—

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

Materialize dependency and completion state from immutable events#

GET /launch-plans/{id}/timeline

Operation ID: getLaunchTimeline

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`	Materialized launch timeline	`application/json`: `object`

200 application/json body

object — Additional properties rejected

Field	Required at this level	Type	Description and constraints
`data`	Yes	LaunchTimeline	—

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

Bind a completion receipt after every dependency completes#

POST /launch-plans/{id}/timeline-events/{eventId}/complete

Operation ID: completeLaunchTimelineEvent

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`	—
`eventId`	path	Yes	`string`	—
`If-Match`	header	Yes	`string`	Pattern: `^"[^"\\ ]+"$`

Request body#

Required: yes.

application/json

TimelineCompletionRequest

Responses#

Status	Description	Content type and schema
`200`	Completion receipt event	`application/json`: `object`
`409`	Dependencies incomplete	No response body declared

200 application/json body

object — Additional properties rejected

Field	Required at this level	Type	Description and constraints
`data`	Yes	OperatingSystemEvent	—

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

Seed drafts, studies, policy, qualification, and a funding proposal without execution#

POST /launch-plans/{id}/seed-workspace

Operation ID: seedLaunchWorkspace

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

LaunchWorkspaceSeedRequest

Responses#

Status	Description	Content type and schema
`201`	Immutable seeded workspace	`application/json`: `object`

201 application/json body

object — Additional properties rejected

Field	Required at this level	Type	Description and constraints
`data`	Yes	LaunchWorkspaceSeed	—

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.