Skip to content
Docs/API reference

Endpoint directory

Find every customer API operation and its integration guide. Paths are relative to your configured API base URL.

On this pageAi StudioNotificationsAuthApprovalsFlowsWorkspaceExecutionRunsBilling UsageLineage CatalogCloud ConnectionsIntegrationsFlow BuilderDep PackagesEnvironmentsOverviewCustom NodesData QualitySchedulesSecretsEvents

This directory is generated from the application. Read authentication for route-specific permissions and OpenAPI for the downloadable contract. A listed operation can depend on a capability being enabled in your deployment.

Request and response model links open the schema reference. A generic object model is not an unrestricted payload: its linked guide documents the fields validated by the handler. The success status below comes from the declared schema; guides describe additional runtime and error responses.

Ai Studio

Read the ai studio guide.

Method and pathQuery parametersRequest bodySuccess response
POST /ai-studio/sessionsNoneobject200: object
GET /ai-studio/sessionslimit; default 25; status; default "active"None200: object
GET /ai-studio/sessions/by-flow/{flow_name}NoneNone200: object
GET /ai-studio/sessions/{session_id}NoneNone200: object
DELETE /ai-studio/sessions/{session_id}NoneNone200: object
POST /ai-studio/sessions/{session_id}/archiveNoneNone200: object
POST /ai-studio/sessions/{session_id}/attachments/completeNoneobject200: object
POST /ai-studio/sessions/{session_id}/attachments/initiateNoneobject200: object
DELETE /ai-studio/sessions/{session_id}/attachments/{attachment_id}NoneNone200: object
POST /ai-studio/sessions/{session_id}/bind-flowNoneobject200: object
PATCH /ai-studio/sessions/{session_id}/canvasNoneobject200: object
POST /ai-studio/sessions/{session_id}/messagesNoneobject200: object
POST /ai-studio/sessions/{session_id}/messages/streamNoneobject200: any
PATCH /ai-studio/sessions/{session_id}/tierNoneobject200: object
PATCH /ai-studio/sessions/{session_id}/titleNoneobject200: object
GET /ai-studio/tiersNoneNone200: object

Notifications

Read the notifications guide.

Method and pathQuery parametersRequest bodySuccess response
POST /alert-rulesNoneAlertRuleCreateRequest201: AlertRuleResponse
GET /alert-ruleslimit; default 100None200: AlertRuleListResponse
GET /alert-rules/{rule_id}NoneNone200: AlertRuleResponse
DELETE /alert-rules/{rule_id}NoneNone200: any
POST /alert-rules/{rule_id}/testNoneNone200: any
POST /channelsNoneChannelCreateRequest201: ChannelResponse
GET /channelslimit; default 100None200: ChannelListResponse
GET /channels/{channel_id}NoneNone200: ChannelResponse
DELETE /channels/{channel_id}NoneNone200: any

Auth

Read the auth guide.

Method and pathQuery parametersRequest bodySuccess response
GET /api-keysNoneNone200: ApiKeyListResponse
POST /api-keysNoneApiKeyCreateRequest200: ApiKeyCreateResponse
DELETE /api-keys/{key_id}NoneNone200: object of string
POST /auth/device/approveNoneDeviceAuthorizationApproveRequest200: DeviceAuthorizationApproveResponse
POST /auth/device/startNoneNone200: DeviceAuthorizationStartResponse
POST /auth/device/tokenNoneDeviceAuthorizationTokenRequest200: DeviceAuthorizationTokenResponse
POST /auth/loginNoneLoginRequest200: LoginResponse
POST /auth/logoutNoneNone200: LogoutResponse
GET /meNoneNone200: object
GET /users/meNoneNone200: CurrentUserResponse

Approvals

Read the approvals guide.

Method and pathQuery parametersRequest bodySuccess response
GET /approvalsstatus; limit; default 100None200: object
GET /approvals/{approval_id}NoneNone200: object
POST /approvals/{approval_id}/approveNoneDecisionRequest or null200: object
POST /approvals/{approval_id}/rejectNoneDecisionRequest or null200: object

Flows

Read the flows guide.

