volanea_get_api_reference
Authoritative REST API reference for writing integration code into the user's app. Base URL: https://api.volanea.com — auth is Authorization: Bearer <secret key>; sends accept an Idempotency-Key header. Use this instead of guessing endpoint shapes or SDK names. THREE MODES, and the default is the expensive one: { resource, indexOnly: true } lists every operation's id, method, path, and one-line summary with NO schemas (a few KB); { resource, operations: [ids] } returns full request/response schemas for just those operations, plus only the schemas they reference; { resource } alone returns the entire resource, which for Campaigns or Contacts is 40-50 KB of one reply. Start with indexOnly, then expand the two or three operations you are actually going to call — every byte of a reference dump re-enters your context on every later turn.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| resource | Yes | Which API resource to fetch reference docs for. | |
| indexOnly | No | Return just the operation list (operationId, method, path, summary) with no request/response schemas — the cheapest way to find the operationIds to pass in `operations`. Takes precedence over `operations`. | |
| operations | No | operationIds to expand in full, e.g. ["sendCampaign", "getCampaign"] — get them from an indexOnly call. Only the component schemas these operations actually reference are included. Omit to get every operation on the resource, which is what makes the unfiltered call so large. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| code | No | Machine-readable failure code to branch on. Present only when success is false. | |
| data | No | Present when success is true. | |
| error | No | Human-readable failure reason. Present only when success is false. | |
| success | Yes | False when the call failed; read `error` and `code` in that case. |