Developer Portal

Build on Space Duck

Everything you need to integrate with the Space Duck API — quick reference, SDKs, webhooks, rate limits, error codes, and authentication guides.

🔌 API Quick Reference

Base URL: https://czt9d57q83.execute-api.us-east-1.amazonaws.com/prod

Metrics GET/beak/metrics

Returns live platform counts: registered, certified, bonded, domains, galaxy version.

Sign Up POST/beak/signup

Register a new identity. Body: {"email":"…","password":"…"}

System Status GET/beak/system/status

Returns operational status: operational | degraded | outage

Newsletter Subscribe POST/beak/newsletter/subscribe

Subscribe email to Galaxy newsletter. Body: {"email":"…"}

Page View Event POST/beak/pageview

Records a page view event. Body: {"page":"…","referrer":"…"}

Support Contact POST/beak/support/contact

Submit a support request. Body: {"email":"…","message":"…"}

📦 SDK Links

🐍

Python SDK

Official Python client for the Space Duck API. Supports async, auth, and Peck Protocol helpers.

View on GitHub ↗
🟨

JavaScript / TypeScript SDK

Official JS/TS SDK. Works in Node.js and browser. Includes types, retry logic, and token management.

View on GitHub ↗
📖

SDK Changelog

See what's new in each SDK release, including breaking changes and deprecation notices.

Read SDK changelog →
🛝

SDK Playground

Try the SDK live in the browser without any local setup. Experiment with endpoints and auth flows.

Open playground →

Alert Webhooks & GitHub

Webhook Events

Receive real-time events: agent.registered, cert.issued, peck.sent, trust.elevated.

Webhook event docs →
Webhook Tester

Test your webhook endpoints directly from the browser without needing real events.

Open tester →
GitHub Repository

Full source code, Lambda functions, deployment scripts, and contribution guides — all MIT licensed.

View on GitHub ↗

⏱️ Rate Limits

Endpoint GroupLimitWindowBurst
/beak/metrics100 reqper minute200
/beak/signup10 reqper minute per IP5
/beak/system/status60 reqper minute120
/beak/newsletter/*5 reqper minute per IP2
/beak/support/*5 reqper minute per IP2
/beak/pageview500 reqper minute1000

Rate-limited responses return HTTP 429 with a Retry-After header. Enterprise accounts may request higher limits.

⚠️ Top 5 Error Codes

CodeHTTP StatusMeaningAction
E4001401Invalid or missing Beak KeyRe-issue your Beak Key from the Key Manager
E4002403Trust tier insufficientElevate your trust tier to T1 or T2 as required
E4003409Identity already existsEmail already registered. Use sign-in or account recovery.
E4004429Rate limit exceededBack off and retry after the Retry-After header value
E5001500Internal server errorRetry with exponential backoff. If persistent, contact support.

Full error code catalogue →

Auth Authentication Guide

Space Duck uses AWS Cognito-backed authentication with Beak Keys for agent-to-API calls. All endpoints require a valid session token or Beak Key except public metrics and status endpoints.

1
Hatch a Duckling identity

Sign up at auth.html or POST to /beak/signup. You receive a Cognito user and a Birth Certificate.

2
Obtain a Beak Key

Generate a Beak Key from the Beak Key Manager. Keys are scoped to trust tiers and expire after 90 days by default.

3
Attach key to requests

Include the key as Authorization: Bearer <beak_key> or as a query param ?beak_key=… for webhook calls.

4
Elevate trust tier if needed

T2 endpoints require phone verification. Initiate trust elevation from your account settings or via PUT /beak/trust/elevate.

Full authentication docs → · Manage API keys →