Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.cloudsquid.io/llms.txt

Use this file to discover all available pages before exploring further.

​
Get your API key

All API requests are authenticated with a project-scoped API key.
  1. Open your project in the Cloudsquid platform.
  2. Go to Settings → API Keys.
  3. Click Generate New Key, give it a name, and copy it immediately — it won’t be shown again.
Keep your API key secret. Do not commit it to source control. Use environment variables in production.

​
Authentication

Every request requires your API key in the X-API-Key header.
Base URL: https://api.cloudsquid.io/api

​
Your first API call

List all projects in your organisation — a simple read-only call to confirm everything is working. 
import requests

response = requests.get(
    "https://api.cloudsquid.io/api/projects",
    headers={"X-API-Key": "YOUR_API_KEY"}
)
print(response.json())
# [{"id": "...", "name": "my-project", "created_at": "..."}]
A 200 response with a JSON array confirms your key is valid and your organisation has at least one project.

​
Next steps

Core Concepts

Understand table types, pipelines, and the async run pattern before building your integration.

API Reference

Full endpoint reference with request and response schemas.