AI Agents

Clarify ships a skill that teaches your agent how the API works: the base URL, authentication, JSON:API conventions, and the OpenAPI contract. Install it once and your agent can scaffold integrations, query data, and write records for you.

Install the skill

npx skills add clarifyhq/skills

This works with Claude Code, Cursor, and any agent that supports the skills format.

Connect your agent to your workspace

The skill provides the conventions; you still need to give the agent access to your data. There are two ways to do that.

Clarify's MCP server

Clarify hosts a Model Context Protocol server, so any MCP-compatible client (Claude Code, Claude Desktop, Cursor, Windsurf, or a custom agent) can call the API directly. Point your client at:

https://api.clarify.ai/mcp

Authenticate with a Personal API key, sending it alongside your workspace slug:

Authorization: api-key YOUR_API_KEY
X-Clarify-Workspace: your-workspace

Partner integrations can authenticate with OAuth 2.0 instead. Only Personal keys are accepted; workspace keys are rejected.

Direct API access

Give the agent your API key and workspace slug and let it issue curl or fetch requests against the base URL:

https://api.clarify.ai/v1/workspaces/{slug}/*

This needs no extra setup beyond the skill, and works with any agent that can run shell commands.

Example prompts

Once the skill is installed, try prompts like:

"List the companies in my workspace created this week."
"Create a person record for jane@example.com named Jane Doe."
"Show me every open deal over $50k and its stage."
"Import this CSV of leads as person records."

Tips

Install the skill first. It saves the agent from guessing the JSON:API envelope or the api-key auth scheme.
Share the OpenAPI spec. Point the agent at the OpenAPI spec so it knows every endpoint and field. The same spec powers the API Reference.
Start with read operations. Confirm the agent reads data correctly before letting it write or delete.
Watch for api-key auth. Most agents default to Bearer unless you tell them otherwise; Clarify uses the api-key scheme.
Mention collection fields. The { "items": [...] } format for multi-value fields like email_addresses and domains isn't a common API pattern, so agents tend to miss it.
Use --globoff with curl. Filter and pagination brackets (filter[...], page[...]) trigger curl's URL globbing; --globoff turns it off.

Custom integrations

Building your own assistant? Feed the OpenAPI spec to a custom GPT or your own agent framework to generate a tool definition per endpoint. Tools like Postman and Insomnia can import the same spec to give you a ready-made request collection.