> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.immix.xyz/api-reference/rest-api/algos/list-versions/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.immix.xyz/_mcp/server. # List algo versions GET /algos/versions Lists the catalog: every algo version loaded on each engine pool, as the pool last reported it — the artifact's name, version and digest, the api it compiled against, its state schema version and its params schema, which a document for it must conform to. Platform-wide, not per organisation. Reference: https://docs.immix.xyz/api-reference/rest-api/algos/list-versions ## Authentication - `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer `, where token is your auth token. ## Response ### 200 Every loaded entry of every pool, pool then entry order; the projection position rides the body and the header. - `globalSequence` (string, required) — The position as a decimal string — the last change this member had applied, orders, balance readings and algo instances included. - `items` (list of AlgoVersionLoaded, required) ## Errors ### 400 List Versions Algos Request Bad Request Error The request's shape is wrong: a non-positive id, an unknown `view` or filter value. No position rides a refusal that consulted no state. - `error` (ErrorError, required) - `currentVersion` (string, optional) — On 412 `VERSION_CONFLICT`, or `CONFIG_SEQ_CONFLICT` on an algo instance's config write: the row's current version (the `ETag` carries the same token) — re-read, reapply, retry. ### 401 List Versions Algos Request Unauthorized Error No bearer token, or one that does not verify. - `error` (ErrorError, required) - `currentVersion` (string, optional) — On 412 `VERSION_CONFLICT`, or `CONFIG_SEQ_CONFLICT` on an algo instance's config write: the row's current version (the `ETag` carries the same token) — re-read, reapply, retry. ### 403 List Versions Algos Request Forbidden Error Authenticated, but not admitted. `FORBIDDEN_PRINCIPAL`: a token with no `org_id`, a non-ASCII `org_id` or `sub`, a disabled user, or a local binding with no user. `AWAITING_ADMISSION`: your user is not yet admitted — every route but `GET /me` answers this until an administrator admits you. `ORG_NOT_ACTIVE`: your organisation is suspended, pending activation, retired or unregistered. The record owners' 403s (`CAPABILITY_DENIED`, `SELF_APPROVAL`, `NOT_PROPOSER`, …) are refusals on the platform's stream: they carry the position header, and a retried key replays them with `Idempotent-Replay`. - `error` (ErrorError, required) - `currentVersion` (string, optional) — On 412 `VERSION_CONFLICT`, or `CONFIG_SEQ_CONFLICT` on an algo instance's config write: the row's current version (the `ETag` carries the same token) — re-read, reapply, retry. ### 503 List Versions Algos Request Service Unavailable Error This member cannot serve the algos surface now: `NOT_PRIMED` — it is still catching up; retry shortly — or `ALGOS_UNAVAILABLE` — it is deployed without the surface, because the algos owner is not released into its environment yet, so no instance is readable or commandable here and a retry changes nothing; every other route is unaffected. On a write also `NOT_SERVING`, `OWNER_ABSENT`, or the platform's own outcome for a command lost in transit — nothing journaled; retry against a serving member. - `error` (ErrorError, required) - `currentVersion` (string, optional) — On 412 `VERSION_CONFLICT`, or `CONFIG_SEQ_CONFLICT` on an algo instance's config write: the row's current version (the `ETag` carries the same token) — re-read, reapply, retry. ## Types ### AlgoVersionLoaded - `algoVersionId` (integer, required) — The catalog row's id — the value an instance pins; 0 in the empty report, which names no row. - `reportSeq` (integer, required) — The report this entry belongs to, per pool, from 1 (ReportAlgoVersions carries the floor): 0 is the algo-versions fold's no-report sentinel, and an entry numbered 0 folds nothing. - `entryIndex` (integer, required) — This entry's position in the report, from 0. - `entryCount` (integer, required) — How many entries the report has; 0 is the empty report, whose one entry (index 0) replaces the pool's set with nothing. - `apiVersionMajor` (integer, required) — The algo api major version the pool runs. - `apiVersionMinor` (integer, required) — The algo api minor version the pool runs. - `stateSchemaVersion` (integer, required) — The artifact's declared state schema version. - `loadedAtNs` (string, required) — When this entry was recorded, epoch nanoseconds. int64 as a decimal JSON string - `digest` (string, required) — SHA-256 over the artifact's jar bytes, 32 bytes. 32 bytes as 64 lowercase hex characters - `pool` (string, required) — The pool that loaded it, by name. - `algoName` (string, required) — The artifact's name. - `artifactVersion` (string, required) — The artifact's semantic version. - `paramsSchema` (string, required) — The artifact's params schema, verbatim JSON. ### ErrorError - `code` (string, required) — The code to branch on — stable and append-only: treat one you do not know by its HTTP status. The gateway's own: - 400: `MALFORMED_REQUEST`, `MISSING_IDEMPOTENCY_KEY`, `INVALID_IDEMPOTENCY_KEY`, `INVALID_IF_MATCH` - 401: `UNAUTHENTICATED` - 403: `FORBIDDEN_PRINCIPAL`, `AWAITING_ADMISSION`, `ORG_NOT_ACTIVE`, `CAPABILITY_DENIED` (the credential intake) - 404: `NOT_FOUND`, `UNKNOWN_OPERATION` - 409: `IDEMPOTENCY_KEY_REUSED`, `INTAKE_KEY_REUSED` - 413: `TOO_LARGE`, `PAYLOAD_TOO_LARGE`, `DOCUMENT_TOO_LARGE` - 422: a name nothing here holds: `INSTRUMENT_NOT_LIVE`, `ACCOUNT_NOT_ACTIVE` (`POST /orders`), `REFERENCE_UNKNOWN_INSTRUMENT`, `REFERENCE_UNKNOWN_ACCOUNT` (an algo document); `VENUE_UNSUPPORTED`; `SCALE_UNKNOWN` (retired at `0.3.4`) - 429: `INBOX_FULL`, `IN_FLIGHT_FULL`, `RATE_LIMITED` - 500: `INTERRUPTED`, `INTERNAL_ERROR`, `PROJECTION_MISS` - 503: `NOT_PRIMED`, `NOT_SERVING`, `OWNER_ABSENT`, `INTAKE_UNAVAILABLE`, `BALANCES_UNAVAILABLE`, `ALGOS_UNAVAILABLE`, `LOST`, `REJECTED_NOT_REGISTERED`, `REJECTED_NOT_ACTIVE` The record owners' refusals ride verbatim — `OrgRegisterRejected.reason`, `OrderRejected.reason` and `AlgoRejected.reason` list them; the guide maps each to its status. - `message` (string, optional) — Free text for humans; may change without notice — never parse it. ## Examples **Response** ```json { "globalSequence": "globalSequence", "items": [ { "algoVersionId": 1, "reportSeq": 1, "entryIndex": 1, "entryCount": 1, "apiVersionMajor": 1, "apiVersionMinor": 1, "stateSchemaVersion": 1, "loadedAtNs": "loadedAtNs", "digest": "digest", "pool": "pool", "algoName": "algoName", "artifactVersion": "artifactVersion", "paramsSchema": "paramsSchema" } ] } ``` **SDK Code** ```python import requests url = "https://api.example.com/algos/versions" headers = {"Authorization": "Bearer "} response = requests.get(url, headers=headers) print(response.json()) ``` ```javascript const url = 'https://api.example.com/algos/versions'; const options = {method: 'GET', headers: {Authorization: 'Bearer '}}; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "net/http" "io" ) func main() { url := "https://api.example.com/algos/versions" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("Authorization", "Bearer ") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://api.example.com/algos/versions") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["Authorization"] = 'Bearer ' response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://api.example.com/algos/versions") .header("Authorization", "Bearer ") .asString(); ``` ```php request('GET', 'https://api.example.com/algos/versions', [ 'headers' => [ 'Authorization' => 'Bearer ', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api.example.com/algos/versions"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Bearer "); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = ["Authorization": "Bearer "] let request = NSMutableURLRequest(url: NSURL(string: "https://api.example.com/algos/versions")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```