API reference

​

Observability

• Activity runs — GET /api/v1/activity/{kind}
• Audit history — GET /api/v1/audit
• Global operation history — GET /api/v1/operations
• Dashboard metrics — POST /api/v1/telemetry/metrics/dashboard
• Prometheus query — GET /api/v1/telemetry/prometheus/api/v1/{path}
• Prometheus query post — POST /api/v1/telemetry/prometheus/api/v1/{path}
• Telemetry sql — POST /api/v1/telemetry/sql
• Telemetry status — GET /api/v1/telemetry/status
• Telemetry traces — GET /api/v1/telemetry/traces

​

Assistant

• Assistant capabilities — GET /api/v1/assistant/capabilities
• Assistant list conversations — GET /api/v1/assistant/conversations
• Assistant create conversation — POST /api/v1/assistant/conversations
• Assistant get conversation — GET /api/v1/assistant/conversations/{conversation_id}
• Assistant submit turn — POST /api/v1/assistant/conversations/{conversation_id}/turns
• Assistant get turn — GET /api/v1/assistant/conversations/{conversation_id}/turns/{turn_id}
• Assistant approve action — POST /api/v1/assistant/conversations/{conversation_id}/turns/{turn_id}/actions/{action_id}/approval
• Assistant cancel turn — POST /api/v1/assistant/conversations/{conversation_id}/turns/{turn_id}/cancel
• Assistant events — GET /api/v1/assistant/conversations/{conversation_id}/turns/{turn_id}/events
• Assistant event stream — GET /api/v1/assistant/conversations/{conversation_id}/turns/{turn_id}/events/stream

​

Configuration and capabilities

• Capabilities — GET /api/v1/capabilities
• Get configuration — GET /api/v1/config
• Save configuration — PUT /api/v1/config
• Validate configuration — POST /api/v1/config/validate
• Get feature flags — GET /api/v1/feature-flags
• Update feature flag — PUT /api/v1/feature-flags
• Search resources — GET /api/v1/search/{kind}

​

Catalogs and tables

• List catalogs — GET /api/v1/catalogs
• Create catalog — POST /api/v1/catalogs
• Validate catalog connection — POST /api/v1/catalogs/validate
• Delete catalog — DELETE /api/v1/catalogs/{catalog_id}
• Get catalog — GET /api/v1/catalogs/{catalog_id}
• Update catalog — PATCH /api/v1/catalogs/{catalog_id}
• Catalog capabilities — GET /api/v1/catalogs/{catalog_id}/capabilities
• List namespaces — GET /api/v1/catalogs/{catalog_id}/namespaces
• Patch catalog — PATCH /api/v1/catalogs/{catalog_id}/options
• List relations — GET /api/v1/catalogs/{catalog_id}/relations
• Get relation — GET /api/v1/catalogs/{catalog_id}/relations/{name}
• Relation capabilities — GET /api/v1/catalogs/{catalog_id}/relations/{name}/capabilities
• Set table format version — POST /api/v1/catalogs/{catalog_id}/relations/{name}/format-version
• Set table sort order — POST /api/v1/catalogs/{catalog_id}/relations/{name}/sort-order
• Search relations — GET /api/v1/catalogs/{catalog_id}/search
• Register table — POST /api/v1/catalogs/{catalog_id}/tables/register
• Inspect table — GET /api/v1/catalogs/{catalog_id}/tables/{name}/inspection
• Rename view — POST /api/v1/catalogs/{catalog_id}/views/{name}/rename

​

Dashboards

