Paths on this page are relative to /api/liquidity-studio/v1. Authentication and required headers vary by operation.
API reference overview · OpenAPI download
Operations on this page#
| Method | Path | Operation |
|---|---|---|
GET |
/openapi.json |
getOpenapiJson |
GET |
/status |
getStatus |
GET |
/jobs/{jobId} |
getJobsByJobId |
getOpenapiJson#
GET /openapi.json
Operation ID: getOpenapiJson
Authentication: No authentication requirement is declared in this OpenAPI operation. Consult the access guide and deployed service configuration.
This operation declares no parameters.
Responses#
| Status | Description | Content type and schema |
|---|---|---|
200 |
Successful response | application/json: object |
default |
Structured API error | application/json: ApiErrorEnvelope |
200 application/json body
object
| Field | Required at this level | Type | Description and constraints |
|---|---|---|---|
data |
Yes | object |
The typed runtime domain record returned by this operation. Additional properties allowed |
Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.
getStatus#
GET /status
Operation ID: getStatus
Authentication: No authentication requirement is declared in this OpenAPI operation. Consult the access guide and deployed service configuration.
This operation declares no parameters.
Responses#
| Status | Description | Content type and schema |
|---|---|---|
200 |
Successful response | application/json: object |
default |
Structured API error | application/json: ApiErrorEnvelope |
200 application/json body
object
| Field | Required at this level | Type | Description and constraints |
|---|---|---|---|
data |
Yes | object |
The typed runtime domain record returned by this operation. Additional properties allowed |
Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.
getJobsByJobId#
GET /jobs/{jobId}
Operation ID: getJobsByJobId
Authentication: __Host-klineo_session cookie (sessionCookie)
Parameters#
| Name | Location | Required | Type | Description and constraints |
|---|---|---|---|---|
jobId |
path | Yes | string |
Min length: 1 |
Responses#
| Status | Description | Content type and schema |
|---|---|---|
200 |
Successful response | application/json: object |
default |
Structured API error | application/json: ApiErrorEnvelope |
200 application/json body
object
| Field | Required at this level | Type | Description and constraints |
|---|---|---|---|
data |
Yes | BackgroundJob | — |
Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.