Method and pathQuery parametersRequest bodySuccess response
POST /artifacts/abortNoneAbortUploadRequest204: any
POST /artifacts/completeNoneCompleteUploadRequest200: CompleteUploadResponse
POST /artifacts/initiateNoneInitiateUploadRequest200: InitiateUploadResponse
POST /deploymentsNoneDeploymentRequest200: DeploymentResponse
GET /deploymentsenvironment; limit; default 100None200: DeploymentListResponse
DELETE /deployments/{deployment_name}NoneNone200: object of string
GET /deployments/{deployment_name}NoneNone200: DeploymentListItem
PATCH /deployments/{deployment_name}NoneChangeVersionRequest200: DeploymentListItem
POST /deployments/{deployment_name}/rollbackNoneRollbackRequest200: RollbackResponse
PUT /deployments/{deployment_name}/settingsNoneUpdateDeploymentSettingsRequest200: DeploymentListItem
POST /flowsNoneFlowRegisterRequest200: FlowRegisterResponse
GET /flowslimit; default 100; next_token; environmentNone200: FlowListResponse
DELETE /flows/{flow_name}NoneNone200: object
POST /flows/{flow_name}/draftNoneNone200: object
GET /flows/{flow_name}/draft/sourceNoneNone200: object
PUT /flows/{flow_name}/draft/sourceNoneobject200: object
GET /flows/{flow_name}/latestNoneNone200: FlowDetailResponse
GET /flows/{flow_name}/versionsNoneNone200: FlowVersionListResponse
GET /flows/{flow_name}/{flow_version}NoneNone200: FlowDetailResponse

Workspace

Read the workspace guide.

Method and pathQuery parametersRequest bodySuccess response
GET /audit-logsresource_type; action; actor_email; start_date; end_date; limit; default 50None200: AuditLogListResponse
GET /audit-logs/resource/{resource_type}/{resource_id}limit; default 50None200: AuditLogListResponse
GET /orgsNoneNone200: object
POST /orgsNoneOrgCreateRequest200: OrgResponse
POST /orgs/{org_id}/membersNoneobject200: object
GET /orgs/{org_id}/membersNoneNone200: object
PATCH /orgs/{org_id}/members/{email}/roleNoneUpdateMemberRoleRequest200: MemberResponse
GET /orgs/{org_id}/rolesNoneNone200: RolePermissionsResponse

Execution

Read the execution guide.

Method and pathQuery parametersRequest bodySuccess response
GET /backendsNoneNone200: object

Runs

Read the runs guide.

Method and pathQuery parametersRequest bodySuccess response
GET /backfillslimit; default 50None200: BackfillListResponse
GET /backfills/{backfill_id}NoneNone200: BackfillResponse
POST /backfills/{backfill_id}/cancelNoneNone200: BackfillResponse
POST /flows/{flow_name}/backfillNoneBackfillRequest200: BackfillResponse
POST /runsNoneRunRequest200: RunResponse
GET /runsflow_name; limit; since; environmentNone200: object
GET /runs/comparerun_a (required); run_b (required)None200: object
GET /runs/{run_id}NoneNone200: object
POST /runs/{run_id}/cancelNoneNone200: object
GET /runs/{run_id}/logsnext_token; limit; default 500None200: object
POST /runs/{run_id}/retryNoneNone200: RetryResponse
POST /runs/{run_id}/retry-from-failedNoneNone200: RetryResponse

Billing Usage

Read the billing usage guide.

Method and pathQuery parametersRequest bodySuccess response
GET /billing/plansNoneNone200: object
GET /billing/subscriptionNoneNone200: SubscriptionResponse
GET /usage/costsstart_date (required); end_date (required)None200: object
GET /usage/dashboarddays; default 30None200: UsageDashboardResponse
GET /usage/quotaNoneNone200: QuotaStatusResponse
GET /usage/summaryNoneNone200: UsageSummaryResponse
GET /usage/timeseriesstart_date (required); end_date (required)None200: UsageTimeseriesResponse

Lineage Catalog

Read the lineage catalog guide.

