API Documentation

Integrate SideClick into your applications

Powerful API for Developers

The SideClick API allows you to programmatically manage and run browser automation workflows, extract data, and integrate with your existing applications and services.

Our API is designed to be RESTful, predictable, and easy to use with comprehensive documentation and SDKs for popular languages.

Read the Docs API Reference

API Features

Everything you need to integrate browser automation into your applications

REST API

Interact with SideClick programmatically using our REST API with predictable resource-oriented URLs.

Webhooks

Get notified about events in your SideClick account with real-time webhooks to keep your systems in sync.

JavaScript SDK

Integrate with our JavaScript SDK for a type-safe, intuitive way to interact with the SideClick API.

Authentication

Secure API access with API keys, OAuth 2.0, and fine-grained permission controls for your applications.

Quick Start Examples

Get started quickly with these code examples

cURL Example

curl -X POST "https://api.sideclick.site/v1/workflows/run" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "workflow_id": "wf_123456789",
    "parameters": {
      "search_term": "browser automation",
      "max_results": 10
    }
  }'

JavaScript Example

import { SideClick } from '@sideclick/sdk';

// Initialize the client
const sideclick = new SideClick({
  apiKey: 'YOUR_API_KEY'
});

// Run a workflow
async function runWorkflow() {
  try {
    const result = await sideclick.workflows.run({
      workflow_id: 'wf_123456789',
      parameters: {
        search_term: 'browser automation',
        max_results: 10
      }
    });
    console.log(result.data);
  } catch (error) {
    console.error('Error running workflow:', error);
  }
}

Python Example

import sideclick

# Initialize the client
client = sideclick.Client(api_key='YOUR_API_KEY')

# Run a workflow
try:
    result = client.workflows.run(
        workflow_id='wf_123456789',
        parameters={
            'search_term': 'browser automation',
            'max_results': 10
        }
    )
    print(result.data)
except Exception as e:
    print(f"Error running workflow: {e}")

API Resources

Everything you need to succeed with the SideClick API

API Reference

Complete reference documentation for all API endpoints, parameters, and response formats.

View API Reference

SDKs & Libraries

Official SDKs for JavaScript, Python, Ruby, and more to simplify integration with SideClick.

Explore SDKs

Tutorials & Guides

Step-by-step guides and tutorials for common API use cases and integrations.

Browse Tutorials

Need API Support?

Our developer team is ready to help with any API integration questions or issues.

Report Issues Email API Support