API Reference

Public InstantML API routes generated from the Rust service OpenAPI specification.

Open .md

GET/api/artifact-collections

GET /api/artifact-collections

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}

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}

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}

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

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

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

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

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

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}

Auth: bearerApiKey, browserSession
Parameters: version_id required
Request body: Yes
Responses: 200

GET/api/artifact-versions/{version_id}

GET /api/artifact-versions/{version_id}

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

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

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

Auth: bearerApiKey, browserSession
Parameters: version_id required
Request body: Yes
Responses: 200

GET/api/artifact-versions/resolve

GET /api/artifact-versions/resolve

Auth: bearerApiKey, browserSession
Parameters: ref required, type, project
Responses: 200, 404

GET/api/artifacts/{artifact_id}/download

GET /api/artifacts/{artifact_id}/download

Auth: bearerApiKey, browserSession
Parameters: artifact_id required, Range
Responses: 200, 206, 401, 403, 404, 416

GET/api/dashboard/preferences

GET /api/dashboard/preferences

Auth: browserSession
Responses: 200, 401

PUT/api/dashboard/preferences

PUT /api/dashboard/preferences

Auth: browserSession
Request body: Yes
Responses: 200, 401

POST/api/embed/sessions

POST /api/embed/sessions

Auth: bearerApiKey
Request body: Yes
Responses: 200, 400, 401, 403

GET/api/embed/sessions/{session_id}/current

GET /api/embed/sessions/{session_id}/current

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

Parameters: session_id required
Responses: 200, 404

POST/api/embed/sessions/{session_id}/runs/data

POST /api/embed/sessions/{session_id}/runs/data

Auth: bearerEmbedToken
Parameters: session_id required
Request body: Yes
Responses: 200, 401, 403, 429

GET/api/export

GET /api/export

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

Auth: bearerApiKey, browserSession
Responses: 200, 401, 403

POST/api/imports/jobs

POST /api/imports/jobs

Auth: bearerApiKey, browserSession
Request body: Yes
Responses: 200, 400, 401, 403

GET/api/imports/jobs/{import_id}

GET /api/imports/jobs/{import_id}

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

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

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

Auth: bearerApiKey, browserSession
Parameters: import_id required
Responses: 200, 401, 403, 409

POST/api/imports/mlflow

POST /api/imports/mlflow

Auth: bearerApiKey, browserSession
Parameters: dry_run
Request body: Yes
Responses: 200, 400, 401, 403

POST/api/imports/neptune

POST /api/imports/neptune

Auth: bearerApiKey, browserSession
Parameters: dry_run
Request body: Yes
Responses: 200, 400, 401, 403

POST/api/imports/wandb

POST /api/imports/wandb

Auth: bearerApiKey, browserSession
Parameters: dry_run
Request body: Yes
Responses: 200, 400, 401, 403

POST/api/metrics/series

POST /api/metrics/series

Auth: bearerApiKey, browserSession
Request body: Yes
Responses: 200, 401

GET/api/objects/{object_id}/rows

GET /api/objects/{object_id}/rows

Auth: bearerApiKey, browserSession
Parameters: object_id required, limit, offset
Responses: 200, 401, 404

GET/api/overview

GET /api/overview

Auth: bearerApiKey, browserSession
Parameters: project, status, display_status, q, metric_key
Responses: 200, 400, 401

GET/api/reports

GET /api/reports

Auth: browserSession, bearerApiKey
Parameters: limit, offset, project
Responses: 200, 401

POST/api/reports

POST /api/reports

Auth: browserSession, bearerApiKey
Request body: Yes
Responses: 200, 400, 401, 403

DELETE/api/reports/{report_id}

DELETE /api/reports/{report_id}

Auth: browserSession, bearerApiKey
Parameters: report_id required
Responses: 200, 401, 403, 404

GET/api/reports/{report_id}

GET /api/reports/{report_id}