Method and pathQuery parametersRequest bodySuccess response
GET /catalog/datasetsnamespace; owner; tag; limit; default 200None200: object
POST /catalog/datasetsNoneDatasetCreateRequest201: object
GET /catalog/datasets/{dataset_key}NoneNone200: object
PUT /catalog/datasets/{dataset_key}NoneDatasetUpdateRequest200: object
DELETE /catalog/datasets/{dataset_key}NoneNone204: any
GET /catalog/searchq; default ""; limit; default 50None200: object
GET /lineage/assetssearch; limit; default 200None200: object
GET /lineage/assets/{asset_key}/graphdepth; default 3; direction; default "both"None200: object
GET /lineage/runs/{run_id}NoneNone200: object

Cloud Connections

Read the cloud connections guide.

Method and pathQuery parametersRequest bodySuccess response
GET /cloud-connectionsprovider; statusNone200: object
POST /cloud-connectionsNoneCloudConnectionCreateRequest201: object
GET /cloud-connections/provider; statusNone200: object
POST /cloud-connections/NoneCloudConnectionCreateRequest201: object
GET /cloud-connections/metaNoneNone200: object
GET /cloud-connections/providersNoneNone200: object
GET /cloud-connections/{connection_id}NoneNone200: object
PATCH /cloud-connections/{connection_id}NoneCloudConnectionUpdateRequest200: object
DELETE /cloud-connections/{connection_id}NoneNone204: any
POST /cloud-connections/{connection_id}/aws/registerNoneAwsRegisterRequest200: object
PUT /cloud-connections/{connection_id}/bindingsNoneBindingSpec200: object
POST /cloud-connections/{connection_id}/claims/releaseNoneReleaseClaimRequest200: object
POST /cloud-connections/{connection_id}/disableNoneNone200: object
POST /cloud-connections/{connection_id}/enableNoneNone200: object
POST /cloud-connections/{connection_id}/external-id/rotateNoneNone200: object
POST /cloud-connections/{connection_id}/gcp/registerNoneGcpRegisterRequest200: object
GET /cloud-connections/{connection_id}/setuprotate; default falseNone200: object
GET /cloud-connections/{connection_id}/verificationNoneNone200: object
POST /cloud-connections/{connection_id}/verifyinline; default falseNone202: object

Integrations

Read the integrations guide.

Method and pathQuery parametersRequest bodySuccess response
GET /connectors/connector_type_id; enabledNone200: object
POST /connectors/NoneConnectorCreateRequest201: object
POST /connectors/discover/s3-bucketsNoneDiscoverS3BucketsRequest200: object
GET /connectors/{connector_id}NoneNone200: object
PUT /connectors/{connector_id}NoneConnectorUpdateRequest200: object
DELETE /connectors/{connector_id}NoneNone200: any
POST /connectors/{connector_id}/testNoneNone200: object

Flow Builder

Read the flow builder guide.

Method and pathQuery parametersRequest bodySuccess response
GET /dag-draftsNoneNone200: DagDraftListResponse
POST /dag-draftsNoneDagDraftCreateRequest200: DagDraftResponse
GET /dag-drafts/{draft_id}NoneNone200: DagDraftResponse
PUT /dag-drafts/{draft_id}NoneDagDraftUpdateRequest200: DagDraftResponse
DELETE /dag-drafts/{draft_id}NoneNone200: any

Dep Packages

Read the dep packages guide.

Method and pathQuery parametersRequest bodySuccess response
POST /dep-packagesNoneDepPackageCreateRequest201: DepPackageResponse
GET /dep-packageslimit; default 50None200: DepPackageListResponse
GET /dep-packages/by-slug/{slug}NoneNone200: DepPackageResponse
GET /dep-packages/pypi/searchq; default ""None200: PyPISearchResponse
GET /dep-packages/{package_id}NoneNone200: DepPackageResponse
PATCH /dep-packages/{package_id}NoneDepPackageUpdateRequest200: DepPackageResponse
DELETE /dep-packages/{package_id}NoneNone200: any
POST /dep-packages/{package_id}/buildNoneNone202: any
GET /dep-packages/{package_id}/downloadNoneNone200: any
GET /dep-packages/{package_id}/logsnext_token; default ""None200: any
POST /dep-packages/{package_id}/validateNoneNone200: any

