Quickstart

Make your first model run from Marketplace, Playground, and the API.

Run your first model

Use this path when you are a developer or consumer who wants to use an existing published model.

Before you start

• You can sign in to the product app.
• Your active workspace has access to Marketplace, Playground, API Keys, and Billing.
• If you call the API from a backend service, you have permission to create API keys.

Five-minute flow

1. Sign in and choose the workspace that should own the usage and billing.
2. Open Marketplace and pick a published model that matches your use case.
3. Try the model in Playground with a small, safe input.
4. Create an API key from the API Keys page.
5. Run the model through POST /api/runs.

curl -X POST "$AIMP_GATEWAY_URL/api/runs" \
  -H "X-API-Key: $AIMP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "demo-model",
    "mode": "execute",
    "scope": "playground",
    "input": {
      "text": "Summarize this message in one sentence."
    },
    "params": {}
  }'

Expected response

Successful runs return a JSON envelope from the Runtime plus run metadata added by the Gateway. The output fields depend on the selected model contract.

{
  "success": true,
  "output": {
    "result": {
      "kind": "text",
      "content": "A short summary."
    }
  },
  "run": {
    "status": "completed"
  }
}

Next steps

• Learn how to choose a model.
• Review the REST API request shape.
• Copy Python or JavaScript examples.
• Check errors and rate limits before production use.