• List dashboards — GET /api/v1/dashboards
• Create dashboard — POST /api/v1/dashboards
• Preview dashboard dataset — POST /api/v1/dashboards/preview
• Delete dashboard — DELETE /api/v1/dashboards/{dashboard_id}
• Get dashboard — GET /api/v1/dashboards/{dashboard_id}
• Save dashboard — PUT /api/v1/dashboards/{dashboard_id}
• Activate dashboard — POST /api/v1/dashboards/{dashboard_id}/activate
• Pause dashboard — POST /api/v1/dashboards/{dashboard_id}/pause
• Refresh dashboard — POST /api/v1/dashboards/{dashboard_id}/refresh
• Resume dashboard — POST /api/v1/dashboards/{dashboard_id}/resume
• Dashboard history — GET /api/v1/dashboards/{dashboard_id}/snapshots
• Dashboard snapshot — GET /api/v1/dashboards/{dashboard_id}/snapshots/{refresh_id}
• Cancel dashboard refresh — POST /api/v1/dashboards/{dashboard_id}/snapshots/{refresh_id}/cancel
• Dashboard dataset results — GET /api/v1/dashboards/{dashboard_id}/snapshots/{refresh_id}/datasets/{dataset_id}/results

​

Compute and workers

• Execution options — GET /api/v1/execution-options
• List workers — GET /api/v1/workers
• Update worker admission — POST /api/v1/workers/admission
• Worker capacity — GET /api/v1/workers/capacity
• Create deployment profile — POST /api/v1/workers/profiles
• Delete deployment profile — DELETE /api/v1/workers/profiles/{name}
• Update deployment profile — PUT /api/v1/workers/profiles/{name}
• Change deployment profile state — POST /api/v1/workers/profiles/{name}/state
• Worker details — GET /api/v1/workers/{allocation_id}
• Retire deployment worker — POST /api/v1/workers/{allocation_id}/retire
• Retry worker provisioning — POST /api/v1/workers/{allocation_id}/retry-provisioning
• Worker tasks — GET /api/v1/workers/{allocation_id}/tasks

​

Notebooks

• List notebooks — GET /api/v1/notebooks
• Create notebook — POST /api/v1/notebooks
• Import notebook — POST /api/v1/notebooks/import
• List notebook summaries — GET /api/v1/notebooks/summaries
• Delete notebook — DELETE /api/v1/notebooks/{notebook_id}
• Get notebook — GET /api/v1/notebooks/{notebook_id}
• Save notebook — PUT /api/v1/notebooks/{notebook_id}
• Export notebook — GET /api/v1/notebooks/{notebook_id}/export
• Notebook revisions — GET /api/v1/notebooks/{notebook_id}/revisions
• Notebook revision — GET /api/v1/notebooks/{notebook_id}/revisions/{revision}
• Notebook run summaries — GET /api/v1/notebooks/{notebook_id}/run-summaries
• List notebook runs — GET /api/v1/notebooks/{notebook_id}/runs
• Submit notebook run — POST /api/v1/notebooks/{notebook_id}/runs
• Get notebook run — GET /api/v1/notebooks/{notebook_id}/runs/{run_id}
• Notebook events — GET /api/v1/notebooks/{notebook_id}/runs/{run_id}/cells/{execution_id}/events
• Notebook outputs — GET /api/v1/notebooks/{notebook_id}/runs/{run_id}/cells/{execution_id}/outputs

​

Sessions and SQL

• List notebook sessions — GET /api/v1/notebooks/{notebook_id}/sessions
• Open notebook session — POST /api/v1/notebooks/{notebook_id}/sessions
• Close notebook session — DELETE /api/v1/notebooks/{notebook_id}/sessions/{session_id}
• Get notebook session — GET /api/v1/notebooks/{notebook_id}/sessions/{session_id}
• Interrupt notebook session — POST /api/v1/notebooks/{notebook_id}/sessions/{session_id}/interrupt
• List session summaries — GET /api/v1/sessions
• Open session — POST /api/v1/sessions
• Close session — DELETE /api/v1/sessions/{session_id}
• Read session — GET /api/v1/sessions/{session_id}
• Analyze — POST /api/v1/sessions/{session_id}/analyze
• Get config — GET /api/v1/sessions/{session_id}/config
• Set config — PATCH /api/v1/sessions/{session_id}/config
• Unset config — DELETE /api/v1/sessions/{session_id}/config/{key}
• List operations — GET /api/v1/sessions/{session_id}/operations
• Submit operation — POST /api/v1/sessions/{session_id}/operations
• Operation status — GET /api/v1/sessions/{session_id}/operations/{operation_id}
• Operation attempts — GET /api/v1/sessions/{session_id}/operations/{operation_id}/attempts
• Get operation attempt — GET /api/v1/sessions/{session_id}/operations/{operation_id}/attempts/{attempt_id}
• Cancel operation — POST /api/v1/sessions/{session_id}/operations/{operation_id}/cancel
• Operation results — GET /api/v1/sessions/{session_id}/operations/{operation_id}/results
• Operation metadata — GET /api/v1/sessions/{session_id}/operations/{operation_id}/results/metadata
• Operation xray — GET /api/v1/sessions/{session_id}/operations/{operation_id}/xray
• Session summary — GET /api/v1/sessions/{session_id}/summary

