API Overview

Key concepts, authentication workflow, and environment configuration for the ConnectSafely API.

API Overview

The ConnectSafely API surfaces LinkedIn automation features that power the product UI. Each endpoint documented here comes directly from the main app and supports live testing via the Try it now playground.

Authentication

  • Generate an API key from connectsafely.ai/api-key.
  • Send it with every authenticated request as a Bearer token.
  • Rotate keys regularly and never expose production keys in client-side code.
Authorization: Bearer <YOUR_API_KEY>

Environments

EnvironmentBase URLNotes
Productionhttps://api.connectsafely.aiBest data freshness and rate limits.
Sandboxhttps://sandbox.api.connectsafely.aiSafe for integration tests. Mirrors features but with throttled LinkedIn actions.

Configure the docs playground using the Docs environment (proxied through this site). For production traffic, call the API from your backend services directly.

Endpoint Groups

  • LinkedIn Actions – Follow, message, and connect with members.
  • LinkedIn Posts – Read, react, comment, and search for posts.
  • LinkedIn Profiles – Retrieve enriched profile data.
  • Placeholder Endpoints – Future capabilities currently returning stub responses.

Use the sidebar navigation to browse each group or jump directly using the shortcuts below:

Rate Limits

Default allowance is 60 requests per minute with short-term bursts up to 100 requests per 10 seconds. Contact support if you need higher throughput.

Error Handling

Errors follow a consistent shape:

{
  "success": false,
  "code": "validation_error",
  "message": "Explanation of what went wrong"
}

Always check the HTTP status code and the success field before processing data.

Changelog

Endpoint docs are generated from the canonical specification inside the web application. Regenerate the docs (bun run generate:api) whenever the product team updates the in-app documentation.