Skip to main content

​
Files & jobs

MethodEndpointDescriptionAuth
POST/jobsCreate a new jobJWT
POST/jobs/sampleCreate sample job with pre-seeded resultsJWT
POST/jobs/{job_id}/startStart job after files uploadedJWT
GET/jobsList all jobs (paginated, filterable)JWT
GET/jobs/{job_id}Get job details with progressJWT
GET/jobs/{job_id}/cost-estimateEstimate processing costJWT
GET/jobs/compareCompare two jobs side-by-sideJWT
POST/jobs/{job_id}/files/presigned-urlGet S3 presigned URL for uploadJWT
GET/jobs/{job_id}/filesList files in a jobJWT
DELETE/jobs/{job_id}/files/{file_id}Delete a fileJWT
POST/jobs/{job_id}/files/bulk-uploadBulk upload filesJWT
POST/files/prescanValidate headers for prohibited contentNone

​
Results & analysis

MethodEndpointDescriptionAuth
GET/jobs/{job_id}/resultsClassification and quality resultsJWT
PATCH/jobs/{job_id}/columns/{column_name}Correct column classificationJWT
GET/jobs/{job_id}/files/{file_id}/schemaInferred file schemaJWT
GET/jobs/{job_id}/files/{file_id}/profileData profiling analysisJWT
GET/jobs/{job_id}/files/{file_id}/driftDrift detectionJWT
GET/jobs/{job_id}/files/{file_id}/anomaliesAnomaly detectionJWT
POST/jobs/{job_id}/files/{file_id}/diffData diffing between filesJWT

​
AI readiness & assessment

MethodEndpointDescriptionAuth
GET/files/{file_id}/ai-readinessAI readiness score for fileJWT
GET/ai-readiness/orgOrg-level aggregate AI readinessJWT
GET/ai-readiness/history/{file_id}Historical score trendsJWT
GET/files/{file_id}/fix-prioritiesPrioritized fix actions with ROIJWT
GET/files/{file_id}/fix-waterfallCumulative score improvement waterfallJWT
GET/files/{file_id}/usecase-readinessReadiness for all 8 ML use casesJWT
GET/files/{file_id}/usecase-readiness/{usecase}Readiness for specific use caseJWT
GET/usecase-readiness/availableList available ML use casesJWT
POST/files/{file_id}/ai-readiness/assessGenerate assessment report (requires 75+)JWT
GET/ai-readiness/certificatesList org assessment reportsJWT
GET/certificates/{certificate_id}/verifyPublic report verificationNone

​
Remediation & corrections

MethodEndpointDescriptionAuth
GET/files/{file_id}/remediation/planGenerate remediation plan (preview)JWT
POST/files/{file_id}/remediation/applyApply selected fixesJWT
POST/jobs/{job_id}/apply-correctionsCreate correction jobJWT
GET/corrections/{id}/statusCorrection job statusJWT
GET/corrections/{id}/downloadDownload corrected fileJWT
GET/correction-pipelinesList correction pipelinesJWT
GET/correction-pipelines/{id}Pipeline details with stepsJWT
POST/correction-pipelines/{id}/previewPreview pipeline executionJWT
POST/correction-pipelines/{id}/approveApprove pipelineJWT
POST/correction-pipelines/{id}/rejectReject pipelineJWT
POST/correction-pipelines/{id}/exportExport corrected fileJWT

​
Data sources & integrations

MethodEndpointDescriptionAuth
POST/sources/test-connectionTest data source connectionJWT
POST/sourcesCreate data source (PostgreSQL, BigQuery, Snowflake, S3)JWT
GET/sourcesList all data sourcesJWT
GET/sources/{id}Get data source detailsJWT
PATCH/sources/{id}Update data sourceJWT
DELETE/sources/{id}Delete data sourceAdmin
POST/sources/{id}/tablesScan tables from sourceJWT
PATCH/sources/{id}/tables/{table}Update table settingsJWT
GET/sources/{id}/scan-scheduleGet scheduled scansJWT
POST/sources/{id}/scan-scheduleCreate scheduled scanJWT

​
Data contracts

MethodEndpointDescriptionAuth
POST/contractsCreate data contractAdmin
GET/contractsList data contractsJWT
GET/contracts/{id}Contract details with rulesJWT
PATCH/contracts/{id}Update contractAdmin
DELETE/contracts/{id}Delete contractAdmin
POST/contracts/{id}/rulesAdd rule to contractAdmin
DELETE/contracts/{id}/rules/{rule_id}Delete contract ruleAdmin
GET/contracts/{id}/violationsList violations (paginated)JWT
POST/contracts/{id}/evaluateEvaluate contract against dataJWT

​
Knowledge graph & lineage

MethodEndpointDescriptionAuth
GET/knowledge-graph/entitiesList all entitiesJWT
GET/knowledge-graph/entities/{id}Entity detail with quality historyJWT
GET/knowledge-graph/relationshipsList all relationshipsJWT
GET/knowledge-graph/relationships/{id}Relationship detailJWT
POST/lineage/nodesCreate lineage nodeAdmin
GET/lineage/nodesList lineage nodesJWT
GET/lineage/nodes/{id}Lineage node detailJWT
PATCH/lineage/nodes/{id}Update lineage nodeAdmin
DELETE/lineage/nodes/{id}Delete lineage nodeAdmin
POST/lineage/edgesCreate lineage edgeAdmin
GET/lineage/edgesList lineage edgesJWT
GET/lineage/graphFull lineage graphJWT
GET/lineage/impact/{node_id}Impact analysis for nodeJWT

​
Reports

