AlgoInstanceRow
An algo instance as the API serves it: its identity, where it stands and the record of who moved it — `createdByUserId` and `lastUpdatedByUserId` (null when the engine or the platform's own rule moved it; `lastCause` says which) — with the row extras (`globalSequence`). The `ETag` is `configSeq`: the latest staged document's sequence number, what `If-Match` takes on a config write.
Properties
| Name | Type | Description |
|---|---|---|
| globalSequence | object | |
| unscaled | boolean | Never present since 0.3.3: every money value on this API states its own scale on the wire — a policy amount or cap since 0.3.3, an order's and an execution's since 0.3.2, a balance's since 0.3.1 — so |
| instanceId | integer | The instance's id — the value its orders carry as `algoInstanceId`. |
| orgId | integer | The organisation that owns the instance. |
| algoVersionId | integer | The catalog version the instance runs (`GET /algos/versions`). |
| pool | string | The engine pool the instance runs on, fixed at creation. |
| displayName | string | The instance's display name, as created. |
| status | object | Where the instance stands: `CREATED` until its first document is applied, `STOPPED` or `STARTED` under the desk, `ERROR` after the engine's fault trip (left only by a stop), `DELETED` terminal. `PENDI |
| transitionSeq | integer | The instance's transition number: 1 at creation, one more on every move. |
| configSeq | integer | The latest staged document's sequence number — the `ETag`, and what `If-Match` takes on a config write. |
| appliedConfigSeq | integer | The document in force; 0 while none has been applied. |
| createdByUserId | integernull | The user who created the instance. |
| createdAtNs | string | When it was created — epoch nanoseconds as a decimal string. |
| lastUpdatedByUserId | integernull | The user whose command last moved the instance; null when the engine or the platform's own rule did — `lastCause` says which. |
| lastUpdatedAtNs | string | When it last moved — epoch nanoseconds as a decimal string. |
| lastCause | object | Why it last moved: a command, the organisation's halt, its first document applied, the engine's fault trip, or the engine's divergence check. The value set is append-only: read an unknown name as `UNK |
| lastCommandKind | object | The command behind the last move — a desk's, or the engine's report that moved it. The value set is append-only: read an unknown name as `UNKNOWN`. |
| pendingByUserId | integernull | Reserved; always null. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://artifacts.apis.io/immix/json-schema/immix-algo-instance-row-schema.json",
"title": "AlgoInstanceRow",
"description": "An algo instance as the API serves it: its identity, where it stands and the record of who moved it — `createdByUserId` and `lastUpdatedByUserId` (null when the engine or the platform's own rule moved it; `lastCause` says which) — with the row extras (`globalSequence`). The `ETag` is `configSeq`: the latest staged document's sequence number, what `If-Match` takes on a config write.",
"x-generated": "2026-11-10",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/immix-algos-api-openapi.yml#/components/schemas/AlgoInstanceRow",
"type": "object",
"properties": {
"globalSequence": {
"$ref": "#/$defs/GlobalSequenceValue"
},
"unscaled": {
"type": "boolean",
"description": "Never present since 0.3.3: every money value on this API states its own scale on the wire — a policy amount or cap since 0.3.3, an order's and an execution's since 0.3.2, a balance's since 0.3.1 — so a row is never served raw, whether or not this member holds the asset or instrument it references. Kept, deprecated, so a client generated from 0.3.2 still compiles; it goes at the next major.",
"deprecated": true
},
"instanceId": {
"type": "integer",
"description": "The instance's id — the value its orders carry as `algoInstanceId`."
},
"orgId": {
"type": "integer",
"description": "The organisation that owns the instance."
},
"algoVersionId": {
"type": "integer",
"description": "The catalog version the instance runs (`GET /algos/versions`)."
},
"pool": {
"type": "string",
"description": "The engine pool the instance runs on, fixed at creation."
},
"displayName": {
"type": "string",
"description": "The instance's display name, as created."
},
"status": {
"$ref": "#/$defs/AlgoInstanceRowStatus",
"description": "Where the instance stands: `CREATED` until its first document is applied, `STOPPED` or `STARTED` under the desk, `ERROR` after the engine's fault trip (left only by a stop), `DELETED` terminal. `PENDING_APPROVAL` and `DISABLED` are reserved and never served today. The value set is append-only: read an unknown name as `UNKNOWN`."
},
"transitionSeq": {
"type": "integer",
"description": "The instance's transition number: 1 at creation, one more on every move."
},
"configSeq": {
"type": "integer",
"description": "The latest staged document's sequence number — the `ETag`, and what `If-Match` takes on a config write."
},
"appliedConfigSeq": {
"type": "integer",
"description": "The document in force; 0 while none has been applied."
},
"createdByUserId": {
"type": [
"integer",
"null"
],
"description": "The user who created the instance."
},
"createdAtNs": {
"type": "string",
"pattern": "^-?[0-9]+$",
"description": "When it was created — epoch nanoseconds as a decimal string."
},
"lastUpdatedByUserId": {
"type": [
"integer",
"null"
],
"description": "The user whose command last moved the instance; null when the engine or the platform's own rule did — `lastCause` says which."
},
"lastUpdatedAtNs": {
"type": "string",
"pattern": "^-?[0-9]+$",
"description": "When it last moved — epoch nanoseconds as a decimal string."
},
"lastCause": {
"$ref": "#/$defs/AlgoInstanceRowLastCause",
"description": "Why it last moved: a command, the organisation's halt, its first document applied, the engine's fault trip, or the engine's divergence check. The value set is append-only: read an unknown name as `UNKNOWN`."
},
"lastCommandKind": {
"$ref": "#/$defs/AlgoInstanceRowLastCommandKind",
"description": "The command behind the last move — a desk's, or the engine's report that moved it. The value set is append-only: read an unknown name as `UNKNOWN`."
},
"pendingByUserId": {
"type": [
"integer",
"null"
],
"description": "Reserved; always null."
}
},
"required": [
"globalSequence",
"instanceId",
"orgId",
"algoVersionId",
"pool",
"displayName",
"status",
"transitionSeq",
"configSeq",
"appliedConfigSeq",
"createdAtNs",
"lastUpdatedAtNs",
"lastCause",
"lastCommandKind"
],
"$defs": {
"AlgoInstanceRowLastCause": {
"type": "string",
"enum": [
"UNKNOWN",
"COMMAND",
"HALT",
"CONFIG_APPLIED",
"ENGINE_FAULT",
"DIVERGED"
],
"description": "Why it last moved: a command, the organisation's halt, its first document applied, the engine's fault trip, or the engine's divergence check. The value set is append-only: read an unknown name as `UNKNOWN`.",
"title": "AlgoInstanceRowLastCause"
},
"AlgoInstanceRowLastCommandKind": {
"type": "string",
"enum": [
"UNKNOWN",
"CREATE_ALGO_INSTANCE",
"SUBMIT_ALGO_CONFIG",
"START_ALGO_INSTANCE",
"STOP_ALGO_INSTANCE",
"DELETE_ALGO_INSTANCE",
"HALT_ALGOS",
"REPORT_ALGO_VERSIONS",
"REPORT_ALGO_CONFIG_OUTCOME",
"REPORT_ALGO_INSTANCE_FAULT"
],
"description": "The command behind the last move — a desk's, or the engine's report that moved it. The value set is append-only: read an unknown name as `UNKNOWN`.",
"title": "AlgoInstanceRowLastCommandKind"
},
"AlgoInstanceRowStatus": {
"type": "string",
"enum": [
"UNKNOWN",
"CREATED",
"STOPPED",
"STARTED",
"ERROR",
"DELETED",
"PENDING_APPROVAL",
"DISABLED"
],
"description": "Where the instance stands: `CREATED` until its first document is applied, `STOPPED` or `STARTED` under the desk, `ERROR` after the engine's fault trip (left only by a stop), `DELETED` terminal. `PENDING_APPROVAL` and `DISABLED` are reserved and never served today. The value set is append-only: read an unknown name as `UNKNOWN`.",
"title": "AlgoInstanceRowStatus"
},
"GlobalSequenceValue": {
"type": "string",
"pattern": "^[0-9]+$",
"description": "The position as a decimal string — the last change this member had applied, orders, balance readings and algo instances included.",
"title": "GlobalSequenceValue"
}
}
}
Work with this as data
Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for schemas
4 MCP tools reach this
find_json_schemasBrowse and filter every JSON Schema in the catalog.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
curl "https://apis.io/api/v1/json-schemas/immix-algo-instance-row"
curl "https://apis.io/api/v1/json-schemas?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.