Skip to main content

Quick Start

This is the developer quickstart — get an API key, make a call, and connect an AI agent. (Evaluating the product itself? Start a managed trial at app.nearsync.tech, or see Managed vs BYOK.)

1. Have a NearSync org​

You need an account in a NearSync organization — a managed trial or your own BYOK deployment. Everything below is scoped to that org.

2. Mint an API key​

In the admin app: System → API Keys → Create key. Give it a name, pick its scopes (e.g. invoices:read, contacts:read, analytics:read), and copy the key — it's shown once.

ns_live_xxxxxxxx_yyyyyyyy

See Authentication for the scope list and how keys map to data.

3. Call the API​

The public surface is read-only REST at https://api.nearsync.tech/v1. Pass the key as a bearer token:

curl https://api.nearsync.tech/v1/invoices?limit=5 \
  -H "Authorization: Bearer ns_live_xxxxxxxx_yyyyyyyy"
{ "data": [ /* … */ ], "has_more": false, "next_cursor": null }

Browse every endpoint in the API Reference.

4. Connect an AI agent (MCP)​

Add NearSync as a remote MCP connector in Claude / ChatGPT / Gemini:

https://api.nearsync.tech/mcp

Sign in once to authorize, and the agent can answer questions over your org's data — gated by your permissions. See the MCP Server guide.

Next steps​