Auth: browserSession, bearerApiKey
Parameters: report_id required, share
Responses: 200, 401, 404

PATCH/api/reports/{report_id}

PATCH /api/reports/{report_id}

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

Auth: browserSession, bearerApiKey
Parameters: report_id required, share
Responses: 200, 401, 404

POST/api/reports/{report_id}/share

POST /api/reports/{report_id}/share

Auth: browserSession, bearerApiKey
Parameters: report_id required
Responses: 200, 401, 403, 404

GET/api/reports/panels

GET /api/reports/panels

Auth: browserSession, bearerApiKey
Responses: 200, 401

GET/api/reports/share/{share_token}

GET /api/reports/share/{share_token}

Parameters: share_token required
Responses: 200, 404

POST/api/runs/{run_id}/artifact-inputs

POST /api/runs/{run_id}/artifact-inputs

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

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

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

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

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

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

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

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

Auth: bearerApiKey, browserSession
Parameters: run_id required
Responses: 200, 404

GET/api/runs/{run_id}/logs

GET /api/runs/{run_id}/logs

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

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

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

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

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

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

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

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}

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

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

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

Auth: bearerApiKey, browserSession
Parameters: run_ids, runs, reference_run_id, diff_only
Responses: 200, 401

POST/api/runs/stop

POST /api/runs/stop

Auth: bearerApiKey, browserSession
Parameters: Idempotency-Key
Request body: Yes
Responses: 200, 400, 401, 403

GET/api/runs/summary

GET /api/runs/summary

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

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

Auth: bearerApiKey, browserSession
Responses: 200, 401, 403

GET/api/usage/export

GET /api/usage/export

Auth: bearerApiKey, browserSession
Responses: 200, 401, 403

POST/api/workspace-view-data

POST /api/workspace-view-data

Auth: bearerApiKey, browserSession
Request body: Yes
Responses: 200, 400, 401, 403, 404

GET/api/workspace-views

GET /api/workspace-views

Auth: browserSession
Parameters: limit, cursor
Responses: 200, 401

POST/api/workspace-views

POST /api/workspace-views

Auth: browserSession
Request body: Yes
Responses: 200, 400, 401

DELETE/api/workspace-views/{view_id}

DELETE /api/workspace-views/{view_id}

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}

Auth: browserSession
Parameters: view_id required
Responses: 200, 401, 404

PUT/api/workspace-views/{view_id}

PUT /api/workspace-views/{view_id}

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

Auth: browserSession
Parameters: view_id required
Responses: 200, 401, 404

POST/api/workspace-views/import

POST /api/workspace-views/import

Auth: browserSession
Request body: Yes
Responses: 200, 400, 401, 409

GET/health

GET /health

Responses: 200

GET/projects

GET /projects

Auth: bearerApiKey, browserSession
Responses: 200, 401

POST/projects

POST /projects

Auth: bearerApiKey, browserSession
Request body: Yes
Responses: 200, 400, 401

GET/readyz

GET /readyz

Responses: 200, 503

GET/runs

GET /runs

Auth: bearerApiKey, browserSession
Parameters: project, status, display_status, q, sort_by, metric_key, limit, offset
Responses: 200, 400, 401

POST/runs

POST /runs

Auth: bearerApiKey, browserSession
Request body: Yes
Responses: 200, 400, 401

GET/runs/{run_id}

GET /runs/{run_id}

Auth: bearerApiKey, browserSession
Parameters: run_id required
Responses: 200, 404

PATCH/runs/{run_id}

PATCH /runs/{run_id}

Auth: bearerApiKey, browserSession
Parameters: run_id required
Request body: Yes
Responses: 200, 400, 404

GET/runs/{run_id}/metrics

GET /runs/{run_id}/metrics

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

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

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

Auth: bearerApiKey, browserSession
Parameters: run_id required
Request body: Yes
Responses: 200, 400, 404