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

> 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).
:::

## `POST /api/v1/lifecycles/{entity_name}/processEvent`

Process Event

[Open as a page →](./post-lifecycles-entity-name-processevent/)

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

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

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

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `event` | `string` | no | outlet name on automated steps |
| `filter` | `object \| null` | no |  |
| `lcid` | `integer \| null` | no |  |
| `max` | `integer` | no | hard upper bound per call |

_Example:_

```json
{
  "event": "tick",
  "lcid": 4,
  "max": 50
}
```

**Responses:**

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

## `POST /api/v1/lifecycles/{entity_name}/{guid}/advance`

Advance

[Open as a page →](./post-lifecycles-entity-name-guid-advance/)

Advance a record via an outlet (analog of Entherium's `advance_record`).

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

| Parameter | In | Required | Type | Description |
| --- | --- | --- | --- | --- |
| `entity_name` | path | yes | `string` |  |
| `guid` | path | yes | `integer` |  |
| `Idempotency-Key` | header | no | `string` | Optional. |

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

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `detail` | `object \| null` | no |  |
| `outlet` | `string` | yes | Outlet name (ok, error, or conditional name) |

_Example:_

```json
{
  "detail": {
    "note": "verified live"
  },
  "outlet": "ok"
}
```

**Responses:**

| Code | Meaning | Body |
| --- | --- | --- |
| `200` | Successful Response | `AdvanceResponse` |
| `401` | Missing or invalid authentication credentials | `ErrorResponse` |
| `404` | Entity or lifecycle not found | `ErrorResponse` |
| `409` | Transition not allowed from the current step | `ErrorResponse` |
| `422` | Validation Error | `HTTPValidationError` |

## `GET /api/v1/lifecycles/{entity_name}/{guid}/log`

Read Log

[Open as a page →](./get-lifecycles-entity-name-guid-log/)

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

| Parameter | In | Required | Type | Description |
| --- | --- | --- | --- | --- |
| `entity_name` | path | yes | `string` |  |
| `guid` | path | yes | `integer` |  |
| `limit` | query | no | `integer` |  |

**Responses:**

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

## `POST /api/v1/lifecycles/{entity_name}/{guid}/postMessage`

Post Message

[Open as a page →](./post-lifecycles-entity-name-guid-postmessage/)

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

| Parameter | In | Required | Type | Description |
| --- | --- | --- | --- | --- |
| `entity_name` | path | yes | `string` |  |
| `guid` | path | yes | `integer` |  |
| `Idempotency-Key` | header | no | `string` | Optional. |

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

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `detail` | `object \| null` | no |  |
| `message` | `string` | yes |  |

_Example:_

```json
{
  "message": "Held back: waiting for the source to confirm the figure."
}
```

**Responses:**

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

## `GET /api/v1/lifecycles/{entity_name}/{guid}/state`

Get State

[Open as a page →](./get-lifecycles-entity-name-guid-state/)

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

| Parameter | In | Required | Type | Description |
| --- | --- | --- | --- | --- |
| `entity_name` | path | yes | `string` |  |
| `guid` | path | yes | `integer` |  |

**Responses:**

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

## `POST /api/v1/lifecycles/{entity_name}/{guid}/stepTo`

Step To

[Open as a page →](./post-lifecycles-entity-name-guid-stepto/)

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

| Parameter | In | Required | Type | Description |
| --- | --- | --- | --- | --- |
| `entity_name` | path | yes | `string` |  |
| `guid` | path | yes | `integer` |  |
| `Idempotency-Key` | header | no | `string` | Optional. |

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

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `comment` | `string \| null` | no |  |
| `detail` | `object \| null` | no |  |
| `to_step` | `integer` | yes | target step id from LC definition |

_Example:_

```json
{
  "comment": "reviewed; moving to publish-ready",
  "detail": {
    "reviewer": "agent"
  },
  "to_step": 3
}
```

**Responses:**

| Code | Meaning | Body |
| --- | --- | --- |
| `200` | Successful Response | `AdvanceResponse` |
| `401` | Missing or invalid authentication credentials | `ErrorResponse` |
| `404` | Entity or lifecycle not found | `ErrorResponse` |
| `409` | Transition not allowed from the current step | `ErrorResponse` |
| `422` | Validation Error | `HTTPValidationError` |