Project Consumption APIs Overview

​

Introduction

To use the browser automations, scrapers and integrations that are created on the Intuned Platform, we expose a set of APIs that allow you to consume your projects in different ways.

​

Run API

The Run API is the simplest way to consume your projects. It allows you to trigger single APIs in your projects and get the result back. There are two ways to use the run API:

1. Synchronously: Call the API and wait for the result in the same request.
2. Asynchronously: Start the API call and receive a run ID which you can use to check the status of the run and get the result.

More information on the Run API can be found here.

​

Job API

The Job API is a more advanced way to consume your projects. It allows you to create jobs that can run multiple APIs in your project. Jobs allow you to:

• Configure advanced retry strategies such as exponential backoff.
• Run APIs concurrently.
• Sink the results of the APIs to a destination such as a webhook or an S3 bucket.
• Extend the API payloads to dynamically run other APIs.
• Schedule the job to run periodically.
• Pause and resume job execution and schedule.

More information on the Job API can be found here.

​

Queue API

The Queue API allows you to consume your projects in an order-based manner. It allows you to queue up APIs to run on demand. Queues allow you to:

• Queue up APIs to run on demand with guaranteed order.
• Configure APIs to queue up periodically.
• Sink the results of the APIs to a destination such as a webhook.
• Extend the API payloads to dynamically queue up other APIs.
• Impose rate limits for the queued up API runs.
• Configure periods which the queue can pause execution.
• Add random delays between API runs.

More information on the Queue API can be found here.