Skip to main content

Documentation Index

Fetch the complete documentation index at: https://aimp.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Concepts

These terms are the minimum vocabulary needed to use AIMP correctly.

Workspace

A workspace owns API keys, usage, billing, and provider assets. Always confirm the active workspace before creating keys, running models, or publishing models.

Marketplace

Marketplace is the catalog of published models. Use it to inspect the model description, publisher, supported operations, input types, pricing, and links to Playground.

Playground

Playground is the safest place to test a model before integration. It builds the same run request shape used by the API: model, mode, scope, input, and params.

API key

An API key authenticates server-to-server requests. Use X-API-Key when calling the Gateway from a backend service. API keys are shown once when created.

Model operation

An operation is a model-owned action such as execute, search, index, or a custom mode declared by the model. If you are unsure which mode to call, open the model in Marketplace or Playground first.

Scope

scope separates use cases for execution and vector-backed workflows. The common interactive scope is playground. Vector-enabled modes require a scope.

Usage and billing

Runs are associated with the active workspace. Check usage and wallet status before production traffic so that rate limits, balance, and payment issues are visible before they affect users.