API Reference · Resonate
API Reference

Resonate API

Version 1.0.0

Everything you can do in Resonate, from your own tools. Create a personal API key in Resonate → Settings → API and send it in the X-API-KEY header. Each key acts as the user who created it.

Pacing. Every response has an X-Resonate-Pacing header: normal, paced (short randomized pause added after repeated LinkedIn errors) or backoff (429 with Retry-After). A successful call resets pacing.

Calling a path. Send the endpoint path in the path query parameter, e.g. GET https://app.getresonate.ai/functions/v1?path=/drafts&limit=10. Other query parameters go alongside it.

Fields. Responses contain only the documented fields. A field with no value is returned as null.

Validation. An unknown value for an enum query parameter (e.g. status=bogus) returns 400 errors/invalid_<param> listing the allowed values. An unknown or malformed id returns 404 errors/not_found. A path that does not exist returns 404 errors/resource_not_found. Treat both as 404.

Dates. Every date-time field is ISO 8601 or null.

Base URL

https://app.getresonate.ai/functions/v1?path=/…

Authentication

Send your personal API key in the X-API-KEY header on every request. Each key acts as the user who created it. Create one in Settings → API, paste it into the Credentials box on any endpoint page, and use Try It! to make real calls from this page.

Endpoints