MethodEndpointDescriptionAuth
POST/reports/generateGenerate PDF report (async, 5 credits)JWT
GET/reportsList reports (paginated)JWT
GET/reports/{id}Report status + download URLJWT
GET/reports/{id}/downloadDownload reportJWT
GET/reports/schedulesList scheduled reportsAdmin
POST/reports/schedulesCreate scheduled reportAdmin
PATCH/reports/schedules/{id}Update scheduled reportAdmin
DELETE/reports/schedules/{id}Delete scheduled reportAdmin

​
Alerts & notifications

MethodEndpointDescriptionAuth
GET/alertsList alerts (filterable, paginated)JWT
GET/alerts/unacknowledged-countUnacknowledged alert countJWT
POST/alerts/{id}/acknowledgeMark alert as acknowledgedJWT

​
Chat (conversational AI)

MethodEndpointDescriptionAuth
POST/chat/conversationsCreate conversationJWT
GET/chat/conversationsList conversationsJWT
GET/chat/conversations/{id}Get conversation + messagesJWT
POST/chat/conversations/{id}/messagesSend message, get AI responseJWT
DELETE/chat/conversations/{id}Archive conversationJWT
GET/chat/suggestionsContextual suggested questionsJWT
PUT/chat/conversations/{id}/messages/{mid}/editEdit user messageJWT
POST/chat/conversations/{id}/messages/{mid}/regenerateRegenerate responseJWT
GET/chat/conversations/searchSearch conversationsJWT
GET/chat/credit-estimateEstimate credit costJWT

​
Authentication

MethodEndpointDescriptionAuth
POST/auth/registerRegister with invite codeNone
POST/auth/loginLoginNone
POST/auth/refreshRefresh access tokenCookie
POST/auth/logoutLogout (invalidates session)JWT
GET/auth/check-ssoCheck SSO enforcement for domainNone
POST/auth/verify-emailVerify email addressNone
POST/auth/password-resetRequest password resetNone
POST/auth/password-reset/{token}Complete password resetNone
POST/auth/totp/setupSetup 2FA (returns QR + backup codes)JWT
POST/auth/totp/verify-setupVerify 2FA setupJWT
POST/auth/totp/completeComplete 2FA loginNone
POST/auth/totp/disableDisable 2FAJWT

​
User management

MethodEndpointDescriptionAuth
GET/users/meCurrent user profileJWT
GET/users/me/permissionsCurrent user permissionsJWT
PATCH/users/me/alert-preferencesUpdate alert preferencesJWT
POST/users/me/passwordChange passwordJWT
GET/usersList all users in orgAdmin
POST/usersInvite userAdmin
GET/users/{id}Get user detailsAdmin
PATCH/users/{id}Update userAdmin
DELETE/users/{id}Delete userAdmin

​
Teams & roles

MethodEndpointDescriptionAuth
GET/teamsList teamsAdmin
POST/teamsCreate teamAdmin
PATCH/teams/{id}Rename teamAdmin
DELETE/teams/{id}Delete teamAdmin
GET/teams/{id}Team with members + permissionsAdmin
POST/teams/{id}/membersAdd user to teamAdmin
DELETE/teams/{id}/members/{user_id}Remove user from teamAdmin
GET/teams/{id}/permissionsGet team permissionsAdmin
PATCH/teams/{id}/permissionsUpdate team permissionsAdmin
GET/rolesList all rolesAdmin
POST/rolesCreate custom roleAdmin
PATCH/roles/{id}Update custom roleAdmin
DELETE/roles/{id}Delete custom roleAdmin

​
Billing & credits

MethodEndpointDescriptionAuth
GET/billing/balanceCredit balance and spendingJWT
POST/billing/credits/addAdd creditsAdmin
GET/billing/usage-summaryUsage summary for billing periodJWT
POST/billing/checkoutCreate Stripe checkout sessionJWT
GET/billing/token-statusToken bucket statusJWT
PATCH/billing/ai-tierSwitch AI tier (basic/advanced)Admin

​
API keys & webhooks

MethodEndpointDescriptionAuth
POST/api-keysCreate API key (max 10/org)Admin
GET/api-keysList API keysAdmin
GET/api-keys/{id}API key detailsAdmin
PATCH/api-keys/{id}Update API keyAdmin
DELETE/api-keys/{id}Revoke API keyAdmin
POST/webhooksCreate webhook (max 10/org)Admin
GET/webhooksList webhooksAdmin
GET/webhooks/{id}Webhook detailsAdmin
PATCH/webhooks/{id}Update webhookAdmin
DELETE/webhooks/{id}Delete webhookAdmin
POST/webhooks/{id}/testSend test webhookAdmin

​
Organisation & settings

MethodEndpointDescriptionAuth
GET/organisationsOrg detailsAdmin
GET/settings/retentionData retention settingsAdmin
PATCH/settings/retentionUpdate retention settingsAdmin
GET/org-profileOrg profile and learned rulesJWT
PATCH/org-profileUpdate org profileAdmin
GET/org-profile/trust-historyTrust level and approval rateJWT
GET/auditAudit logs (filterable, paginated)Admin
GET/analytics/orgOrg analyticsJWT
GET/analytics/jobsJob analyticsJWT
GET/analytics/qualityQuality metrics and trendsJWT
GET/analytics/usageUsage metricsJWT

​
SSO

MethodEndpointDescriptionAuth
GET/sso/configGet SSO configAdmin
POST/sso/configCreate SSO configAdmin
PATCH/sso/configUpdate SSO configAdmin
DELETE/sso/configDelete SSO configAdmin
POST/sso/saml/loginSAML login initiationNone
POST/sso/saml/acsSAML assertion consumerNone
GET/sso/oidc/loginOIDC login initiationNone
GET/sso/oidc/callbackOIDC callback handlerNone