# API Reference Public InstantML API routes generated from the Rust service OpenAPI specification. ## GET /api/artifact-collections GET /api/artifact-collections Tags: runs Auth: bearerApiKey, browserSession Parameters: project, type, q, limit, offset Responses: 200, 401, 403 ## GET /api/artifact-collections/{collection_id} GET /api/artifact-collections/{collection_id} Tags: runs Auth: bearerApiKey, browserSession Parameters: collection_id (required) Responses: 200, 404 ## DELETE /api/artifact-collections/{collection_id}/aliases/{alias} DELETE /api/artifact-collections/{collection_id}/aliases/{alias} Tags: runs Auth: bearerApiKey, browserSession Parameters: collection_id (required), alias (required) Request body: yes Responses: 200 ## PUT /api/artifact-collections/{collection_id}/aliases/{alias} PUT /api/artifact-collections/{collection_id}/aliases/{alias} Tags: runs Auth: bearerApiKey, browserSession Parameters: collection_id (required), alias (required) Request body: yes Responses: 200 ## GET /api/artifact-collections/{collection_id}/versions GET /api/artifact-collections/{collection_id}/versions Tags: runs Auth: bearerApiKey, browserSession Parameters: collection_id (required), limit, offset Responses: 200, 404 ## GET /api/artifact-entries/{entry_id}/download GET /api/artifact-entries/{entry_id}/download Tags: runs Auth: bearerApiKey, browserSession Parameters: entry_id (required) Responses: 200, 404, 410 ## POST /api/artifact-uploads/{upload_session_id}/abort POST /api/artifact-uploads/{upload_session_id}/abort Tags: runs Auth: bearerApiKey, browserSession Parameters: upload_session_id (required) Request body: yes Responses: 200 ## POST /api/artifact-uploads/{upload_session_id}/complete POST /api/artifact-uploads/{upload_session_id}/complete Tags: runs Auth: bearerApiKey, browserSession Parameters: upload_session_id (required) Request body: yes Responses: 200 ## POST /api/artifact-uploads/{upload_session_id}/renew POST /api/artifact-uploads/{upload_session_id}/renew Tags: runs Auth: bearerApiKey, browserSession Parameters: upload_session_id (required) Request body: yes Responses: 200 ## DELETE /api/artifact-versions/{version_id} DELETE /api/artifact-versions/{version_id} Tags: runs Auth: bearerApiKey, browserSession Parameters: version_id (required) Request body: yes Responses: 200 ## GET /api/artifact-versions/{version_id} GET /api/artifact-versions/{version_id} Tags: runs Auth: bearerApiKey, browserSession Parameters: version_id (required) Responses: 200, 404, 410 ## GET /api/artifact-versions/{version_id}/lineage GET /api/artifact-versions/{version_id}/lineage Tags: runs Auth: bearerApiKey, browserSession Parameters: version_id (required), limit Responses: 200, 404, 410 ## GET /api/artifact-versions/{version_id}/manifest GET /api/artifact-versions/{version_id}/manifest Tags: runs Auth: bearerApiKey, browserSession Parameters: version_id (required), limit, offset, path_prefix Responses: 200, 404, 410 ## PATCH /api/artifact-versions/{version_id}/retention PATCH /api/artifact-versions/{version_id}/retention Tags: runs Auth: bearerApiKey, browserSession Parameters: version_id (required) Request body: yes Responses: 200 ## GET /api/artifact-versions/resolve GET /api/artifact-versions/resolve Tags: runs Auth: bearerApiKey, browserSession Parameters: ref (required), type, project Responses: 200, 404 ## GET /api/artifacts/{artifact_id}/download GET /api/artifacts/{artifact_id}/download Tags: runs Auth: bearerApiKey, browserSession Parameters: artifact_id (required), Range Responses: 200, 206, 401, 403, 404, 416 ## GET /api/dashboard/preferences GET /api/dashboard/preferences Tags: dashboard Auth: browserSession Responses: 200, 401 ## PUT /api/dashboard/preferences PUT /api/dashboard/preferences Tags: dashboard Auth: browserSession Request body: yes Responses: 200, 401 ## POST /api/embed/sessions POST /api/embed/sessions Tags: embeds Auth: bearerApiKey Request body: yes Responses: 200, 400, 401, 403 ## GET /api/embed/sessions/{session_id}/current GET /api/embed/sessions/{session_id}/current Tags: embeds Auth: bearerEmbedToken Parameters: session_id (required) Responses: 200, 401, 403 ## GET /api/embed/sessions/{session_id}/frame-policy GET /api/embed/sessions/{session_id}/frame-policy Tags: embeds Parameters: session_id (required) Responses: 200, 404 ## POST /api/embed/sessions/{session_id}/runs/data POST /api/embed/sessions/{session_id}/runs/data Tags: embeds Auth: bearerEmbedToken Parameters: session_id (required) Request body: yes Responses: 200, 401, 403, 429 ## GET /api/export GET /api/export Tags: runs Auth: bearerApiKey, browserSession Parameters: project, status, q, sort_by, metric_key, run_ids, runs, format Responses: 200, 400, 401, 403, 404 ## GET /api/imports GET /api/imports Tags: runs Auth: bearerApiKey, browserSession Responses: 200, 401, 403 ## POST /api/imports/jobs POST /api/imports/jobs Tags: runs Auth: bearerApiKey, browserSession Request body: yes Responses: 200, 400, 401, 403 ## GET /api/imports/jobs/{import_id} GET /api/imports/jobs/{import_id} Tags: runs Auth: bearerApiKey, browserSession Parameters: import_id (required) Responses: 200, 401, 403, 404 ## POST /api/imports/jobs/{import_id}/cancel POST /api/imports/jobs/{import_id}/cancel Tags: runs Auth: bearerApiKey, browserSession Parameters: import_id (required) Responses: 200, 401, 403, 409 ## POST /api/imports/jobs/{import_id}/chunks POST /api/imports/jobs/{import_id}/chunks Tags: runs Auth: bearerApiKey, browserSession Parameters: import_id (required) Request body: yes Responses: 200, 400, 401, 403, 409 ## POST /api/imports/jobs/{import_id}/commit POST /api/imports/jobs/{import_id}/commit Tags: runs Auth: bearerApiKey, browserSession Parameters: import_id (required) Responses: 200, 401, 403, 409 ## POST /api/imports/mlflow POST /api/imports/mlflow Tags: runs Auth: bearerApiKey, browserSession Parameters: dry_run Request body: yes Responses: 200, 400, 401, 403 ## POST /api/imports/neptune POST /api/imports/neptune Tags: runs Auth: bearerApiKey, browserSession Parameters: dry_run Request body: yes Responses: 200, 400, 401, 403 ## POST /api/imports/wandb POST /api/imports/wandb Tags: runs Auth: bearerApiKey, browserSession Parameters: dry_run Request body: yes Responses: 200, 400, 401, 403 ## POST /api/metrics/series POST /api/metrics/series Tags: runs Auth: bearerApiKey, browserSession Request body: yes Responses: 200, 401 ## GET /api/objects/{object_id}/rows GET /api/objects/{object_id}/rows Tags: runs Auth: bearerApiKey, browserSession Parameters: object_id (required), limit, offset Responses: 200, 401, 404 ## GET /api/overview GET /api/overview Tags: runs Auth: bearerApiKey, browserSession Parameters: project, status, display_status, q, metric_key Responses: 200, 400, 401 ## GET /api/reports GET /api/reports Tags: reports Auth: browserSession, bearerApiKey Parameters: limit, offset, project Responses: 200, 401 ## POST /api/reports POST /api/reports Tags: reports Auth: browserSession, bearerApiKey Request body: yes Responses: 200, 400, 401, 403 ## DELETE /api/reports/{report_id} DELETE /api/reports/{report_id} Tags: reports Auth: browserSession, bearerApiKey Parameters: report_id (required) Responses: 200, 401, 403, 404 ## GET /api/reports/{report_id} GET /api/reports/{report_id} Tags: reports Auth: browserSession, bearerApiKey Parameters: report_id (required), share Responses: 200, 401, 404 ## PATCH /api/reports/{report_id} PATCH /api/reports/{report_id} Tags: reports Auth: browserSession, bearerApiKey Parameters: report_id (required) Request body: yes Responses: 200, 400, 401, 403, 404 ## GET /api/reports/{report_id}/markdown GET /api/reports/{report_id}/markdown Tags: reports Auth: browserSession, bearerApiKey Parameters: report_id (required), share Responses: 200, 401, 404 ## POST /api/reports/{report_id}/share POST /api/reports/{report_id}/share Tags: reports Auth: browserSession, bearerApiKey Parameters: report_id (required) Responses: 200, 401, 403, 404 ## GET /api/reports/panels GET /api/reports/panels Tags: reports Auth: browserSession, bearerApiKey Responses: 200, 401 ## GET /api/reports/share/{share_token} GET /api/reports/share/{share_token} Tags: reports Parameters: share_token (required) Responses: 200, 404 ## POST /api/runs/{run_id}/artifact-inputs POST /api/runs/{run_id}/artifact-inputs Tags: runs Auth: bearerApiKey, browserSession Parameters: run_id (required) Request body: yes Responses: 200 ## POST /api/runs/{run_id}/artifact-uploads POST /api/runs/{run_id}/artifact-uploads Tags: runs Auth: bearerApiKey, browserSession Parameters: run_id (required) Request body: yes Responses: 200, 400, 403 ## GET /api/runs/{run_id}/artifacts GET /api/runs/{run_id}/artifacts Tags: runs Auth: bearerApiKey, browserSession Parameters: run_id (required), limit Responses: 200, 401, 403, 404 ## POST /api/runs/{run_id}/artifacts POST /api/runs/{run_id}/artifacts Tags: runs Auth: bearerApiKey, browserSession Parameters: run_id (required) Request body: yes Responses: 200, 400, 401, 403, 404 ## POST /api/runs/{run_id}/artifacts/upload POST /api/runs/{run_id}/artifacts/upload Tags: runs Auth: bearerApiKey, browserSession Parameters: run_id (required) Request body: yes Responses: 200, 400, 401, 403, 404 ## GET /api/runs/{run_id}/attributes GET /api/runs/{run_id}/attributes Tags: runs Auth: bearerApiKey, browserSession Parameters: run_id (required), type, path_prefix, limit, offset Responses: 200, 401, 404 ## POST /api/runs/{run_id}/attributes POST /api/runs/{run_id}/attributes Tags: runs Auth: bearerApiKey, browserSession Parameters: run_id (required) Request body: yes Responses: 200, 400, 401, 404 ## POST /api/runs/{run_id}/forks POST /api/runs/{run_id}/forks Tags: runs Auth: bearerApiKey, browserSession Parameters: run_id (required), Idempotency-Key Request body: yes Responses: 200, 400, 401, 402, 403, 404, 409 ## GET /api/runs/{run_id}/lineage GET /api/runs/{run_id}/lineage Tags: runs Auth: bearerApiKey, browserSession Parameters: run_id (required) Responses: 200, 404 ## GET /api/runs/{run_id}/logs GET /api/runs/{run_id}/logs Tags: runs Auth: bearerApiKey, browserSession Parameters: run_id (required), stream, limit, cursor, q, tail Responses: 200, 401, 404 ## POST /api/runs/{run_id}/logs POST /api/runs/{run_id}/logs Tags: runs Auth: bearerApiKey, browserSession Parameters: run_id (required) Request body: yes Responses: 200, 400, 401, 404 ## GET /api/runs/{run_id}/objects GET /api/runs/{run_id}/objects Tags: runs Auth: bearerApiKey, browserSession Parameters: run_id (required), kind, key, limit, offset Responses: 200, 401, 404 ## POST /api/runs/{run_id}/objects POST /api/runs/{run_id}/objects Tags: runs Auth: bearerApiKey, browserSession Parameters: run_id (required) Request body: yes Responses: 200, 400, 401, 404 ## GET /api/runs/{run_id}/rank-metrics/summary GET /api/runs/{run_id}/rank-metrics/summary Tags: runs Auth: bearerApiKey, browserSession Parameters: run_id (required), key, start_step, end_step, limit Responses: 200, 401, 404 ## POST /api/runs/{run_id}/stop POST /api/runs/{run_id}/stop Tags: runs Auth: bearerApiKey, browserSession Parameters: run_id (required), Idempotency-Key Request body: yes Responses: 200, 400, 401, 403, 404 ## POST /api/runs/{run_id}/stop-ack POST /api/runs/{run_id}/stop-ack Tags: runs Auth: bearerApiKey Parameters: run_id (required) Request body: yes Responses: 200, 400, 401, 403, 404, 409 ## GET /api/runs/{run_id}/stop-signal GET /api/runs/{run_id}/stop-signal Tags: runs Auth: bearerApiKey Parameters: run_id (required) Responses: 200, 401, 403, 404 ## GET /api/runs/{run_id}/traces/{trace_id} GET /api/runs/{run_id}/traces/{trace_id} Tags: traces Auth: bearerApiKey, browserSession Parameters: run_id (required), trace_id (required), span_limit Responses: 200, 400, 401, 403, 404 ## GET /api/runs/{run_id}/traces/{trace_id}/spans GET /api/runs/{run_id}/traces/{trace_id}/spans Tags: traces Auth: bearerApiKey, browserSession Parameters: run_id (required), trace_id (required), parent_span_id, limit, cursor Responses: 200, 400, 401, 403, 404 ## POST /api/runs/{run_id}/traces/events POST /api/runs/{run_id}/traces/events Tags: traces Auth: bearerApiKey, browserSession Parameters: run_id (required), Idempotency-Key (required) Request body: yes Responses: 200, 400, 401, 402, 403, 404, 409 ## GET /api/runs/side-by-side GET /api/runs/side-by-side Tags: runs Auth: bearerApiKey, browserSession Parameters: run_ids, runs, reference_run_id, diff_only Responses: 200, 401 ## POST /api/runs/stop POST /api/runs/stop Tags: runs Auth: bearerApiKey, browserSession Parameters: Idempotency-Key Request body: yes Responses: 200, 400, 401, 403 ## GET /api/runs/summary GET /api/runs/summary Tags: runs Auth: bearerApiKey, browserSession Parameters: project, status, display_status, q, sort_by, metric_key, limit, offset, cursor, projection Responses: 200, 400, 401 ## GET /api/traces GET /api/traces Tags: traces Auth: bearerApiKey, browserSession Parameters: project_id, project, run_id, status, kind, q, from, to, min_step, max_step, limit, cursor Responses: 200, 400, 401, 403, 404 ## GET /api/usage GET /api/usage Tags: runs Auth: bearerApiKey, browserSession Responses: 200, 401, 403 ## GET /api/usage/export GET /api/usage/export Tags: runs Auth: bearerApiKey, browserSession Responses: 200, 401, 403 ## POST /api/workspace-view-data POST /api/workspace-view-data Tags: dashboard Auth: bearerApiKey, browserSession Request body: yes Responses: 200, 400, 401, 403, 404 ## GET /api/workspace-views GET /api/workspace-views Tags: dashboard Auth: browserSession Parameters: limit, cursor Responses: 200, 401 ## POST /api/workspace-views POST /api/workspace-views Tags: dashboard Auth: browserSession Request body: yes Responses: 200, 400, 401 ## DELETE /api/workspace-views/{view_id} DELETE /api/workspace-views/{view_id} Tags: dashboard Auth: browserSession Parameters: view_id (required), expected_updated_at (required) Responses: 200, 400, 401, 404, 409 ## GET /api/workspace-views/{view_id} GET /api/workspace-views/{view_id} Tags: dashboard Auth: browserSession Parameters: view_id (required) Responses: 200, 401, 404 ## PUT /api/workspace-views/{view_id} PUT /api/workspace-views/{view_id} Tags: dashboard Auth: browserSession Parameters: view_id (required) Request body: yes Responses: 200, 400, 401, 404 ## GET /api/workspace-views/{view_id}/export GET /api/workspace-views/{view_id}/export Tags: dashboard Auth: browserSession Parameters: view_id (required) Responses: 200, 401, 404 ## POST /api/workspace-views/import POST /api/workspace-views/import Tags: dashboard Auth: browserSession Request body: yes Responses: 200, 400, 401, 409 ## GET /health GET /health Tags: platform Responses: 200 ## GET /projects GET /projects Tags: runs Auth: bearerApiKey, browserSession Responses: 200, 401 ## POST /projects POST /projects Tags: runs Auth: bearerApiKey, browserSession Request body: yes Responses: 200, 400, 401 ## GET /readyz GET /readyz Tags: platform Responses: 200, 503 ## GET /runs GET /runs Tags: runs Auth: bearerApiKey, browserSession Parameters: project, status, display_status, q, sort_by, metric_key, limit, offset Responses: 200, 400, 401 ## POST /runs POST /runs Tags: runs Auth: bearerApiKey, browserSession Request body: yes Responses: 200, 400, 401 ## GET /runs/{run_id} GET /runs/{run_id} Tags: runs Auth: bearerApiKey, browserSession Parameters: run_id (required) Responses: 200, 404 ## PATCH /runs/{run_id} PATCH /runs/{run_id} Tags: runs Auth: bearerApiKey, browserSession Parameters: run_id (required) Request body: yes Responses: 200, 400, 404 ## GET /runs/{run_id}/metrics GET /runs/{run_id}/metrics Tags: runs Auth: bearerApiKey, browserSession Parameters: run_id (required), key, start_step, end_step, limit Responses: 200, 401, 404 ## POST /runs/{run_id}/metrics POST /runs/{run_id}/metrics Tags: runs Auth: bearerApiKey, browserSession Parameters: run_id (required) Request body: yes Responses: 200, 400, 404 ## POST /runs/{run_id}/metrics/batch POST /runs/{run_id}/metrics/batch Tags: runs Auth: bearerApiKey, browserSession Parameters: run_id (required), Idempotency-Key Request body: yes Responses: 200, 400, 404, 409 ## POST /runs/{run_id}/rank-metrics POST /runs/{run_id}/rank-metrics Tags: runs Auth: bearerApiKey, browserSession Parameters: run_id (required) Request body: yes Responses: 200, 400, 404 ## Agent navigation - [Docs index](/llms.txt) - [Full docs bundle](/llms-full.txt) ### Get Started - [Overview](/docs/index.md) - [Quickstart](/docs/quickstart.md) - [Core Concepts](/docs/concepts/core-concepts.md) - [Pricing](/docs/pricing.md) - [Benchmarks](/docs/benchmarks.md) - [Examples](/docs/guides/examples.md) - [Troubleshooting](/docs/troubleshooting.md) ### SDK - [Installation Auth](/docs/sdk/installation-auth.md) - [Logging](/docs/sdk/logging.md) - [Tracing](/docs/sdk/tracing.md) - [Metrics Steps](/docs/sdk/metrics-steps.md) - [Config Tags Notes](/docs/sdk/config-tags-notes.md) - [Artifacts Checkpoints](/docs/sdk/artifacts-checkpoints.md) - [Rich Objects](/docs/sdk/rich-objects.md) - [Distributed Training](/docs/sdk/distributed-training.md) - [Console System Integrations](/docs/sdk/console-system-integrations.md) - [Reliability](/docs/sdk/reliability.md) - [Cli Login](/docs/sdk/cli-login.md) - [Querying Data](/docs/sdk/querying-data.md) - [Agent Mcp](/docs/sdk/agent-mcp.md) - [Examples Patterns](/docs/sdk/examples-patterns.md) ### Integrations - [Overview](/docs/integrations/overview.md) - [Pytorch Lightning](/docs/integrations/pytorch-lightning.md) - [Huggingface Transformers](/docs/integrations/huggingface-transformers.md) - [Keras](/docs/integrations/keras.md) - [Wandb](/docs/integrations/wandb.md) ### Dashboard - [Tour](/docs/dashboard/tour.md) - [Organizations Workspaces](/docs/dashboard/organizations-workspaces.md) - [Runs Workspace](/docs/dashboard/runs-workspace.md) - [Metrics Charts](/docs/dashboard/metrics-charts.md) - [Run Detail](/docs/dashboard/run-detail.md) - [Traces](/docs/dashboard/traces.md) - [Compare Runs](/docs/dashboard/compare-runs.md) - [Research Dashboards](/docs/dashboard/research-dashboards.md) - [Artifacts Files](/docs/dashboard/artifacts-files.md) - [Run Health](/docs/dashboard/alerts.md) - [Datasets](/docs/dashboard/datasets.md) - [Checkpoints](/docs/dashboard/checkpoints.md) - [Reports](/docs/dashboard/reports.md) - [Settings Api Keys](/docs/dashboard/settings-api-keys.md) - [Api Tab](/docs/dashboard/api-tab.md) - [Onboarding Team Billing](/docs/dashboard/onboarding-team-billing.md) ### Data - [Imports](/docs/guides/imports.md) - [W&B alternative](/docs/guides/wandb-alternative.md) - [InstantML vs MLflow](/docs/guides/instantml-vs-mlflow.md) - [W&B import guide](/docs/guides/wandb-import-guide.md) - [W&B and Neptune imports](/docs/guides/wandb-neptune-imports.md) - [Export Usage Limits](/docs/guides/export-usage-limits.md) - [Pricing Limits Billing](/docs/guides/pricing-limits-billing.md) - [Auth Billing Storage](/docs/guides/auth-billing-storage.md) - [Customer Owned Clickhouse](/docs/guides/customer-owned-clickhouse.md) - [Observability](/docs/guides/observability.md) ### API **Practical API guides** - [Authentication](/docs/api/authentication.md) - [Errors And Limits](/docs/api/errors-and-limits.md) - [Health Observability](/docs/api/health-observability.md) - [Projects Runs](/docs/api/projects-runs.md) - [Metrics Series](/docs/api/metrics-series.md) - [Attributes Objects](/docs/api/attributes-objects.md) - [Artifacts](/docs/api/artifacts.md) - [Reports](/docs/api/reports.md) - [Iframe Embeds](/docs/api/iframe-embeds.md) - [Import Export Usage](/docs/api/import-export-usage.md) - [Dashboard Control State](/docs/api/dashboard-control-state.md) **Architecture** - [System Overview](/docs/architecture/system-overview.md) - [Service Planes](/docs/architecture/service-planes.md) - [Storage Model](/docs/architecture/storage-model.md) - [Google Clickhouse](/docs/architecture/google-clickhouse.md) - [Auth Tenancy](/docs/architecture/auth-tenancy.md) - [Schema Reference](/docs/architecture/schema-reference.md) ### API Reference - [API Reference](/docs/api-reference.md) (current page)