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 |
|---|---|---|
POST |
/public/projects/resolve |
resolvePublicProject |
POST |
/public/projects/investigate |
investigatePublicProjectLiquidity |
GET |
/projects |
listSavedProjects |
POST |
/projects |
savePublicProject |
GET |
/projects/{projectId} |
getSavedProject |
POST |
/projects/{projectId}/refresh |
refreshSavedProject |
GET |
/projects/{projectId}/observations |
listSavedProjectObservations |
GET |
/projects/{projectId}/observations/{version} |
getSavedProjectObservation |
Inspect a supported project using public market sources without a login, vault or payment#
POST /public/projects/resolve
Operation ID: resolvePublicProject
Authentication: No authentication is required by this operation’s contract.
Bounded public read with no private tenant lookup or issuer ownership assertion. A successful response may be partial and explicitly retains gaps. Observing a pool does not establish graduation, locked liquidity, issuer control or tradability. No saved investigation, entitlement, payment or financial authority is created.
This operation declares no parameters.
Request body#
Required: yes.
application/json
Responses#
| Status | Description | Content type and schema |
|---|---|---|
200 |
Public source observations with explicit limitations. | application/json: object |
400 |
Malformed JSON, invalid or unsupported identifier, or extra fields. | application/json: object |
413 |
Request exceeds the 2 KiB JSON body limit. | application/json: object |
429 |
Client rate or upstream concurrency limit exceeded. | application/json: object |
503 |
Public sources are unconfigured, unavailable, unverifiable or timed out. Raw provider errors are not disclosed. | application/json: object |
200 response headers
| Header | Required | Type | Description and constraints |
|---|---|---|---|
Cache-Control |
Yes | Constant no-store |
— |
200 application/json body
object — Additional properties rejected
| Field | Required at this level | Type | Description and constraints |
|---|---|---|---|
data |
Yes | PublicProjectAnalysis | — |
Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.
400 response headers
| Header | Required | Type | Description and constraints |
|---|---|---|---|
Cache-Control |
Yes | Constant no-store |
— |
400 application/json body
object — Additional properties rejected
| Field | Required at this level | Type | Description and constraints |
|---|---|---|---|
error |
Yes | object |
Additional properties rejected |
error.code |
Yes | string |
Allowed: PUBLIC_PROJECT_INVALID_INPUT |
error.message |
Yes | string |
— |
error.retryable |
Yes | Constant false |
— |
Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.
413 response headers
| Header | Required | Type | Description and constraints |
|---|---|---|---|
Cache-Control |
Yes | Constant no-store |
— |
413 application/json body
object — Additional properties rejected
| Field | Required at this level | Type | Description and constraints |
|---|---|---|---|
error |
Yes | object |
Additional properties rejected |
error.code |
Yes | string |
Allowed: PUBLIC_PROJECT_INVALID_INPUT |
error.message |
Yes | string |
— |
error.retryable |
Yes | Constant false |
— |
Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.
429 response headers
| Header | Required | Type | Description and constraints |
|---|---|---|---|
Cache-Control |
Yes | Constant no-store |
— |
Retry-After |
Yes | string |
Pattern: ^[0-9]+$ |
429 application/json body
object — Additional properties rejected
| Field | Required at this level | Type | Description and constraints |
|---|---|---|---|
error |
Yes | object |
Additional properties rejected |
error.code |
Yes | string |
Allowed: PUBLIC_PROJECT_BUSY |
error.message |
Yes | string |
— |
error.retryable |
Yes | Constant true |
— |
Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.
503 response headers
| Header | Required | Type | Description and constraints |
|---|---|---|---|
Cache-Control |
Yes | Constant no-store |
— |
503 application/json body
object — Additional properties rejected
| Field | Required at this level | Type | Description and constraints |
|---|---|---|---|
error |
Yes | object |
Additional properties rejected |
error.code |
Yes | string |
Allowed: PUBLIC_PROJECT_UNAVAILABLE, PUBLIC_PROJECT_TIMEOUT |
error.message |
Yes | string |
— |
error.retryable |
Yes | Constant true |
— |
Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.
Inspect one bounded public reserve-scale liquidity question without a login or payment#
POST /public/projects/investigate
Operation ID: investigatePublicProjectLiquidity
Authentication: No authentication is required by this operation’s contract.
Reads the same public project evidence as project resolution and returns a source-backed VIRTUAL pool reserve-scale finding. This is not a tradability claim, executable quote, slippage estimate, custody instruction, paid job, saved tenant investigation, or financial authority. An unavailable finding preserves the source and explains its evidence gap.
This operation declares no parameters.
Request body#
Required: yes.
application/json
PublicLiquidityInvestigationRequest
Responses#
| Status | Description | Content type and schema |
|---|---|---|
200 |
Public source evidence and bounded reserve-scale finding with explicit limitations. | application/json: object |
400 |
Malformed JSON, unsupported identifier or question, invalid quote size, or extra fields. | application/json: object |
413 |
Request exceeds the 2 KiB JSON body limit. | application/json: object |
429 |
Client rate or upstream concurrency limit exceeded. | application/json: object |
503 |
Public sources are unconfigured, unavailable, unverifiable or timed out. Raw provider errors are not disclosed. | application/json: object |
200 response headers
| Header | Required | Type | Description and constraints |
|---|---|---|---|
Cache-Control |
Yes | Constant no-store |
— |
200 application/json body
object — Additional properties rejected
| Field | Required at this level | Type | Description and constraints |
|---|---|---|---|
data |
Yes | PublicLiquidityInvestigation | — |
Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.
400 response headers
| Header | Required | Type | Description and constraints |
|---|---|---|---|
Cache-Control |
Yes | Constant no-store |
— |
400 application/json body
object — Additional properties rejected
| Field | Required at this level | Type | Description and constraints |
|---|---|---|---|
error |
Yes | object |
Additional properties rejected |
error.code |
Yes | string |
Allowed: PUBLIC_INVESTIGATION_INVALID_INPUT |
error.message |
Yes | string |
— |
error.retryable |
Yes | Constant false |
— |
Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.
413 response headers
| Header | Required | Type | Description and constraints |
|---|---|---|---|
Cache-Control |
Yes | Constant no-store |
— |
413 application/json body
object — Additional properties rejected
| Field | Required at this level | Type | Description and constraints |
|---|---|---|---|
error |
Yes | object |
Additional properties rejected |
error.code |
Yes | string |
Allowed: PUBLIC_INVESTIGATION_INVALID_INPUT |
error.message |
Yes | string |
— |
error.retryable |
Yes | Constant false |
— |
Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.
429 response headers
| Header | Required | Type | Description and constraints |
|---|---|---|---|
Cache-Control |
Yes | Constant no-store |
— |
Retry-After |
Yes | string |
Pattern: ^[0-9]+$ |
429 application/json body
object — Additional properties rejected
| Field | Required at this level | Type | Description and constraints |
|---|---|---|---|
error |
Yes | object |
Additional properties rejected |
error.code |
Yes | string |
Allowed: PUBLIC_INVESTIGATION_BUSY |
error.message |
Yes | string |
— |
error.retryable |
Yes | Constant true |
— |
Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.
503 response headers
| Header | Required | Type | Description and constraints |
|---|---|---|---|
Cache-Control |
Yes | Constant no-store |
— |
503 application/json body
object — Additional properties rejected
| Field | Required at this level | Type | Description and constraints |
|---|---|---|---|
error |
Yes | object |
Additional properties rejected |
error.code |
Yes | string |
Allowed: PUBLIC_INVESTIGATION_UNAVAILABLE, PUBLIC_INVESTIGATION_TIMEOUT |
error.message |
Yes | string |
— |
error.retryable |
Yes | Constant true |
— |
Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.
List saved public-project bookmarks in the current workspace#
GET /projects
Operation ID: listSavedProjects
Authentication: __Host-klineo_session cookie (sessionCookie)
Requires current interactive workspace membership. Developer service credentials are not accepted. A saved public-project bookmark grants no issuer ownership, treasury access, paid entitlement, financial permission or publication authority. Observations are immutable public snapshots; refreshing appends a new version without rewriting history.
Parameters#
| Name | Location | Required | Type | Description and constraints |
|---|---|---|---|---|
x-klineo-organization-id |
header | Yes | string |
— |
limit |
query | No | integer |
Default: 20; Minimum: 1; Maximum: 20 |
cursor |
query | No | string |
Continuation position returned by this collection. Current tenant authorization is rechecked independently on every request. Pattern: ^project_[0-9a-f]{32}$ |
Responses#
| Status | Description | Content type and schema |
|---|---|---|
200 |
Tenant-authorized saved public-project record. | application/json: object |
400 |
Invalid input or collection cursor. | application/json: object |
401 |
Interactive session required. | application/json: object |
403 |
Current workspace access or requested operation denied. | application/json: object |
404 |
Record unavailable in this workspace. | application/json: object |
429 |
Request or public-source quota exceeded. | application/json: object |
503 |
Saved project storage or public source unavailable. | 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 | SavedProjectList | — |
Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.
400 response headers
| Header | Required | Type | Description and constraints |
|---|---|---|---|
Cache-Control |
Yes | Constant private, no-store |
— |
400 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.
401 response headers
| Header | Required | Type | Description and constraints |
|---|---|---|---|
Cache-Control |
Yes | Constant private, no-store |
— |
401 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.
403 response headers
| Header | Required | Type | Description and constraints |
|---|---|---|---|
Cache-Control |
Yes | Constant private, no-store |
— |
403 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.
404 response headers
| Header | Required | Type | Description and constraints |
|---|---|---|---|
Cache-Control |
Yes | Constant private, no-store |
— |
404 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.
429 response headers
| Header | Required | Type | Description and constraints |
|---|---|---|---|
Cache-Control |
Yes | Constant private, no-store |
— |
429 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.
503 response headers
| Header | Required | Type | Description and constraints |
|---|---|---|---|
Cache-Control |
Yes | Constant private, no-store |
— |
503 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.
Save an independently resolved public-project observation#
POST /projects
Operation ID: savePublicProject
Authentication: __Host-klineo_session cookie (sessionCookie)
Requires current interactive workspace membership. Developer service credentials are not accepted. A saved public-project bookmark grants no issuer ownership, treasury access, paid entitlement, financial permission or publication authority. Observations are immutable public snapshots; refreshing appends a new version without rewriting history.
Parameters#
| Name | Location | Required | Type | Description and constraints |
|---|---|---|---|---|
x-klineo-organization-id |
header | Yes | string |
— |
Idempotency-Key |
header | Yes | string |
Min length: 8; Max length: 200 |
Request body#
Required: yes.
application/json
Responses#
| Status | Description | Content type and schema |
|---|---|---|
200 |
Tenant-authorized saved public-project record. | application/json: object |
400 |
Invalid input or collection cursor. | application/json: object |
401 |
Interactive session required. | application/json: object |
403 |
Current workspace access or requested operation denied. | application/json: object |
404 |
Record unavailable in this workspace. | application/json: object |
409 |
Idempotency identity conflicts or source binding changed. | application/json: object |
429 |
Request or public-source quota exceeded. | application/json: object |
503 |
Saved project storage or public source unavailable. | application/json: object |
200 response headers
| Header | Required | Type | Description and constraints |
|---|---|---|---|
Cache-Control |
Yes | Constant private, no-store |
— |
ETag |
Yes | string |
Pattern: ^"0x[0-9a-f]{64}"$ |
200 application/json body
object — Additional properties rejected
| Field | Required at this level | Type | Description and constraints |
|---|---|---|---|
data |
Yes | SavedProjectWriteReceipt | — |
Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.
400 response headers
| Header | Required | Type | Description and constraints |
|---|---|---|---|
Cache-Control |
Yes | Constant private, no-store |
— |
400 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.
401 response headers
| Header | Required | Type | Description and constraints |
|---|---|---|---|
Cache-Control |
Yes | Constant private, no-store |
— |
401 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.
403 response headers
| Header | Required | Type | Description and constraints |
|---|---|---|---|
Cache-Control |
Yes | Constant private, no-store |
— |
403 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.
404 response headers
| Header | Required | Type | Description and constraints |
|---|---|---|---|
Cache-Control |
Yes | Constant private, no-store |
— |
404 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.
409 response headers
| Header | Required | Type | Description and constraints |
|---|---|---|---|
Cache-Control |
Yes | Constant private, no-store |
— |
409 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.
429 response headers
| Header | Required | Type | Description and constraints |
|---|---|---|---|
Cache-Control |
Yes | Constant private, no-store |
— |
429 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.
503 response headers
| Header | Required | Type | Description and constraints |
|---|---|---|---|
Cache-Control |
Yes | Constant private, no-store |
— |
503 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.
Read a saved public-project bookmark and its latest observation#
GET /projects/{projectId}
Operation ID: getSavedProject
Authentication: __Host-klineo_session cookie (sessionCookie)
Requires current interactive workspace membership. Developer service credentials are not accepted. A saved public-project bookmark grants no issuer ownership, treasury access, paid entitlement, financial permission or publication authority. Observations are immutable public snapshots; refreshing appends a new version without rewriting history.
Parameters#
| Name | Location | Required | Type | Description and constraints |
|---|---|---|---|---|
x-klineo-organization-id |
header | Yes | string |
— |
projectId |
path | Yes | string |
Pattern: ^project_[0-9a-f]{32}$ |
Responses#
| Status | Description | Content type and schema |
|---|---|---|
200 |
Tenant-authorized saved public-project record. | application/json: object |
400 |
Invalid input or collection cursor. | application/json: object |
401 |
Interactive session required. | application/json: object |
403 |
Current workspace access or requested operation denied. | application/json: object |
404 |
Record unavailable in this workspace. | application/json: object |
429 |
Request or public-source quota exceeded. | application/json: object |
503 |
Saved project storage or public source unavailable. | application/json: object |
200 response headers
| Header | Required | Type | Description and constraints |
|---|---|---|---|
Cache-Control |
Yes | Constant private, no-store |
— |
ETag |
Yes | string |
Pattern: ^"0x[0-9a-f]{64}"$ |
200 application/json body
object — Additional properties rejected
| Field | Required at this level | Type | Description and constraints |
|---|---|---|---|
data |
Yes | SavedPublicProject | — |
Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.
400 response headers
| Header | Required | Type | Description and constraints |
|---|---|---|---|
Cache-Control |
Yes | Constant private, no-store |
— |
400 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.
401 response headers
| Header | Required | Type | Description and constraints |
|---|---|---|---|
Cache-Control |
Yes | Constant private, no-store |
— |
401 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.
403 response headers
| Header | Required | Type | Description and constraints |
|---|---|---|---|
Cache-Control |
Yes | Constant private, no-store |
— |
403 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.
404 response headers
| Header | Required | Type | Description and constraints |
|---|---|---|---|
Cache-Control |
Yes | Constant private, no-store |
— |
404 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.
429 response headers
| Header | Required | Type | Description and constraints |
|---|---|---|---|
Cache-Control |
Yes | Constant private, no-store |
— |
429 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.
503 response headers
| Header | Required | Type | Description and constraints |
|---|---|---|---|
Cache-Control |
Yes | Constant private, no-store |
— |
503 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.
Append a newly resolved public observation to the exact saved project version#
POST /projects/{projectId}/refresh
Operation ID: refreshSavedProject
Authentication: __Host-klineo_session cookie (sessionCookie)
Requires current interactive workspace membership. Developer service credentials are not accepted. A saved public-project bookmark grants no issuer ownership, treasury access, paid entitlement, financial permission or publication authority. Observations are immutable public snapshots; refreshing appends a new version without rewriting history.
Parameters#
| Name | Location | Required | Type | Description and constraints |
|---|---|---|---|---|
x-klineo-organization-id |
header | Yes | string |
— |
projectId |
path | Yes | string |
Pattern: ^project_[0-9a-f]{32}$ |
Idempotency-Key |
header | Yes | string |
Min length: 8; Max length: 200 |
If-Match |
header | Yes | string |
Pattern: ^"0x[0-9a-f]{64}"$ |
Request body#
Required: yes.
application/json
object — Max properties: 0; Additional properties rejected
Responses#
| Status | Description | Content type and schema |
|---|---|---|
200 |
Tenant-authorized saved public-project record. | application/json: object |
400 |
Invalid input or collection cursor. | application/json: object |
401 |
Interactive session required. | application/json: object |
403 |
Current workspace access or requested operation denied. | application/json: object |
404 |
Record unavailable in this workspace. | application/json: object |
409 |
Idempotency identity conflicts or source binding changed. | application/json: object |
412 |
Project version changed; review current evidence before a new refresh. | application/json: object |
428 |
Strong current project If-Match required. | application/json: object |
429 |
Request or public-source quota exceeded. | application/json: object |
503 |
Saved project storage or public source unavailable. | application/json: object |
200 response headers
| Header | Required | Type | Description and constraints |
|---|---|---|---|
Cache-Control |
Yes | Constant private, no-store |
— |
ETag |
Yes | string |
Pattern: ^"0x[0-9a-f]{64}"$ |
200 application/json body
object — Additional properties rejected
| Field | Required at this level | Type | Description and constraints |
|---|---|---|---|
data |
Yes | SavedProjectWriteReceipt | — |
Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.
400 response headers
| Header | Required | Type | Description and constraints |
|---|---|---|---|
Cache-Control |
Yes | Constant private, no-store |
— |
400 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.
401 response headers
| Header | Required | Type | Description and constraints |
|---|---|---|---|
Cache-Control |
Yes | Constant private, no-store |
— |
401 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.
403 response headers
| Header | Required | Type | Description and constraints |
|---|---|---|---|
Cache-Control |
Yes | Constant private, no-store |
— |
403 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.
404 response headers
| Header | Required | Type | Description and constraints |
|---|---|---|---|
Cache-Control |
Yes | Constant private, no-store |
— |
404 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.
409 response headers
| Header | Required | Type | Description and constraints |
|---|---|---|---|
Cache-Control |
Yes | Constant private, no-store |
— |
409 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.
412 response headers
| Header | Required | Type | Description and constraints |
|---|---|---|---|
Cache-Control |
Yes | Constant private, no-store |
— |
412 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.
428 response headers
| Header | Required | Type | Description and constraints |
|---|---|---|---|
Cache-Control |
Yes | Constant private, no-store |
— |
428 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.
429 response headers
| Header | Required | Type | Description and constraints |
|---|---|---|---|
Cache-Control |
Yes | Constant private, no-store |
— |
429 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.
503 response headers
| Header | Required | Type | Description and constraints |
|---|---|---|---|
Cache-Control |
Yes | Constant private, no-store |
— |
503 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 immutable observation metadata without changing captured evidence#
GET /projects/{projectId}/observations
Operation ID: listSavedProjectObservations
Authentication: __Host-klineo_session cookie (sessionCookie)
Requires current interactive workspace membership. Developer service credentials are not accepted. A saved public-project bookmark grants no issuer ownership, treasury access, paid entitlement, financial permission or publication authority. Observations are immutable public snapshots; refreshing appends a new version without rewriting history.
Parameters#
| Name | Location | Required | Type | Description and constraints |
|---|---|---|---|---|
x-klineo-organization-id |
header | Yes | string |
— |
projectId |
path | Yes | string |
Pattern: ^project_[0-9a-f]{32}$ |
limit |
query | No | integer |
Default: 20; Minimum: 1; Maximum: 20 |
cursor |
query | No | string |
Continuation position returned by this collection. Current tenant authorization is rechecked independently on every request. Pattern: ^[1-9][0-9]{0,17}$ |
Responses#
| Status | Description | Content type and schema |
|---|---|---|
200 |
Tenant-authorized saved public-project record. | application/json: object |
400 |
Invalid input or collection cursor. | application/json: object |
401 |
Interactive session required. | application/json: object |
403 |
Current workspace access or requested operation denied. | application/json: object |
404 |
Record unavailable in this workspace. | application/json: object |
429 |
Request or public-source quota exceeded. | application/json: object |
503 |
Saved project storage or public source unavailable. | 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 | SavedProjectObservationList | — |
Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.
400 response headers
| Header | Required | Type | Description and constraints |
|---|---|---|---|
Cache-Control |
Yes | Constant private, no-store |
— |
400 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.
401 response headers
| Header | Required | Type | Description and constraints |
|---|---|---|---|
Cache-Control |
Yes | Constant private, no-store |
— |
401 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.
403 response headers
| Header | Required | Type | Description and constraints |
|---|---|---|---|
Cache-Control |
Yes | Constant private, no-store |
— |
403 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.
404 response headers
| Header | Required | Type | Description and constraints |
|---|---|---|---|
Cache-Control |
Yes | Constant private, no-store |
— |
404 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.
429 response headers
| Header | Required | Type | Description and constraints |
|---|---|---|---|
Cache-Control |
Yes | Constant private, no-store |
— |
429 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.
503 response headers
| Header | Required | Type | Description and constraints |
|---|---|---|---|
Cache-Control |
Yes | Constant private, no-store |
— |
503 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.
Read the exact immutable public observation version#
GET /projects/{projectId}/observations/{version}
Operation ID: getSavedProjectObservation
Authentication: __Host-klineo_session cookie (sessionCookie)
Requires current interactive workspace membership. Developer service credentials are not accepted. A saved public-project bookmark grants no issuer ownership, treasury access, paid entitlement, financial permission or publication authority. Observations are immutable public snapshots; refreshing appends a new version without rewriting history.
Parameters#
| Name | Location | Required | Type | Description and constraints |
|---|---|---|---|---|
x-klineo-organization-id |
header | Yes | string |
— |
projectId |
path | Yes | string |
Pattern: ^project_[0-9a-f]{32}$ |
version |
path | Yes | string |
Pattern: ^[1-9][0-9]{0,17}$ |
Responses#
| Status | Description | Content type and schema |
|---|---|---|
200 |
Tenant-authorized saved public-project record. | application/json: object |
400 |
Invalid input or collection cursor. | application/json: object |
401 |
Interactive session required. | application/json: object |
403 |
Current workspace access or requested operation denied. | application/json: object |
404 |
Record unavailable in this workspace. | application/json: object |
429 |
Request or public-source quota exceeded. | application/json: object |
503 |
Saved project storage or public source unavailable. | application/json: object |
200 response headers
| Header | Required | Type | Description and constraints |
|---|---|---|---|
Cache-Control |
Yes | Constant private, no-store |
— |
ETag |
Yes | string |
Pattern: ^"0x[0-9a-f]{64}"$ |
200 application/json body
object — Additional properties rejected
| Field | Required at this level | Type | Description and constraints |
|---|---|---|---|
data |
Yes | SavedProjectObservation | — |
Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.
400 response headers
| Header | Required | Type | Description and constraints |
|---|---|---|---|
Cache-Control |
Yes | Constant private, no-store |
— |
400 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.
401 response headers
| Header | Required | Type | Description and constraints |
|---|---|---|---|
Cache-Control |
Yes | Constant private, no-store |
— |
401 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.
403 response headers
| Header | Required | Type | Description and constraints |
|---|---|---|---|
Cache-Control |
Yes | Constant private, no-store |
— |
403 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.
404 response headers
| Header | Required | Type | Description and constraints |
|---|---|---|---|
Cache-Control |
Yes | Constant private, no-store |
— |
404 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.
429 response headers
| Header | Required | Type | Description and constraints |
|---|---|---|---|
Cache-Control |
Yes | Constant private, no-store |
— |
429 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.
503 response headers
| Header | Required | Type | Description and constraints |
|---|---|---|---|
Cache-Control |
Yes | Constant private, no-store |
— |
503 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.