REST API v1

Build with the
Gravitre API

Execute workflows, query intelligence endpoints, and wire Gravitre into your stack — with the same connector health and approval gates as the product UI.

Get Started API Reference

API path

Auth → Request → Approve → Audit

One signature TRACE — the same governed path as the product UI, exposed over HTTP.

Rate limits are plan-specific and documented in the API docs — ask us for the limits that match your plan. No invented tier numbers here.

Same approval gates

Writes go through the same human approval gates as the product UI

Secure by default

OAuth 2.0, API keys, and signed webhooks

Auditable runs

Runs and approvals show up in the same audit trail operators already review

Live connector health

Connector availability matches what you see in the product — Configured → Executable

Simple, powerful integration

Execute AI agents with just a few lines of code

example.ts

import { Gravitre } from '@gravitre/sdk';
const client = new Gravitre({
  apiKey: process.env.GRAVITRE_API_KEY,
  orgId: process.env.GRAVITRE_ORG_ID
});
// Execute a workflow
const run = await client.workflows.execute('wf_lead_sync', {await client.workflows.execute('wf_lead_sync', {
  parameters: {
    source: 'salesforce',
    destination: 'hubspot',
    syncMode: 'incremental'
  }
});
// Poll for completion or use webhooks
const result = await run.waitForCompletion();await run.waitForCompletion();
console.log(result.status); // 'completed'console.log(result.status); // 'completed'
console.log(result.steps);  // Array of step outputsconsole.log(result.steps);  // Array of step outputs
// [{ name: 'Fetch Data', status: 'completed', output: {...} }, ...]

API Endpoints

Full reference

POST/api/workflows/{id}/executeCoreExecute a workflow with optional parameters

GET/api/workflowsList all workflows with filtering and pagination

GET/api/workflows/{id}/builderGet workflow graph with nodes and edges for the visual builder

POST/api/workflows/{id}/dry-runCorePreview workflow execution without committing changes

GET/api/runs/{id}Get detailed status, steps, and outputs for a run

POST/api/runs/{id}/approveApprove a pending workflow run (human-in-the-loop)

GET/api/admin/intelligence/snapshotIntelligenceOrg learning snapshot — query volume, clusters, and knowledge gaps

GET/api/connectorsList connectors with live Configured → Executable availability

POST/api/connectors/{id}/syncTrigger a manual sync for an integration

GET/api/metrics/overviewGet dashboard metrics (workflows, success rate, runs)

POST/api/operator/action-planAIGenerate an AI action plan from natural language

Official SDKs

Type-safe clients for your favorite languages

Node.js

npm install @gravitre/sdk

Documentation

Python

pip install gravitre

Documentation

Go

go get github.com/gravitre/go-sdk

Documentation

Webhooks

Receive real-time notifications when runs complete, workflows trigger, or errors occur. All webhooks are signed for security.

Configure webhooks

Authentication

Secure API access with scoped API keys or OAuth 2.0. Fine-grained permissions let you control exactly what each integration can access.

Authentication guide

Ready to build?

Get your API key and start integrating Gravitre in minutes.

Get API Key Quickstart Guide

Connect your stack.
Put Gravitre to work.

Put Gravitre to work

REST API v1

Build with the
Gravitre API

Execute workflows, query intelligence endpoints, and wire Gravitre into your stack — with the same connector health and approval gates as the product UI.

Get Started API Reference

API path

Auth → Request → Approve → Audit

One signature TRACE — the same governed path as the product UI, exposed over HTTP.

Rate limits are plan-specific and documented in the API docs — ask us for the limits that match your plan. No invented tier numbers here.

Same approval gates

Writes go through the same human approval gates as the product UI

Secure by default

OAuth 2.0, API keys, and signed webhooks

Auditable runs

Runs and approvals show up in the same audit trail operators already review

Live connector health

Connector availability matches what you see in the product — Configured → Executable

Simple, powerful integration

Execute AI agents with just a few lines of code

example.ts

import { Gravitre } from '@gravitre/sdk';
const client = new Gravitre({
  apiKey: process.env.GRAVITRE_API_KEY,
  orgId: process.env.GRAVITRE_ORG_ID
});
// Execute a workflow
const run = await client.workflows.execute('wf_lead_sync', {await client.workflows.execute('wf_lead_sync', {
  parameters: {
    source: 'salesforce',
    destination: 'hubspot',
    syncMode: 'incremental'
  }
});
// Poll for completion or use webhooks
const result = await run.waitForCompletion();await run.waitForCompletion();
console.log(result.status); // 'completed'console.log(result.status); // 'completed'
console.log(result.steps);  // Array of step outputsconsole.log(result.steps);  // Array of step outputs
// [{ name: 'Fetch Data', status: 'completed', output: {...} }, ...]