API reference

Complete reference for every integration-facing endpoint in the SynC API. Each endpoint lists parameters, request body schemas and required permissions.

Discovery

The endpoints every integration calls first. Health is unauthenticated; whoami and help confirm your credentials and let an agent self-configure.

GET /api/health

Check API availability. No authentication required.

GET /api/whoami

Returns your identity, permissions, and rate limit status. Use to verify your API key works.

GET /api/help

Returns the full API endpoint catalog with descriptions, permissions, and parameters. No authentication required. Useful for self-configuring AI agents.

Resource groups