API & SDKs. Build on Elido, in any language.

Yes. The current version is v1, accessed at /v1/... Breaking changes are announced in the changelog with a 90-day deprecation window before the old behavior is removed. Non-breaking additions (new fields, new optional parameters) ship without a version bump. The API version is stable; if v2 is ever introduced, v1 will run in parallel for at least 12 months. The OpenAPI spec at /openapi.json always reflects the current stable version.

Bearer token authentication: include your API key in the Authorization header as 'Bearer elido_sk_...'. The key value is shown once at creation. For server-to-server webhook calls from Elido to your system, Elido signs the request body with HMAC-SHA256 using a shared secret - verify the X-Elido-Signature header on your webhook handler. OAuth2 client credentials are available for partner integrations where workspace API key distribution is impractical - contact us for OAuth2 partner onboarding.

Yes. The TypeScript SDK uses the fetch API (available in all modern edge runtimes) and avoids Node.js-only APIs (no fs, no http, no Buffer). It's tested on Cloudflare Workers, Vercel Edge Functions, and Deno Deploy. If you're running the SDK in a constrained edge environment, use the lightweight import path (@elido/sdk/edge) which excludes the CLI utilities and Node.js-only modules from the bundle.

For Claude: add the MCP server to your claude_desktop_config.json with your API key as an environment variable - the Elido MCP docs have a one-block copy-paste config. For ChatGPT (function calling): the MCP server exposes a JSON Schema tool manifest at /.well-known/mcp.json that you can import into your GPT's action configuration. For Cursor: add the MCP server as a local tool in Cursor's settings. All configurations require a valid Elido API key with the relevant scopes. The MCP server is not published publicly yet: public release coming soon; contact support for early access.

All list endpoints use cursor-based pagination. Response includes a next_cursor field (null if no more pages). Pass the cursor value as the cursor query parameter on the next request. Default page size is 50; maximum is 200. Cursor-based pagination is stable - adding or deleting records between pages doesn't cause items to be skipped or repeated, unlike offset-based pagination. The SDKs include an auto-paginate helper that yields items one at a time regardless of page boundaries.

Yes. API keys are workspace-scoped, but you can hold keys for multiple workspaces. The API endpoint prefix is /v1/workspaces/{workspace_id}/... - pass the workspace ID of the target workspace. If you're building a multi-workspace management tool (e.g., an agency portal managing client workspaces), you'll hold one API key per workspace. OAuth2 partner credentials with cross-workspace scope are available for platform integrations - contact sales.

Free plan: 60 requests per minute per workspace. Rate limit is enforced at the API gateway with a token bucket algorithm. When the bucket is empty, the API returns HTTP 429 with a Retry-After header indicating when the next token is available. The SDKs automatically respect Retry-After on 429 responses. Note that bulk endpoints have separate limits - the link bulk-create endpoint counts as one request regardless of how many links are in the payload.

Yes - pass the X-Elido-Sandbox: true header to any API request to run it against the sandbox environment. Sandbox requests create real objects in a sandboxed workspace partition (links, campaigns, etc.) but redirect traffic is not served from the production edge. Use the sandbox for integration testing and CI/CD pipelines. Sandbox objects do not count against your plan's link or click quotas. The sandbox resets every 24 hours - do not depend on sandbox data for production use.