> ## Documentation Index
> Fetch the complete documentation index at: https://docs.e6data.com/llms.txt
> Use this file to discover all available pages before exploring further.

# API reference

> Choose an operation by resource. Read parameters beside request and response examples. Copy requests into your own client.

ReferenceApplies to: Unified engine deployments

Choose an operation by resource. Read parameters beside request and response examples. Copy requests into your own client.

## Observability

* [Activity runs](https://docs.e6data.com/transformation/http/reference/activity-runs.md) — GET `/api/v1/activity/{kind}`
* [Audit history](https://docs.e6data.com/transformation/http/reference/audit-history.md) — GET `/api/v1/audit`
* [Global operation history](https://docs.e6data.com/transformation/http/reference/global-operation-history.md) — GET `/api/v1/operations`
* [Dashboard metrics](https://docs.e6data.com/transformation/http/reference/dashboard-metrics.md) — POST `/api/v1/telemetry/metrics/dashboard`
* [Prometheus query](https://docs.e6data.com/transformation/http/reference/prometheus-query.md) — GET `/api/v1/telemetry/prometheus/api/v1/{path}`
* [Prometheus query post](https://docs.e6data.com/transformation/http/reference/prometheus-query-post.md) — POST `/api/v1/telemetry/prometheus/api/v1/{path}`
* [Telemetry sql](https://docs.e6data.com/transformation/http/reference/telemetry-sql.md) — POST `/api/v1/telemetry/sql`
* [Telemetry status](https://docs.e6data.com/transformation/http/reference/telemetry-status.md) — GET `/api/v1/telemetry/status`
* [Telemetry traces](https://docs.e6data.com/transformation/http/reference/telemetry-traces.md) — GET `/api/v1/telemetry/traces`

## Assistant

* [Assistant capabilities](https://docs.e6data.com/transformation/http/reference/assistant-capabilities.md) — GET `/api/v1/assistant/capabilities`
* [Assistant list conversations](https://docs.e6data.com/transformation/http/reference/assistant-list-conversations.md) — GET `/api/v1/assistant/conversations`
* [Assistant create conversation](https://docs.e6data.com/transformation/http/reference/assistant-create-conversation.md) — POST `/api/v1/assistant/conversations`
* [Assistant get conversation](https://docs.e6data.com/transformation/http/reference/assistant-get-conversation.md) — GET `/api/v1/assistant/conversations/{conversation_id}`
* [Assistant submit turn](https://docs.e6data.com/transformation/http/reference/assistant-submit-turn.md) — POST `/api/v1/assistant/conversations/{conversation_id}/turns`
* [Assistant get turn](https://docs.e6data.com/transformation/http/reference/assistant-get-turn.md) — GET `/api/v1/assistant/conversations/{conversation_id}/turns/{turn_id}`
* [Assistant approve action](https://docs.e6data.com/transformation/http/reference/assistant-approve-action.md) — POST `/api/v1/assistant/conversations/{conversation_id}/turns/{turn_id}/actions/{action_id}/approval`
* [Assistant cancel turn](https://docs.e6data.com/transformation/http/reference/assistant-cancel-turn.md) — POST `/api/v1/assistant/conversations/{conversation_id}/turns/{turn_id}/cancel`
* [Assistant events](https://docs.e6data.com/transformation/http/reference/assistant-events.md) — GET `/api/v1/assistant/conversations/{conversation_id}/turns/{turn_id}/events`
* [Assistant event stream](https://docs.e6data.com/transformation/http/reference/assistant-event-stream.md) — GET `/api/v1/assistant/conversations/{conversation_id}/turns/{turn_id}/events/stream`

## Configuration and capabilities

* [Capabilities](https://docs.e6data.com/transformation/http/reference/capabilities.md) — GET `/api/v1/capabilities`
* [Get configuration](https://docs.e6data.com/transformation/http/reference/get-configuration.md) — GET `/api/v1/config`
* [Save configuration](https://docs.e6data.com/transformation/http/reference/save-configuration.md) — PUT `/api/v1/config`
* [Validate configuration](https://docs.e6data.com/transformation/http/reference/validate-configuration.md) — POST `/api/v1/config/validate`
* [Get feature flags](https://docs.e6data.com/transformation/http/reference/get-feature-flags.md) — GET `/api/v1/feature-flags`
* [Update feature flag](https://docs.e6data.com/transformation/http/reference/update-feature-flag.md) — PUT `/api/v1/feature-flags`
* [Search resources](https://docs.e6data.com/transformation/http/reference/search-resources.md) — GET `/api/v1/search/{kind}`

## Catalogs and tables

* [List catalogs](https://docs.e6data.com/transformation/http/reference/list-catalogs.md) — GET `/api/v1/catalogs`
* [Create catalog](https://docs.e6data.com/transformation/http/reference/create-catalog.md) — POST `/api/v1/catalogs`
* [Validate catalog connection](https://docs.e6data.com/transformation/http/reference/validate-catalog-connection.md) — POST `/api/v1/catalogs/validate`
* [Delete catalog](https://docs.e6data.com/transformation/http/reference/delete-catalog.md) — DELETE `/api/v1/catalogs/{catalog_id}`
* [Get catalog](https://docs.e6data.com/transformation/http/reference/get-catalog.md) — GET `/api/v1/catalogs/{catalog_id}`
* [Update catalog](https://docs.e6data.com/transformation/http/reference/update-catalog.md) — PATCH `/api/v1/catalogs/{catalog_id}`
* [Catalog capabilities](https://docs.e6data.com/transformation/http/reference/catalog-capabilities.md) — GET `/api/v1/catalogs/{catalog_id}/capabilities`
* [List namespaces](https://docs.e6data.com/transformation/http/reference/list-namespaces.md) — GET `/api/v1/catalogs/{catalog_id}/namespaces`
* [Patch catalog](https://docs.e6data.com/transformation/http/reference/patch-catalog.md) — PATCH `/api/v1/catalogs/{catalog_id}/options`
* [List relations](https://docs.e6data.com/transformation/http/reference/list-relations.md) — GET `/api/v1/catalogs/{catalog_id}/relations`
* [Get relation](https://docs.e6data.com/transformation/http/reference/get-relation.md) — GET `/api/v1/catalogs/{catalog_id}/relations/{name}`
* [Relation capabilities](https://docs.e6data.com/transformation/http/reference/relation-capabilities.md) — GET `/api/v1/catalogs/{catalog_id}/relations/{name}/capabilities`
* [Set table format version](https://docs.e6data.com/transformation/http/reference/set-table-format-version.md) — POST `/api/v1/catalogs/{catalog_id}/relations/{name}/format-version`
* [Set table sort order](https://docs.e6data.com/transformation/http/reference/set-table-sort-order.md) — POST `/api/v1/catalogs/{catalog_id}/relations/{name}/sort-order`
* [Search relations](https://docs.e6data.com/transformation/http/reference/search-relations.md) — GET `/api/v1/catalogs/{catalog_id}/search`
* [Register table](https://docs.e6data.com/transformation/http/reference/register-table.md) — POST `/api/v1/catalogs/{catalog_id}/tables/register`
* [Inspect table](https://docs.e6data.com/transformation/http/reference/inspect-table.md) — GET `/api/v1/catalogs/{catalog_id}/tables/{name}/inspection`
* [Rename view](https://docs.e6data.com/transformation/http/reference/rename-view.md) — POST `/api/v1/catalogs/{catalog_id}/views/{name}/rename`

## Dashboards

* [List dashboards](https://docs.e6data.com/transformation/http/reference/list-dashboards.md) — GET `/api/v1/dashboards`
* [Create dashboard](https://docs.e6data.com/transformation/http/reference/create-dashboard.md) — POST `/api/v1/dashboards`
* [Preview dashboard dataset](https://docs.e6data.com/transformation/http/reference/preview-dashboard-dataset.md) — POST `/api/v1/dashboards/preview`
* [Delete dashboard](https://docs.e6data.com/transformation/http/reference/delete-dashboard.md) — DELETE `/api/v1/dashboards/{dashboard_id}`
* [Get dashboard](https://docs.e6data.com/transformation/http/reference/get-dashboard.md) — GET `/api/v1/dashboards/{dashboard_id}`
* [Save dashboard](https://docs.e6data.com/transformation/http/reference/save-dashboard.md) — PUT `/api/v1/dashboards/{dashboard_id}`
* [Activate dashboard](https://docs.e6data.com/transformation/http/reference/activate-dashboard.md) — POST `/api/v1/dashboards/{dashboard_id}/activate`
* [Pause dashboard](https://docs.e6data.com/transformation/http/reference/pause-dashboard.md) — POST `/api/v1/dashboards/{dashboard_id}/pause`
* [Refresh dashboard](https://docs.e6data.com/transformation/http/reference/refresh-dashboard.md) — POST `/api/v1/dashboards/{dashboard_id}/refresh`
* [Resume dashboard](https://docs.e6data.com/transformation/http/reference/resume-dashboard.md) — POST `/api/v1/dashboards/{dashboard_id}/resume`
* [Dashboard history](https://docs.e6data.com/transformation/http/reference/dashboard-history.md) — GET `/api/v1/dashboards/{dashboard_id}/snapshots`
* [Dashboard snapshot](https://docs.e6data.com/transformation/http/reference/dashboard-snapshot.md) — GET `/api/v1/dashboards/{dashboard_id}/snapshots/{refresh_id}`
* [Cancel dashboard refresh](https://docs.e6data.com/transformation/http/reference/cancel-dashboard-refresh.md) — POST `/api/v1/dashboards/{dashboard_id}/snapshots/{refresh_id}/cancel`
* [Dashboard dataset results](https://docs.e6data.com/transformation/http/reference/dashboard-dataset-results.md) — GET `/api/v1/dashboards/{dashboard_id}/snapshots/{refresh_id}/datasets/{dataset_id}/results`

## Compute and workers

* [Execution options](https://docs.e6data.com/transformation/http/reference/execution-options.md) — GET `/api/v1/execution-options`
* [List workers](https://docs.e6data.com/transformation/http/reference/list-workers.md) — GET `/api/v1/workers`
* [Update worker admission](https://docs.e6data.com/transformation/http/reference/update-worker-admission.md) — POST `/api/v1/workers/admission`
* [Worker capacity](https://docs.e6data.com/transformation/http/reference/worker-capacity.md) — GET `/api/v1/workers/capacity`
* [Create deployment profile](https://docs.e6data.com/transformation/http/reference/create-deployment-profile.md) — POST `/api/v1/workers/profiles`
* [Delete deployment profile](https://docs.e6data.com/transformation/http/reference/delete-deployment-profile.md) — DELETE `/api/v1/workers/profiles/{name}`
* [Update deployment profile](https://docs.e6data.com/transformation/http/reference/update-deployment-profile.md) — PUT `/api/v1/workers/profiles/{name}`
* [Change deployment profile state](https://docs.e6data.com/transformation/http/reference/change-deployment-profile-state.md) — POST `/api/v1/workers/profiles/{name}/state`
* [Worker details](https://docs.e6data.com/transformation/http/reference/worker-details.md) — GET `/api/v1/workers/{allocation_id}`
* [Retire deployment worker](https://docs.e6data.com/transformation/http/reference/retire-deployment-worker.md) — POST `/api/v1/workers/{allocation_id}/retire`
* [Retry worker provisioning](https://docs.e6data.com/transformation/http/reference/retry-worker-provisioning.md) — POST `/api/v1/workers/{allocation_id}/retry-provisioning`
* [Worker tasks](https://docs.e6data.com/transformation/http/reference/worker-tasks.md) — GET `/api/v1/workers/{allocation_id}/tasks`

## Notebooks

* [List notebooks](https://docs.e6data.com/transformation/http/reference/list-notebooks.md) — GET `/api/v1/notebooks`
* [Create notebook](https://docs.e6data.com/transformation/http/reference/create-notebook.md) — POST `/api/v1/notebooks`
* [Import notebook](https://docs.e6data.com/transformation/http/reference/import-notebook.md) — POST `/api/v1/notebooks/import`
* [List notebook summaries](https://docs.e6data.com/transformation/http/reference/list-notebook-summaries.md) — GET `/api/v1/notebooks/summaries`
* [Delete notebook](https://docs.e6data.com/transformation/http/reference/delete-notebook.md) — DELETE `/api/v1/notebooks/{notebook_id}`
* [Get notebook](https://docs.e6data.com/transformation/http/reference/get-notebook.md) — GET `/api/v1/notebooks/{notebook_id}`
* [Save notebook](https://docs.e6data.com/transformation/http/reference/save-notebook.md) — PUT `/api/v1/notebooks/{notebook_id}`
* [Export notebook](https://docs.e6data.com/transformation/http/reference/export-notebook.md) — GET `/api/v1/notebooks/{notebook_id}/export`
* [Notebook revisions](https://docs.e6data.com/transformation/http/reference/notebook-revisions.md) — GET `/api/v1/notebooks/{notebook_id}/revisions`
* [Notebook revision](https://docs.e6data.com/transformation/http/reference/notebook-revision.md) — GET `/api/v1/notebooks/{notebook_id}/revisions/{revision}`
* [Notebook run summaries](https://docs.e6data.com/transformation/http/reference/notebook-run-summaries.md) — GET `/api/v1/notebooks/{notebook_id}/run-summaries`
* [List notebook runs](https://docs.e6data.com/transformation/http/reference/list-notebook-runs.md) — GET `/api/v1/notebooks/{notebook_id}/runs`
* [Submit notebook run](https://docs.e6data.com/transformation/http/reference/submit-notebook-run.md) — POST `/api/v1/notebooks/{notebook_id}/runs`
* [Get notebook run](https://docs.e6data.com/transformation/http/reference/get-notebook-run.md) — GET `/api/v1/notebooks/{notebook_id}/runs/{run_id}`
* [Notebook events](https://docs.e6data.com/transformation/http/reference/notebook-events.md) — GET `/api/v1/notebooks/{notebook_id}/runs/{run_id}/cells/{execution_id}/events`
* [Notebook outputs](https://docs.e6data.com/transformation/http/reference/notebook-outputs.md) — GET `/api/v1/notebooks/{notebook_id}/runs/{run_id}/cells/{execution_id}/outputs`

## Sessions and SQL

* [List notebook sessions](https://docs.e6data.com/transformation/http/reference/list-notebook-sessions.md) — GET `/api/v1/notebooks/{notebook_id}/sessions`
* [Open notebook session](https://docs.e6data.com/transformation/http/reference/open-notebook-session.md) — POST `/api/v1/notebooks/{notebook_id}/sessions`
* [Close notebook session](https://docs.e6data.com/transformation/http/reference/close-notebook-session.md) — DELETE `/api/v1/notebooks/{notebook_id}/sessions/{session_id}`
* [Get notebook session](https://docs.e6data.com/transformation/http/reference/get-notebook-session.md) — GET `/api/v1/notebooks/{notebook_id}/sessions/{session_id}`
* [Interrupt notebook session](https://docs.e6data.com/transformation/http/reference/interrupt-notebook-session.md) — POST `/api/v1/notebooks/{notebook_id}/sessions/{session_id}/interrupt`
* [List session summaries](https://docs.e6data.com/transformation/http/reference/list-session-summaries.md) — GET `/api/v1/sessions`
* [Open session](https://docs.e6data.com/transformation/http/reference/open-session.md) — POST `/api/v1/sessions`
* [Close session](https://docs.e6data.com/transformation/http/reference/close-session.md) — DELETE `/api/v1/sessions/{session_id}`
* [Read session](https://docs.e6data.com/transformation/http/reference/read-session.md) — GET `/api/v1/sessions/{session_id}`
* [Analyze](https://docs.e6data.com/transformation/http/reference/analyze.md) — POST `/api/v1/sessions/{session_id}/analyze`
* [Get config](https://docs.e6data.com/transformation/http/reference/get-config.md) — GET `/api/v1/sessions/{session_id}/config`
* [Set config](https://docs.e6data.com/transformation/http/reference/set-config.md) — PATCH `/api/v1/sessions/{session_id}/config`
* [Unset config](https://docs.e6data.com/transformation/http/reference/unset-config.md) — DELETE `/api/v1/sessions/{session_id}/config/{key}`
* [List operations](https://docs.e6data.com/transformation/http/reference/list-operations.md) — GET `/api/v1/sessions/{session_id}/operations`
* [Submit operation](https://docs.e6data.com/transformation/http/reference/submit-operation.md) — POST `/api/v1/sessions/{session_id}/operations`
* [Operation status](https://docs.e6data.com/transformation/http/reference/operation-status.md) — GET `/api/v1/sessions/{session_id}/operations/{operation_id}`
* [Operation attempts](https://docs.e6data.com/transformation/http/reference/operation-attempts.md) — GET `/api/v1/sessions/{session_id}/operations/{operation_id}/attempts`
* [Get operation attempt](https://docs.e6data.com/transformation/http/reference/get-operation-attempt.md) — GET `/api/v1/sessions/{session_id}/operations/{operation_id}/attempts/{attempt_id}`
* [Cancel operation](https://docs.e6data.com/transformation/http/reference/cancel-operation.md) — POST `/api/v1/sessions/{session_id}/operations/{operation_id}/cancel`
* [Operation results](https://docs.e6data.com/transformation/http/reference/operation-results.md) — GET `/api/v1/sessions/{session_id}/operations/{operation_id}/results`
* [Operation metadata](https://docs.e6data.com/transformation/http/reference/operation-metadata.md) — GET `/api/v1/sessions/{session_id}/operations/{operation_id}/results/metadata`
* [Operation xray](https://docs.e6data.com/transformation/http/reference/operation-xray.md) — GET `/api/v1/sessions/{session_id}/operations/{operation_id}/xray`
* [Session summary](https://docs.e6data.com/transformation/http/reference/session-summary.md) — GET `/api/v1/sessions/{session_id}/summary`

## Workloads

* [Global run summaries](https://docs.e6data.com/transformation/http/reference/global-run-summaries.md) — GET `/api/v1/runs`
* [List workloads](https://docs.e6data.com/transformation/http/reference/list-workloads.md) — GET `/api/v1/workloads`
* [Create workload](https://docs.e6data.com/transformation/http/reference/create-workload.md) — POST `/api/v1/workloads`
* [Validate workload](https://docs.e6data.com/transformation/http/reference/validate-workload.md) — POST `/api/v1/workloads/validate`
* [Delete workload](https://docs.e6data.com/transformation/http/reference/delete-workload.md) — DELETE `/api/v1/workloads/{workload_id}`
* [Get workload](https://docs.e6data.com/transformation/http/reference/get-workload.md) — GET `/api/v1/workloads/{workload_id}`
* [Update workload](https://docs.e6data.com/transformation/http/reference/update-workload.md) — PUT `/api/v1/workloads/{workload_id}`
* [List backfills](https://docs.e6data.com/transformation/http/reference/list-backfills.md) — GET `/api/v1/workloads/{workload_id}/backfills`
* [Create backfill](https://docs.e6data.com/transformation/http/reference/create-backfill.md) — POST `/api/v1/workloads/{workload_id}/backfills`
* [Preview backfill](https://docs.e6data.com/transformation/http/reference/preview-backfill.md) — POST `/api/v1/workloads/{workload_id}/backfills/preview`
* [Get backfill](https://docs.e6data.com/transformation/http/reference/get-backfill.md) — GET `/api/v1/workloads/{workload_id}/backfills/{backfill_id}`
* [Change backfill](https://docs.e6data.com/transformation/http/reference/change-backfill.md) — POST `/api/v1/workloads/{workload_id}/backfills/{backfill_id}`
* [Pause workload](https://docs.e6data.com/transformation/http/reference/pause-workload.md) — POST `/api/v1/workloads/{workload_id}/pause`
* [Resume workload](https://docs.e6data.com/transformation/http/reference/resume-workload.md) — POST `/api/v1/workloads/{workload_id}/resume`
* [Workload run summaries](https://docs.e6data.com/transformation/http/reference/workload-run-summaries.md) — GET `/api/v1/workloads/{workload_id}/run-summaries`
* [List runs](https://docs.e6data.com/transformation/http/reference/list-runs.md) — GET `/api/v1/workloads/{workload_id}/runs`
* [Start run](https://docs.e6data.com/transformation/http/reference/start-run.md) — POST `/api/v1/workloads/{workload_id}/runs`
* [Get run](https://docs.e6data.com/transformation/http/reference/get-run.md) — GET `/api/v1/workloads/{workload_id}/runs/{run_id}`
* [Cancel run](https://docs.e6data.com/transformation/http/reference/cancel-run.md) — POST `/api/v1/workloads/{workload_id}/runs/{run_id}/cancel`
* [Notification history](https://docs.e6data.com/transformation/http/reference/notification-history.md) — GET `/api/v1/workloads/{workload_id}/runs/{run_id}/notifications`
* [Retry notification](https://docs.e6data.com/transformation/http/reference/retry-notification.md) — POST `/api/v1/workloads/{workload_id}/runs/{run_id}/notifications/retry`
* [Run profile](https://docs.e6data.com/transformation/http/reference/run-profile.md) — GET `/api/v1/workloads/{workload_id}/runs/{run_id}/profile`
* [Compare run profiles](https://docs.e6data.com/transformation/http/reference/compare-run-profiles.md) — GET `/api/v1/workloads/{workload_id}/runs/{run_id}/profile/comparison`
* [Record profile evidence](https://docs.e6data.com/transformation/http/reference/record-profile-evidence.md) — PUT `/api/v1/workloads/{workload_id}/runs/{run_id}/profile/evidence`
* [Start rerun](https://docs.e6data.com/transformation/http/reference/start-rerun.md) — POST `/api/v1/workloads/{workload_id}/runs/{run_id}/rerun`
* [Preview rerun](https://docs.e6data.com/transformation/http/reference/preview-rerun.md) — POST `/api/v1/workloads/{workload_id}/runs/{run_id}/rerun/preview`
* [List tasks](https://docs.e6data.com/transformation/http/reference/list-tasks.md) — GET `/api/v1/workloads/{workload_id}/runs/{run_id}/tasks`
* [Get task](https://docs.e6data.com/transformation/http/reference/get-task.md) — GET `/api/v1/workloads/{workload_id}/runs/{run_id}/tasks/{task_id}`
* [List attempts](https://docs.e6data.com/transformation/http/reference/list-attempts.md) — GET `/api/v1/workloads/{workload_id}/runs/{run_id}/tasks/{task_id}/attempts`
* [Get attempt](https://docs.e6data.com/transformation/http/reference/get-attempt.md) — GET `/api/v1/workloads/{workload_id}/runs/{run_id}/tasks/{task_id}/attempts/{attempt_id}`
* [Task profile](https://docs.e6data.com/transformation/http/reference/task-profile.md) — GET `/api/v1/workloads/{workload_id}/runs/{run_id}/tasks/{task_id}/profile`
* [Task results](https://docs.e6data.com/transformation/http/reference/task-results.md) — GET `/api/v1/workloads/{workload_id}/runs/{run_id}/tasks/{task_id}/results`
* [Task metadata](https://docs.e6data.com/transformation/http/reference/task-metadata.md) — GET `/api/v1/workloads/{workload_id}/runs/{run_id}/tasks/{task_id}/results/metadata`

## Workspace documents

* [List workspace documents](https://docs.e6data.com/transformation/http/reference/list-workspace-documents.md) — GET `/api/v1/workspace/documents`
* [Create workspace document](https://docs.e6data.com/transformation/http/reference/create-workspace-document.md) — POST `/api/v1/workspace/documents`
* [Delete workspace document](https://docs.e6data.com/transformation/http/reference/delete-workspace-document.md) — DELETE `/api/v1/workspace/documents/{document_id}`
* [Get workspace document](https://docs.e6data.com/transformation/http/reference/get-workspace-document.md) — GET `/api/v1/workspace/documents/{document_id}`
* [Save workspace document](https://docs.e6data.com/transformation/http/reference/save-workspace-document.md) — PUT `/api/v1/workspace/documents/{document_id}`


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.