Onboard an AI agent

Give your coding agent the current API reference and a workspace API key. Start with a read request, then connect one customer record. You do not need an SDK, CLI, MCP server, or skill package for this path.

Get an API key

In your space, open Settings → Developers → API keys and create a key. Store the value in your agent environment as MAXCLICKS_API_KEY; keep it out of source files and browser code. The key inherits its owner's permissions. See authentication.

Ask your agent to use this brief:

Use the maxclicks API reference at https://docs.maxclicks.ai/api and its HTTP quickstart. Read MAXCLICKS_API_KEY from the environment. First call GET /v1/me and confirm the workspace. Then list schemas and read the contact schema's attributes. Show me the fields and requirements before writing a record. Do not send email or trigger a workflow as part of this setup.

curl --fail-with-body https://api.maxclicks.ai/v1/me \
  -H "Authorization: Bearer $MAXCLICKS_API_KEY"

The response should identify your intended workspace in data.space. Continue with the HTTP quickstart to upsert a test contact and send a prepared template. Give the agent the error and idempotency references when you add writes.

Install the agent skills

Install the skills to give your agent the maxclicks data model and integration conventions:

npx skills add https://maxclicks.ai

Start with the maxclicks skill, then add the skills for the areas you are working with. See Agent Skills for the full catalog.

Connect the MCP server

Use MCP to give your assistant callable tools. Connect to https://mcp.maxclicks.ai/mcp and approve the connection when maxclicks opens in your browser, or send an API key; in a client that supports local stdio, use npx -y maxclicks-mcp with your key. The MCP reference includes configuration and the tool list.

After connecting, call whoami, list_schemas, and list_attributes. These establish the workspace and data model before any write.

Use the CLI

Install the CLI for terminal automation:

npm install -g maxclicks-cli
maxclicks login
maxclicks whoami

For an agent environment, set MAXCLICKS_API_KEY instead of using interactive login. The CLI reference documents configuration, commands, and JSON output.

For application code, choose an SDK for your language.