API Reference¶

Choose the reference for the contract you are using:

• HTTP Endpoints is generated automatically from FastAPI OpenAPI for Main, Administration, Chatbot, Data Exchange, Lexi and GenAI. It includes mounted paths, methods, parameters, authentication, request and response schemas, examples and links to each application's live OpenAPI schema. Sources are refreshed locally and versioned with the code; deployed builds render them without importing application routers.
• Functional Domains contains hand-written guides: purposes, business rules, workflows and explained examples. Each introduction links to its generated HTTP contract and to the current instance's Swagger and ReDoc. These links preserve reverse-proxy prefixes.

Swagger, ReDoc and OpenAPI schemas are public. Invoking protected operations still requires the credentials declared by their contracts. Static reference pages never query a tenant database; use the live interfaces for deployment defaults and the authenticated GenAI catalogue for configured providers and models.

WebSockets are described in the streaming guide. MCP has its own transport and tool-discovery protocol and does not expose Swagger or ReDoc. Neither is represented as OpenAPI HTTP operations.

Using request examples¶

Swagger provides English examples for JSON requests, including Galaxy career paths, training searches, skill enrichment, chatbot interactions and consumer imports. Example identifiers such as 42, 101 and 503 are illustrative: replace them with identifiers from the authenticated tenant. Optional fields omitted from an example retain their documented defaults.

For a client-provided Lexi catalogue, use the real private download URL and compute the SHA-256 fingerprint from the exact uploaded file bytes. Upload endpoints still require an actual file. The administration configuration replacement endpoint requires the complete tenant configuration retrieved from its corresponding GET endpoint; a generic partial object is not a configuration template.