Skip to main content
The Intuned REST API enables you to programmatically trigger automations, manage scheduled Jobs, and handle AuthSessions. You can call the APIs directly as REST endpoints or use our client libraries for JavaScript and Python.

​
Endpoints

Execute your automation APIs on demand.
Schedule and manage batch executions of your automations.
Create and manage authentication sessions for automations that require login.
Configure where Job results are delivered.
  • Overview — Learn how sinks work
  • Webhook — Send results to a webhook URL
  • S3 — Store results in Amazon S3
  • Body — Include results in the API response
https://cdn.jsdelivr.net/gh/devicons/devicon@latest/icons/openapi/openapi-plain.svg

OpenAPI Specification

https://cdn.jsdelivr.net/gh/devicons/devicon@latest/icons/postman/postman-original.svg

Import into Postman

​
Prerequisites

All API requests require your workspace ID and an API key.

Get your workspace ID

Find your workspace ID in settings

Manage API keys

Create and manage API keys

​
Client libraries

​
JavaScript

Install the @intuned/client package: 
npm install @intuned/client

import { IntunedClient } from "@intuned/client";

const client = new IntunedClient({
  apiKey: "<YOUR_API_KEY>",
  workspaceId: "<YOUR_WORKSPACE_ID>",
});

// Start an async run
const { result } = await client.project.run.start("my-project", {
  api: "scrape-products",
  parameters: { page: 1 },
});

console.log(result.runId);

​
Python

Install the intuned-client package: 
pip install intuned-client

from intuned_client import IntunedClient

with IntunedClient(
    workspace_id="<YOUR_WORKSPACE_ID>",
    api_key="<YOUR_API_KEY>",
) as client:
    # Start an async run
    result = client.project.run.start(
        project_name="my-project",
        api="scrape-products",
        parameters={"page": 1},
    )
    print(result.run_id)

​
Rate limits

Intuned APIs are rate-limited to 60 requests per minute per URI path.
If you need a higher rate limit, contact us.