API¶
This section is for developers integrating with MOI programmatically. It covers model inference, AI Studio product resources, and extension integrations. Choose the API by the resource you need to work with, then follow its quickstart and topic guides.
Choose an API¶
Goal |
Documentation |
Start here |
|---|---|---|
Call chat, embedding, or reranking models, or discover the models available to the current credential |
Genesis API Quickstart, followed by Endpoints and Authentication |
|
Work programmatically with AI Studio resources such as accounts, workspaces, data, workflows, knowledge bases, agents, models, SQL, compute, or alerts |
Product API Quickstart, followed by Common Conventions |
|
Publish processing capabilities as Operator APIs, connect through MCP, or receive Webhooks |
Go directly to Operator API, MCP, or Webhooks |
If you are not sure which interface applies, begin with the Quickstart. Model inference belongs to the Genesis Model API. Management of AI Studio application resources belongs to the Product API. Interfaces that expose platform capabilities to external systems, or deliver callbacks to them, are grouped under Extension APIs.
Suggested Reading Paths¶
Call a Genesis Model¶
Complete one minimal request in the Genesis API Quickstart.
Verify the endpoint and authentication; credentials issued for different purposes are not interchangeable.
Choose Chat Completions, Messages and Streaming, Embeddings, or Rerank for the task.
Before production use, review Responses, Pagination, and Streaming and Models and Providers.
Work with AI Studio Resources¶
Read the Product API Quickstart and Common Conventions to establish request, response, and error-handling behavior.
Understand the scope described in Accounts, Workspaces, and Permissions, then continue to the relevant data, workflow, knowledge-base, agent, or other resource guide.
Use only interfaces that are documented and enabled in your environment. This repository does not currently contain a complete OpenAPI specification that can serve as the sole source of truth. For exact paths, fields, and availability, use the relevant topic guide, the access information shown in the console, and the actual API response.
Developer Guides and API Reference¶
This section focuses on integration workflows and task-oriented guidance. For a compact view of interface details, platform integration options, or error semantics, use the API Reference and Error Codes. If a higher-level client library is a better fit, continue to the SDK documentation.