REST API

iDataWorkers REST API

Full programmatic access to your data platform. Push, pull, query, and automate with a developer-friendly REST API, real-time webhooks, and official SDKs.

Built for Developers

Everything you need to integrate with iDataWorkers programmatically.

OpenAPI 3.0

Full schema with interactive documentation and code samples in Python, Node.js, and cURL.

Webhooks

Subscribe to data change events. Get JSON payloads pushed to your endpoints in real-time with retry logic.

Official SDKs

Python and JavaScript SDKs with type definitions, automatic retries, and async support.

API Capabilities

A comprehensive API surface for every data workflow.

Data Hub API

CRUD operations on data sources, schemas, and records. Bulk import and export endpoints.

Data Hub API

Data Sync API

Trigger syncs, check pipeline status, and manage sync schedules programmatically.

Data Sync API

Agent Gateway API

Deploy, configure, and monitor AI agents. Retrieve agent outputs and orchestration logs.

Agent Gateway API

Cognify API

Access AI-generated insights, anomaly reports, and pattern analysis results via API.

Cognify API

Dexi API

Send natural language queries to Copilot Dexi and receive structured data responses.

Dexi API

Visualization API

Embed dashboards, export chart data, and manage visualization configurations.

Visualization API

Developer-Friendly by Design

REST API with comprehensive documentation, versioned endpoints, and predictable response formats.

  • Interactive docs

    Try API calls directly from the browser with auto-generated OpenAPI 3.0 documentation.

  • Cursor pagination

    Efficient cursor-based pagination for large result sets with consistent ordering.

  • Rate limiting

    Generous rate limits with clear X-RateLimit headers and graceful 429 responses.

Authentication & Security

Enterprise-grade security for every API call. OAuth 2.0, API keys, and role-based access control.

  • OAuth 2.0

    Standard OAuth 2.0 flows for secure token-based authentication.

  • API keys

    Simple API key authentication for server-to-server integrations with IP whitelisting.

  • RBAC scopes

    Fine-grained permission scopes — grant read-only access to data, write access to syncs, etc.