ENTERPRISE INTELLIGENCE API

The workflow. The evidence. One API.

Define work, start runs, route exceptions, receive decisions, and inspect what happened. Bring Enterprise Intelligence into your own systems through versioned interfaces.

Base host
api.auraone.ai (app.auraone.ai serves the same route tree)
Route shape
/api/v1/enterprise-intelligence/*
Credentials & errors
Org-bound ak_ API keys, idempotency-key mutations, JSON { error: { code, message } }
Illustrative · API flow over /api/v1Redacted key
Req
POSThttps://api.auraone.ai/api/v1/enterprise-intelligence/runs202 Accepted
  • Authorization: Bearer ak_00000000_••••
  • idempotency-key: run-2026-11-20-batch-14
  • X-Org-Id: scrubbed
Flow
  • Input request202POST /runs with idempotency-key
  • Human exceptionHITLWAITING_FOR_HUMAN · reviewer assigned
  • Accepted outputAuditGET /runs/{runId}/delivery & trace
  • Signed callbackSignedHMAC-SHA256 X-Webhook-Signature
SDKs
  • @auraone/sdkTypeScriptclient.enterpriseIntelligence.createRun(...)
  • aura_onePythonclient.enterprise_intelligence.create_run(...)
Contract verificationOrg derived from API key · mutating calls write audit events
Public API contract/api/v1 · TYPED & SIGNED

The Enterprise Intelligence API provides versioned /api/v1/enterprise-intelligence/* endpoints, typed TypeScript and Python SDKs, and HMAC-SHA256 signed webhooks for triggering workflow runs, tracking human reviews, and retrieving evidence-backed deliveries.

01 / Versioned request

Start the work from your product.

Create or reference an approved workflow and initiate a run from your existing application. All keys below are redacted placeholders—never real credentials.

curl -X POST https://api.auraone.ai/api/v1/enterprise-intelligence/runs \
  -H "Authorization: Bearer ${AURAONE_API_KEY}" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: run-2026-11-20-batch-14" \
  -d '{
    "workflowVersionId": "wfv_example_v3",
    "inputContentId": "cnt_example_batch_14",
    "environmentVersion": "env-2026.11"
  }'

# 202 Accepted
# {
#   "data": { "id": "run_example_01", "status": "QUEUED" },
#   "links": { "self": ".../runs/run_example_01" }
# }

Auth, scope & error contract

Exact request headers, scopes, and error behavior

Every route except the unauthenticated health probe binds organization scope from the credential and returns structured JSON errors.

API key format
ak_<8 lowercase hex>_<64 lowercase hex> via Authorization: Bearer or x-api-key; legacy aura_*/aoc_* keys are rejected with 401Bearer & header auth
Scopes & errors
enterprise-intelligence.read for GET routes, enterprise-intelligence.write for POST /runs and GET /run-inputs, enterprise-intelligence.cancel for cancellation; missing scopes return 403 PERMISSION_DENIEDRole & scope check
Idempotency
State-changing routes require idempotency-key (8–255 chars); duplicate calls replay the committed response with x-idempotency-replayed: trueSafe retries
Organization isolation
Organization is derived strictly from the key record; inbound X-Org-Id headers are scrubbed by middleware and mismatched ?orgId assertions return 403 organization_forbiddenTenant isolation
Key provisioning
POST /api/v1/api-keys is the public mint route (requires an interactive session; scopes are bounded by the minter's permissions)Key minting

02 / State & provenance

Follow the decision.

Track state, responsible reviewer, exceptions, and acceptance as the workflow progresses.

Input request → human exception → accepted output → signed callback

  1. 01

    Run queued & active

    POST /api/v1/enterprise-intelligence/runs returns 202 with a run ID and polls cleanly through QUEUED and RUNNING states.

    GET /runs/{runId}

  2. 02

    Human exception review

    When policy uncertainty triggers human review, state transitions to WAITING_FOR_HUMAN and surfaces the assigned review task.

    GET /human-tasks

  3. 03

    Accepted output & trace

    Inspect the output payload, execution trace, lineage, and sealed delivery manifest once checks and reviews settle.

    GET /runs/{runId}/delivery

  4. 04

    Signed callback verified

    Verify the HMAC-SHA256 signature over timestamp + raw request bytes before applying the accepted result in your downstream system.

    X-Webhook-Signature

03 / Signed webhooks

Trust the event you received.

Use signed webhooks and documented verification to connect the decision to your own system. Verify the HMAC-SHA256 signature over ${timestamp}.${rawBody} against the raw request bytes before parsing JSON.

import { createHmac, timingSafeEqual } from "node:crypto";

const TOLERANCE_MS = 5 * 60 * 1000;

export function verifyAuraOneWebhook(
  rawBody: Buffer,
  headers: Record<string, string | string[] | undefined>,
  secret: string,
  now = Date.now(),
): boolean {
  const signature = String(headers["x-webhook-signature"] ?? "");
  const timestamp = String(headers["x-webhook-timestamp"] ?? "");
  if (!secret || !signature || !/^\d+$/.test(timestamp)) return false;

  const sentAt = timestamp.length > 11 ? Number(timestamp) : Number(timestamp) * 1000;
  if (Math.abs(now - sentAt) > TOLERANCE_MS) return false;

  const provided = signature.startsWith("sha256=") ? signature.slice(7) : signature;
  if (!/^[0-9a-f]{64}$/i.test(provided)) return false;

  const expected = createHmac("sha256", secret)
    .update(`${timestamp}.`)
    .update(rawBody)
    .digest();
  const received = Buffer.from(provided, "hex");
  return received.length === expected.length && timingSafeEqual(received, expected);
}

04 / Typed SDKs

The same language across SDKs.

Both @auraone/sdk (TypeScript) and aura_one (Python) target the same /api/v1/enterprise-intelligence routes, attach idempotency-key headers automatically on mutations, and raise explicit typed errors on 503 or permission denials.

@auraone/sdkcreate-run.ts
import { AuraOneClient } from "@auraone/sdk";

const client = new AuraOneClient({
  apiKey: process.env.AURAONE_API_KEY!, // ak_00000000_redacted...
  baseUrl: "https://api.auraone.ai",
});

// Start a workflow run with an explicit idempotency key
const created = await client.enterpriseIntelligence.createRun({
  workflowVersionId: "wfv_example_v3",
  inputContentId: "cnt_example_batch_14",
  environmentVersion: "env-2026.11",
  idempotencyKey: "run-2026-11-20-batch-14",
});

// Inspect status, trace, and sealed delivery evidence
const run = await client.enterpriseIntelligence.getRun(created.data.id);
const delivery = await client.enterpriseIntelligence.getRunDelivery(created.data.id);

05 / Connector scope

Integrations with explicit scope.

See which connectors are supported in the current adapter catalog, which read or write operations each one permits, and what authorization is required before production writes run. Every connector requires customer-specific registration and authorization rather than blanket activation.

Every write needs a write-scope grant, a human approval and an idempotency key. In production, a write also needs a verified sandbox proof.

Supported connectors with read and write capability
ConnectorReadWrite
HubSpot CRMRead contactsUpsert contacts
Salesforce CRMRead contactsUpsert contacts
JiraNoneCreate issue
SlackNonePost run summary
Microsoft TeamsNonePost card
Amazon S3Check bucket accessWrite object
SnowflakeNoneProvision warehouse connection
BigQueryNoneStream rows (start sync)
DatabricksNoneRun job
PagerDutyNoneTrigger incident

Full route inventory

The Enterprise Intelligence /api/v1 surface, family by family.

Every family below corresponds directly to the live /api/v1/enterprise-intelligence route tree. Mutating handlers write audit events automatically.

Enterprise Intelligence route families under /api/v1/enterprise-intelligence
API familyCoversSurface
/api/v1/enterprise-intelligence/workflowsWorkflow definitions, versions, activations, approval requests, per-workflow evaluations, release gates, chart review, the weekly queue, and executive buyer reports (/workflows/{workflowId}/buyer-report)Workflow scoping and versioning
/api/v1/enterprise-intelligence/runsRuns plus per-run acceptance, auditor export, cancel, commercial terms, compensations, delivery, derivatives, elapsed time, incidents and human incident severity triage (/runs/{runId}/incidents/{incidentId}/triage), run lineage (/runs/{runId}/lineage), output, field queries, replay, and traceRun lifecycle and evidence
/api/v1/enterprise-intelligence/deliveriesAccepted deliveries and per-delivery detailDelivery receipts
/api/v1/enterprise-intelligence/batchesBatch ingest, items, acceptance, auditor export, cancel, connector delivery, and retryBatch intake
/api/v1/enterprise-intelligence/human-tasksReview tasks, completion, and finding decisions for cases that pause for qualified reviewHuman review
/api/v1/enterprise-intelligence/connectorsConnector registration, authorization, inbound endpoints, pull, receipts, test, ticket deliveries, and revocationIntegrated systems
/api/v1/enterprise-intelligence/tool-bindingsTool bindings attached to approved workflow versionsBound actions
/api/v1/enterprise-intelligence/evaluationsEvaluation records that judge workflow versions and candidatesEvaluation
/api/v1/enterprise-intelligence/improvement-itemsNamed failures and improvement targets with owner and statusModel improvement
/api/v1/enterprise-intelligence/regression-suitesRegression suites, suite runs, and exportsRegression control
/api/v1/enterprise-intelligence/historical-setsHistorical task sets: register, examples, validation, baseline, dataset, acceptanceEvidence data
/api/v1/enterprise-intelligence/context-sourcesContext source registration, ingest, retry, and withdrawPermissioned context
/api/v1/enterprise-intelligence/registryModel, prompt, tool, node-option, and policy registriesScoped registries
/api/v1/enterprise-intelligence/operationsOperations metrics, automation trend, SLOs, SLO reports, and the SLO release gateOperations
/api/v1/enterprise-intelligence/settingsPer-organization policy versions, the ticketing switch, and the connector sandbox-proof gateAdministration
/api/v1/enterprise-intelligence/run-inputsEligible input content references and environment versions for a new runRun intake
/api/v1/enterprise-intelligence/menuMenu operations and menu photo readings with their proposalsMenu workflow
/api/v1/enterprise-intelligence/healthUnauthenticated probe: worker heartbeat and dependency status; 503 when unavailableHealth

Domain and operational route families

Additional domain-specific and operational endpoints under the /api/v1/enterprise-intelligence prefix.

Route directoryCovers
claims/Claims operations, operation previews, and per-run claim decisions
compensations/Execute one compensating action raised on a run
dashboard/Organization summary of workflows, runs, review queue, usage, invoices, and margins
improvements/Improvement cycles and their human-approved state transitions
regression-candidates/Propose a regression case from an incident and review it
workflow-schedules/Workflow schedules and their latest cycles

What comes next

Continue into docs, integrated operations, or workflow scoping.

AuraOne Developer Home

Explore full API docs, SDK packages, signed webhook guides, and technical references across AuraOne.

Read the API docs

Integrated Enterprise Intelligence

See how scoped connectors, human review pauses, and destination writes operate in connected enterprise workflows.

See Integrated workflows

Request API access

Scope an enterprise workflow and provision organization-bound API keys with your engineering team.

Request API access

Common questions

Developer questions on the Enterprise Intelligence API.

How are API keys scoped and authenticated?

Keys use the ak_<8 hex>_<64 hex> format passed via Authorization: Bearer or x-api-key. Your organization is derived strictly from the key record; inbound X-Org-Id headers are scrubbed by middleware. Missing or insufficient scopes return structured 401 or 403 JSON errors ({ error: { code, message } }).

How do mutations prevent duplicate execution on retries?

State-changing routes such as POST /api/v1/enterprise-intelligence/runs require an idempotency-key header (8–255 characters). Replaying the same key returns the committed outcome envelope with x-idempotency-replayed: true.

Are all connectors globally enabled without configuration?

No. Each supported connector requires explicit registration, scoped authorization, and customer configuration inside your engagement. Connectors not listed below are not claimed as generally supported.