API Overview

The Squawkpipe API is a RESTful API at https://api.squawkpipe.com that provides programmatic access for Squawkpipe Observable Agents.

Prerequisites

To use the Squawkpipe API, you'l need.

• A Squawkpipe account
• An API key

For setup-by-step setup instructions, see Quickstart

Base URL

https://api.squawkpipe.ai/v1

Authentication Methods

All requests require an Authorization header.

API Key (agents and CI/CD)

Authorization: Bearer sk_your_api_key_here

API keys are created in Settings → API Keys in the Squawkpipe app. They are tenant-scoped and intended for agent and automation use.

Firebase ID Token (dashboard sessions)

Authorization: Bearer <firebase_id_token>

Firebase ID tokens are issued after browser sign-in and expire after 1 hour. The CLI and dashboard handle token refresh automatically.

Health Check

curl -X GET https://api.squawkpipe.ai/v1/health

Response 200 OK:

{ "status": "ok" }

Error Responses

HTTP Status	Meaning
401	Invalid or missing token
403	Token valid but insufficient permissions for this tenant
404	Resource not found or not in your tenant
409	Conflict — e.g., sending a message to a paused conversation
429	Rate limit exceeded

All error responses include a JSON body:

{ "error": "description of the error" }