# v1 · Platform, credentials and webhooks

Paths on this page are relative to <code>/api/liquidity-studio/v1</code>. Authentication and required headers vary by operation.

[API reference overview](/api-reference/v1/overview/) · [OpenAPI download](/openapi/liquidity-studio.openapi.json)

## Operations on this page

| Method | Path | Operation |
| --- | --- | --- |
| <code>GET</code> | <code>/openapi.json</code> | [getOpenapiJson](#getOpenapiJson) |
| <code>GET</code> | <code>/status</code> | [getStatus](#getStatus) |
| <code>GET</code> | <code>/jobs/{jobId}</code> | [getJobsByJobId](#getJobsByJobId) |

<a id="getOpenapiJson"></a>

## getOpenapiJson

`GET /openapi.json`

Operation ID: <code>getOpenapiJson</code>

**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 |
| --- | --- | --- |
| <code>200</code> | Successful response | <code>application/json</code>: <code>object</code> |
| <code>default</code> | Structured API error | <code>application/json</code>: [ApiErrorEnvelope](/api-reference/v1/schemas/api-error-envelope/) |

**<code>200</code> <code>application/json</code> body**

<code>object</code>

| Field | Required at this level | Type | Description and constraints |
| --- | --- | --- | --- |
| <code>data</code> | Yes | <code>object</code> | 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.

<a id="getStatus"></a>

## getStatus

`GET /status`

Operation ID: <code>getStatus</code>

**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 |
| --- | --- | --- |
| <code>200</code> | Successful response | <code>application/json</code>: <code>object</code> |
| <code>default</code> | Structured API error | <code>application/json</code>: [ApiErrorEnvelope](/api-reference/v1/schemas/api-error-envelope/) |

**<code>200</code> <code>application/json</code> body**

<code>object</code>

| Field | Required at this level | Type | Description and constraints |
| --- | --- | --- | --- |
| <code>data</code> | Yes | <code>object</code> | 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.

<a id="getJobsByJobId"></a>

## getJobsByJobId

`GET /jobs/{jobId}`

Operation ID: <code>getJobsByJobId</code>

**Authentication:** <code>&#95;&#95;Host-klineo&#95;session</code> cookie (<code>sessionCookie</code>)

### Parameters

| Name | Location | Required | Type | Description and constraints |
| --- | --- | --- | --- | --- |
| <code>jobId</code> | path | Yes | <code>string</code> | Min length: <code>1</code> |

### Responses

| Status | Description | Content type and schema |
| --- | --- | --- |
| <code>200</code> | Successful response | <code>application/json</code>: <code>object</code> |
| <code>default</code> | Structured API error | <code>application/json</code>: [ApiErrorEnvelope](/api-reference/v1/schemas/api-error-envelope/) |

**<code>200</code> <code>application/json</code> body**

<code>object</code>

| Field | Required at this level | Type | Description and constraints |
| --- | --- | --- | --- |
| <code>data</code> | Yes | [BackgroundJob](/api-reference/v1/schemas/background-job/) | — |

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