Skip to content
Nexa Platform Docs
Search
Ctrl
K
Cancel
GitHub
LinkedIn
Select theme
Dark
Light
Auto
Using the Platform
Deploy & Operate
Platform team
Developers & API
Internal Engineering
Internal
Overview
API Overview
Authentication
Core Concepts
SDKs & CLI
ACTG-AI Service
Databricks Platform API
Overview
Authentication
Generate OAuth Access Token
POST
Get Authentication Status
GET
Debug Configuration
GET
Application Management
List apps
GET
Apps API Health Check
GET
Get an app
GET
Delete an app
DELETE
Update an app
PATCH
List app deployments
GET
Create an app deployment
POST
Get an app deployment
GET
Start an app
POST
Stop an app
POST
Get app permissions
GET
Set app permissions
PUT
Update app permissions
PATCH
Deploy an app and wait
POST
Start an app and wait
POST
Deployments
Finish Deployment
POST
Get Deployment Status
GET
Start Deployment
POST
Get Deployment
GET
Get Environment Resources
GET
Submit Deployment
POST
Data Catalog & Metadata
List Databricks catalogs
GET
List schemas in catalog
GET
List tables in schema
GET
Get table details
GET
Execute SQL statement
POST
Get complete catalog metadata (cached)
GET
Get metadata sync status
GET
Test catalog fetch
GET
Trigger metadata sync
POST
Health check
GET
Environment Management
List environments
GET
Create environment
POST
Get environment
GET
Delete environment
DELETE
Update environment
PATCH
Job Orchestration & Scheduling
List and filter jobs
GET
Create a job
POST
Get job details
GET
Delete a job
DELETE
Update a job
PATCH
Run job now
POST
Trigger a job run
POST
Submit a one-time run
POST
Cancel a job run
POST
Run job now and wait
POST
Submit a one-time run and wait
POST
Repair a failed run and wait
POST
Pause a job (disable schedule)
POST
Resume a paused job
POST
Sync Nexa-managed jobs
POST
Data Pipeline Management
List Pipelines
GET
Create Pipeline
POST
Get Pipeline
GET
Update Pipeline
PATCH
Start Pipeline Update
POST
Stop Pipeline
POST
Stop Pipeline And Wait
POST
Wait Until Pipeline Idle
GET
Sync Nexa-managed pipelines
POST
Data Lineage
Get Table Lineage
GET
Get Column Lineage
GET
Get Lineage Graph
GET
Execute Lineage System Query
POST
Analyze Column Impact
POST
Get lineage summary for all tables in a schema
GET
Get Table Popularity
GET
Get Lineage Service Health
GET
Trigger Lineage Sync
POST
Connector Management
List Connectors
GET
Create Connector
POST
Get Connector
GET
Delete Connector
DELETE
Reset Connector State
POST
Activate Connector
POST
Pause Connector
POST
Trigger Run
POST
Cancel Run
POST
Sync Connector Secrets
POST
secrets
Sync Secret
POST
Observability
Jobs overview
GET
Sync job runs
POST
Sync pipeline updates
POST
List job runs
GET
Get run details
GET
Get run output
GET
Get task output
GET
Export run view
GET
Pipeline metrics
GET
Pipelines overview
GET
List pipeline updates
GET
Get pipeline update
GET
List pipeline events
GET
Sync daily usage
POST
List daily usage
GET
Connectors overview
GET
Sync connector runs
POST
Search connector runs
GET
Get connector job run
GET
Get connector job run output
GET
Get connector task output
GET
Export connector run view
GET
Connector job monitoring
GET
Job monitoring
GET
Compute Warehouse Management
List SQL warehouses
GET
Get warehouse status
GET
Start SQL warehouse
POST
Stop SQL warehouse
POST
Health check
GET
Workspace Management
Get workspace object status
GET
List workspace objects
GET
Create workspace directories
POST
Delete workspace objects
POST
Export workspace object
GET
Import workspace object
POST
Health check
GET
SQL Statement Execution
Execute SQL statement
POST
Get statement status
GET
Cancel statement
POST
Get statement result chunk
GET
Health check
GET
Get executed queries with time taken
GET
Get top active users by query count
GET
Debug query history - check what's available
GET
Trigger query history sync
POST
Unity Catalog Tags & Governance
List governed tags (tag policies)
GET
Get specific tag policy
GET
Delete a tag policy
DELETE
Update a tag policy
PATCH
Create a tag policy
POST
Apply a governed tag to an object
POST
Remove a governed tag from an object
DELETE
List tags applied to an object
GET
Identity & Access Management
List all users in the workspace
GET
Get user details
GET
List all groups in the workspace
GET
Get group details
GET
List all service principals in the workspace
GET
Get service principal details
GET
Trigger on-demand IAM sync
POST
codegen
Generate Curated
POST
Generate Consumption
POST
Generate Connector
POST
Generate Projection
POST
Alter Metadata
POST
Alter Ddl
POST
Delete Entity
POST
Generate Curated Files
POST
Download File
GET
Generate Consumption Files
POST
Generate Connector Files
POST
Generate Projection Files
POST
Health Check
GET
System Events
Acknowledge Event Batch
POST
Operations
Health Check
GET
Background Sync Status
GET
Pipeline Sync Status
GET
App Info
GET
Snowflake API
Overview
Health
Health Check
GET
Root
Root
GET
Authentication
Create Token
POST
Test Snowflake Connection
POST
Verify Token
GET
Catalog
List Databases
GET
Trigger Catalog Sync
POST
Catalog Sync Status
GET
List Schemas
GET
List Tables
GET
Get Table Details
GET
List Views
GET
Warehouses
List Warehouses
GET
Get Warehouse Status
GET
Start Warehouse
POST
Stop Warehouse
POST
Resize Warehouse
POST
Tasks
List Tasks
GET
Get Task
GET
Delete Task
DELETE
Create Task
POST
Resume Task
POST
Suspend Task
POST
Execute Task
POST
Get Task History
GET
Pipelines
List Streams
GET
Get Stream
GET
Delete Stream
DELETE
Create Stream
POST
List Dynamic Tables
GET
Get Dynamic Table
GET
Delete Dynamic Table
DELETE
Create Dynamic Table
POST
Refresh Dynamic Table
POST
Usage & Costs
Get Warehouse Metering
GET
Get Service Metering
GET
Get Query History
GET
Get Warehouse Idle Costs
GET
Get Cost Summary
GET
Get Usage By Category
GET
Get Top Consumers
GET
Data Lineage
Get Table Lineage
GET
Get Column Lineage
GET
Get Lineage Graph
GET
Get Table Popularity
GET
Check Lineage Health
GET
Permissions
List Grants
GET
Grant Privilege
POST
Revoke Privilege
POST
List Roles
GET
Create Role
POST
Grant Role
POST
Revoke Role
POST
Get Role Hierarchy
GET
List Users
GET
Create User
POST
Deployments
List Git Repositories
GET
Create Git Repository
POST
Fetch Git Repository
POST
Get Git Branches
GET
Execute File
POST
Execute Files Batch
POST
List Repository Files
GET
List Deployments
GET
Create Deployment
POST
Get Deployment
GET
Resume Deployment
POST
Code Generation
Generate Projection
POST
Generate Curated
POST
Generate Consumption
POST
Generate Declarative
POST
Generate Connector
POST
Generate Ddl
POST
Alter Metadata
POST
Governance & Tags
List Tags
GET
Get Tag Details
GET
Apply Tag
POST
Remove Tag
POST
Observability
List Task Failures
GET
List Task Schedules
GET
List Task Lag
GET
List Task Runs
GET
List Stale Streams
GET
Get Stream Status
GET
List Dynamic Table Refresh Status
GET
List Dynamic Table Refresh History
GET
Trigger Task Runs Sync
POST
Trigger Dynamic Table Refresh Sync
POST
Connector Management
List Connectors
GET
Create Connector
POST
Get Connector
GET
Delete Connector
DELETE
Activate Connector
POST
Pause Connector
POST
System Events
Acknowledge Event Batch
POST
Code Generation V2
Generate Curated
POST
Agents API
Overview
Authentication
Generate API Token
POST
Get Authentication Status
GET
Debug Configuration
GET
Health
Healthcheck
GET
Health Details
GET
Agent Admin
List Agents
GET
Get Agent Status
GET
Get Agent Workflow Run
GET
Get Agent State
GET
Get Agent Artifact Files
GET
Get Agent Dependencies
GET
Delete Agent By Name
POST
Tool Search
POST
Resolve Tools
POST
Get Top Active Agents
GET
Start Agent
POST
Stop Agent
POST
Retry Component
POST
Get Models
GET
Agent Setup
Validate Agent
POST
Validation Status
GET
Generate Agent Artifacts
POST
Deploy Agent
POST
Commit And Deploy Agent
POST
Apps
List Apps
GET
Start App
POST
Stop App
POST
Get App Status
POST
Automations
List Automations
GET
Plan Automation
POST
Validate Automation Artifacts
POST
Commit And Deploy Automation
POST
Get Automation State
GET
Get Automation Artifact Files
GET
Control Automation Schedule
POST
Trigger Automation Run
POST
Promote Automation
POST
Delete Automation
POST
Automation Details
GET
Automation Workflow Run
GET
Automation Run Output
GET
Automation Task Output
GET
List Automation Deployments
GET
Get Automation Deployment
GET
List Automation Plans
GET
Sync Automation Release
POST
Bind Automation Slack Channel
POST
Unbind Automation Slack Channel
POST
Post Automation Slack Message
POST
List Available Slack Channels
GET
Validate Query
POST
Get Channel Members
POST
List Document Templates
GET
Generate Typst
POST
Suggest Tools Endpoint
POST
Typst Status Endpoint
GET
Internal Callbacks
Deployment Callback
POST
Internal Templates
Sync Template To Git
POST
Get Template From Git
GET
Promote Template
POST
Lifecycle
Promote
POST
Remove
POST
Sync Platform State
POST
Slack
Enable Slack
POST
Disable Slack
POST
Sync Slack Release
POST
List Slack Bindings
GET
Legacy Agent API
Healthcheck
GET
Health Details
GET
GitHub
LinkedIn
Select theme
Dark
Light
Auto
Overview
nexa-agents-api
0.1.0
Section titled “nexa-agents-api 0.1.0”
Information
OpenAPI version:
3.1.0
Operations
Section titled “Operations”
POST
/api/v1/auth/token
GET
/api/v1/auth/status
GET
/api/v1/auth/debug
GET
/api/v1/health
GET
/api/v1/health/details
GET
/api/agents/list
GET
/api/agents/status
GET
/api/agents/workflow-runs/{run_id}
GET
/api/agents/{agent_name}/{version}/state
GET
/api/agents/{agent_name}/{version}/artifact-files
GET
/api/agents/{agent_name}/{version}/dependencies
POST
/api/agents/{agent_name}/{version}/delete
POST
/api/agents/tool-search
POST
/api/agents/resolve-tools
GET
/api/agents/top_active_agents
POST
/api/agents/start
POST
/api/agents/stop
POST
/api/agents/retry-component
GET
/api/agents/get_models
POST
/api/agents/validate
GET
/api/agents/validate/{run_id}
POST
/api/agents/generate
POST
/api/agents/deploy
POST
/api/agents/{agent_name}/{version}/commit-and-deploy
GET
/api/apps/list
POST
/api/apps/start
POST
/api/apps/stop
POST
/api/apps/status
GET
/api/automations/list
POST
/api/automations/{automation_alias}/plan
POST
/api/automations/{automation_alias}/validate-artifacts
POST
/api/automations/{automation_alias}/commit-and-deploy
GET
/api/automations/{automation_alias}/state
GET
/api/automations/{automation_alias}/artifact-files
POST
/api/automations/{automation_alias}/schedule/{action}
POST
/api/automations/{automation_alias}/run-now
POST
/api/automations/{automation_alias}/promote
POST
/api/automations/{automation_alias}/delete
GET
/api/automations/{automation_alias}/details
GET
/api/automations/workflow-runs/{run_id}
GET
/api/automations/{automation_alias}/runs/{run_id}/output
GET
/api/automations/{automation_alias}/runs/{run_id}/tasks/{task_run_id}/output
GET
/api/automations/{automation_alias}/deployments
GET
/api/automations/{automation_alias}/deployments/{deployment_id}
GET
/api/automations/{automation_alias}/plans
POST
/api/automations/sync-release
POST
/api/automations/slack/bind
POST
/api/automations/slack/unbind
POST
/api/automations/slack/post
GET
/api/automations/slack/available-channels
POST
/api/automations/validate_query
POST
/api/automations/slack/channel-members
GET
/api/automations/document-templates
POST
/api/automations/generate_typst_content
POST
/api/automations/suggest-tools
GET
/api/automations/typst-streaming-status
POST
/api/internal/agents/deployment-callback
POST
/api/internal/templates/sync-to-git
GET
/api/internal/templates/{slug}/from-git
POST
/api/internal/templates/promote
POST
/api/agents/{agent_alias}/promote
POST
/api/agents/{agent_alias}/remove
POST
/api/agents/releases/sync-platform-state
POST
/api/agents/slack/enable
POST
/api/agents/slack/disable
POST
/api/agents/slack/sync-release
GET
/api/agents/slack/bindings
GET
/api/healthcheck
GET
/api/health/details
Authentication
Section titled “Authentication”
HTTPBearer
Section titled “HTTPBearer”
Security scheme type:
http