Environments

Read the environments guide.

Method and pathQuery parametersRequest bodySuccess response
POST /environmentsNoneEnvironmentCreateRequest201: EnvironmentResponse
GET /environmentslimit; default 50None200: EnvironmentListResponse
POST /environments/promoteNoneobject201: any
PUT /environments/reorderNoneEnvironmentReorderRequest200: EnvironmentListResponse
GET /environments/{env_name}NoneNone200: EnvironmentResponse
PATCH /environments/{env_name}NoneEnvironmentUpdateRequest200: EnvironmentResponse
DELETE /environments/{env_name}NoneNone200: any
GET /environments/{env_name}/diff/{target_env}NoneNone200: object
GET /environments/{env_name}/variablesNoneNone200: object
PUT /environments/{env_name}/variablesNoneobject200: object
PATCH /environments/{env_name}/variablesNoneobject200: object
DELETE /environments/{env_name}/variables/{var_key}NoneNone200: object
POST /environments/{env_name}/variables/{var_key}/toggleNoneobject200: object

Overview

Read the overview guide.

Method and pathQuery parametersRequest bodySuccess response
GET /healthNoneNone200: HealthCheckResponse

Custom Nodes

Read the custom nodes guide.

Method and pathQuery parametersRequest bodySuccess response
GET /nodes/registrycategory; search; offset; default 0; limit; default 100None200: object
POST /nodes/registryNoneRegisterNodeRequest201: any
GET /nodes/registry/builtinNoneNone200: any
GET /nodes/registry/builtin/{node_type}/sourceNoneNone200: any
GET /nodes/registry/categoriesNoneNone200: any
GET /nodes/registry/customNoneNone200: any
GET /nodes/registry/searchq (required)None200: any
GET /nodes/registry/{node_type}NoneNone200: any
PUT /nodes/registry/{node_type}NoneUpdateNodeRequest200: any
DELETE /nodes/registry/{node_type}NoneNone204: any
GET /nodes/type-compatibilityNoneNone200: any
POST /nodes/validate-connectionNoneValidateConnectionRequest200: ValidateConnectionResponse

Data Quality

Read the data quality guide.

Method and pathQuery parametersRequest bodySuccess response
GET /quality/catalogNoneNone200: any
GET /quality/checksNoneNone200: any
GET /quality/runs/{run_id}NoneNone200: any
GET /quality/summaryflow_name (required); windowNone200: any

Schedules

Read the schedules guide.

Method and pathQuery parametersRequest bodySuccess response
POST /schedulesNoneScheduleRequest200: ScheduleResponse
GET /schedulesflow_name; mode; enabled; limit; default 100None200: ScheduleListResponse
GET /schedules/{schedule_id}NoneNone200: ScheduleResponse
PATCH /schedules/{schedule_id}NoneSchedulePatchRequest200: ScheduleResponse
POST /schedules/{schedule_id}/triggerNoneScheduleTriggerRequest200: RunResponse

Secrets

Read the secrets guide.

Method and pathQuery parametersRequest bodySuccess response
POST /secretsNoneSecretCreateRequest201: SecretResponse
GET /secretsenvironment; limit; default 100None200: SecretListResponse
POST /secrets/copyNoneSecretCopyRequest201: SecretResponse
GET /secrets/{secret_name}NoneNone200: SecretResponse
PUT /secrets/{secret_name}NoneSecretUpdateRequest200: SecretResponse
PATCH /secrets/{secret_name}NoneSecretMetadataPatchRequest200: SecretResponse
DELETE /secrets/{secret_name}NoneNone200: any
GET /secrets/{secret_name}/valueNoneNone200: SecretValueResponse

Events

Read the events guide.

Method and pathQuery parametersRequest bodySuccess response
POST /sensorsNoneSensorCreateRequest201: SensorResponse
GET /sensorslimit; default 100None200: SensorListResponse
GET /sensors/{sensor_id}NoneNone200: SensorResponse
DELETE /sensors/{sensor_id}NoneNone200: any
POST /sensors/{sensor_id}/testNoneNone200: any
POST /webhooks/{token}NoneNone200: any