API Reference

The Curviate API reference is an interactive documentation viewer. It documents the REST API endpoint by endpoint: request parameters, request bodies, response shapes, and status codes.

To try calls live, open the Authentication panel on an endpoint (it is labelled Required until you fill it in) and enter your API key as the bearer token. Then use Test Request, and send it with Send Request.

The machine-readable OpenAPI spec is available at /.well-known/openapi.json, useful for code generation, client SDK authoring, and LLM tool definitions.

• Open the API Reference
• Download the OpenAPI spec (JSON)

Before you start

Reading the reference needs nothing. Running a call needs an API key, and almost every endpoint additionally needs a connected LinkedIn account whose acc_... id fills the account_id path parameter. GET /v1/accounts is the one call that works with an API key alone, and it is where your acc_... ids come from. See Quickstart.

Next steps

• API quick start: the first call, end to end.
• Getting started guides: send a message, read a profile, list connections.
• Errors: the error envelope and code taxonomy.
• Rate limits: quotas and pacing.