API Introduction

Base URL: https://api.cloudsquid.io/api

Authentication

Every request must include your API key in the X-API-Key header. API keys are project-scoped and generated in the Cloudsquid dashboard under Project Settings → API Keys.

import requests

headers = {"X-API-Key": "YOUR_API_KEY"}

response = requests.get(
    "https://api.cloudsquid.io/api/projects",
    headers=headers
)

curl https://api.cloudsquid.io/api/projects \
  -H "X-API-Key: YOUR_API_KEY"

const response = await fetch("https://api.cloudsquid.io/api/projects", {
  headers: { "X-API-Key": "YOUR_API_KEY" }
});
const projects = await response.json();

Your first call: list projects

GET /projects returns all projects in your organisation. Use the name field as project_name in subsequent requests.

Response

[
  {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "my-project",
    "created_at": "2024-01-15T10:30:00Z"
  }
]

Integration patterns

Choose based on your use case:

Synchronous

Endpoints: /extract, /reconcileOne HTTP call. Blocks until processing is complete, then returns the full result. Best for interactive integrations and files that complete in under 60 seconds.

Asynchronous (3-step)

Endpoints: /files → /run → /run/{run_id}Upload, start, poll. Returns immediately — you check status separately. Best for large files, batch workloads, and decoupled pipelines.

Core concepts

Table Types

Extraction, Reconcile, and Storage tables — and when to use each.

Pipelines

Choose between flash and pro models based on speed and accuracy requirements.

Async Run Pattern

The upload → start → poll pattern for extraction at scale.

Create a New Project

Overview

Projects

Filesystem

Tables

Reconcile Tables

Extraction Tables

Storage Tables

Authentication

Your first call: list projects

Integration patterns

Synchronous

Asynchronous (3-step)

Core concepts

Table Types

Pipelines

Async Run Pattern

​Authentication

​Your first call: list projects

​Integration patterns

Synchronous

Asynchronous (3-step)

​Core concepts

Table Types

Pipelines

Async Run Pattern

Authentication

Your first call: list projects

Integration patterns

Core concepts