Skip to main content
Use the OpenAPI files when generating clients, validating payloads, or giving API context to AI tools.

Specification files

The OMS REST API reference currently contains 48 HTTP operations.

Use with AI tools

Give the model the OpenAPI file plus this instruction:

Client checklist

  1. Find the operation by method or path.
  2. Read every path, query, header, and body parameter.
  3. Build the request from typed fields, not string concatenation where a structured client is available.
  4. Parse the success response according to the documented schema.
  5. Parse error responses defensively because error payloads can vary by failure point.