​

Workloads

• Global run summaries — GET /api/v1/runs
• List workloads — GET /api/v1/workloads
• Create workload — POST /api/v1/workloads
• Validate workload — POST /api/v1/workloads/validate
• Delete workload — DELETE /api/v1/workloads/{workload_id}
• Get workload — GET /api/v1/workloads/{workload_id}
• Update workload — PUT /api/v1/workloads/{workload_id}
• List backfills — GET /api/v1/workloads/{workload_id}/backfills
• Create backfill — POST /api/v1/workloads/{workload_id}/backfills
• Preview backfill — POST /api/v1/workloads/{workload_id}/backfills/preview
• Get backfill — GET /api/v1/workloads/{workload_id}/backfills/{backfill_id}
• Change backfill — POST /api/v1/workloads/{workload_id}/backfills/{backfill_id}
• Pause workload — POST /api/v1/workloads/{workload_id}/pause
• Resume workload — POST /api/v1/workloads/{workload_id}/resume
• Workload run summaries — GET /api/v1/workloads/{workload_id}/run-summaries
• List runs — GET /api/v1/workloads/{workload_id}/runs
• Start run — POST /api/v1/workloads/{workload_id}/runs
• Get run — GET /api/v1/workloads/{workload_id}/runs/{run_id}
• Cancel run — POST /api/v1/workloads/{workload_id}/runs/{run_id}/cancel
• Notification history — GET /api/v1/workloads/{workload_id}/runs/{run_id}/notifications
• Retry notification — POST /api/v1/workloads/{workload_id}/runs/{run_id}/notifications/retry
• Run profile — GET /api/v1/workloads/{workload_id}/runs/{run_id}/profile
• Compare run profiles — GET /api/v1/workloads/{workload_id}/runs/{run_id}/profile/comparison
• Record profile evidence — PUT /api/v1/workloads/{workload_id}/runs/{run_id}/profile/evidence
• Start rerun — POST /api/v1/workloads/{workload_id}/runs/{run_id}/rerun
• Preview rerun — POST /api/v1/workloads/{workload_id}/runs/{run_id}/rerun/preview
• List tasks — GET /api/v1/workloads/{workload_id}/runs/{run_id}/tasks
• Get task — GET /api/v1/workloads/{workload_id}/runs/{run_id}/tasks/{task_id}
• List attempts — GET /api/v1/workloads/{workload_id}/runs/{run_id}/tasks/{task_id}/attempts
• Get attempt — GET /api/v1/workloads/{workload_id}/runs/{run_id}/tasks/{task_id}/attempts/{attempt_id}
• Task profile — GET /api/v1/workloads/{workload_id}/runs/{run_id}/tasks/{task_id}/profile
• Task results — GET /api/v1/workloads/{workload_id}/runs/{run_id}/tasks/{task_id}/results
• Task metadata — GET /api/v1/workloads/{workload_id}/runs/{run_id}/tasks/{task_id}/results/metadata

​

Workspace documents

• List workspace documents — GET /api/v1/workspace/documents
• Create workspace document — POST /api/v1/workspace/documents
• Delete workspace document — DELETE /api/v1/workspace/documents/{document_id}
• Get workspace document — GET /api/v1/workspace/documents/{document_id}
• Save workspace document — PUT /api/v1/workspace/documents/{document_id}