---
title: API: ops
description: REST endpoints tagged ops — generated from the platform's OpenAPI contract (3 operations).
locale: en
version: 0.2.0
canonical: https://enterium-developer-docs.pages.dev/developers/api/ops/
---

> Documentation index: https://enterium-developer-docs.pages.dev/developers/llms.txt — every page of this portal has a Markdown twin at <route>.md; the frozen API contract is at https://enterium-developer-docs.pages.dev/developers/api/openapi.json.

:::note
Generated from the OpenAPI contract — do not edit by hand. Interactive explorer with full schemas: [https://entherium.duckdns.org:8443/reference](https://entherium.duckdns.org:8443/reference); frozen spec for this build: [openapi.json](/developers/api/openapi.json).
:::

## `GET /api/v1/ops/image-references`

Get Image References

[Open as a page →](./get-ops-image-references/)

Image URLs referenced by articles + plan-vs-generated gaps.

Feed for the image-generation usage reconciler.

**Auth:** `Authorization: Bearer <token>` required

| Parameter | In | Required | Type | Description |
| --- | --- | --- | --- | --- |
| `sc_id` | query | no | `integer \| null` |  |
| `page` | query | no | `integer` |  |
| `page_size` | query | no | `integer` |  |

**Responses:**

| Code | Meaning | Body |
| --- | --- | --- |
| `200` | Successful Response | `ImageReferencesPage` |
| `401` | Missing or invalid authentication credentials | `ErrorResponse` |
| `422` | Validation Error | `HTTPValidationError` |

## `POST /api/v1/ops/orchestrator/heartbeat`

Post Orchestrator Heartbeat

[Open as a page →](./post-ops-orchestrator-heartbeat/)

Record the gen-orchestrator's per-tick heartbeat (targets/active/note).

**Auth:** `Authorization: Bearer <token>` required

| Parameter | In | Required | Type | Description |
| --- | --- | --- | --- | --- |
| `Idempotency-Key` | header | no | `string` | Optional. |

**Request body:** `application/json` — schema `OrchestratorHeartbeatIn`

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `active` | `object \| null` | no |  |
| `note` | `string \| null` | no |  |
| `targets` | `object \| null` | no |  |
| `tick_s` | `integer \| null` | no |  |

**Responses:**

| Code | Meaning | Body |
| --- | --- | --- |
| `204` | Successful Response | — |
| `401` | Missing or invalid authentication credentials | `ErrorResponse` |
| `422` | Validation Error | `HTTPValidationError` |

## `GET /api/v1/ops/overview`

Get Overview

[Open as a page →](./get-ops-overview/)

Live platform ops snapshot — poll this (3-5s) to watch the whole platform.

**Auth:** `Authorization: Bearer <token>` required

**Responses:**

| Code | Meaning | Body |
| --- | --- | --- |
| `200` | Successful Response | `OpsOverview` |
| `401` | Missing or invalid authentication credentials | `ErrorResponse` |