Skip to main content
This quickstart walks through the fastest path from zero to a working API call. Detailed guides for OAuth, HMAC signing, and signal envelopes are linked at the end.

Prerequisites

1. Verify the API is up

curl -sS https://mcp.echozero.app/api
You should receive a JSON health response.

2. Authenticate a request

Send your API key on every authenticated REST call:
export EZ_API_KEY="ez_live_..."

curl -sS https://mcp.echozero.app/api/v1/users/me \
  -H "x-api-key: $EZ_API_KEY"
OAuth-based clients can send Authorization: Bearer <access_token> instead. See the OAuth guide.

3. Explore the API reference

Open the API Reference tab in the sidebar to browse endpoints, request bodies, and response schemas. The reference is generated from the live OpenAPI spec at https://mcp.echozero.app/api/docs-json.

4. Connect via MCP (optional)

For AI assistant integrations, see the MCP Server guide. Your client should POST to:
https://mcp.echozero.app/mcp
Use the same API key or OAuth token on initialize and subsequent requests. Directory metadata lives at https://mcp.echozero.app/public/index.json.

What’s next

OAuth 2.1

Authorization code + PKCE for assistant clients.

Signal envelope

Event types, idempotency, and delivery semantics.

Webhook security

HMAC verification and replay protection.

Sandbox

Test integrations without production side effects.