Clarify API
Getting Started

AI Assistants

Give your coding agent the context to build on Clarify

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.

Claude Code

You have two ways to connect Claude Code to your workspace:

  • MCP — run Clarify's MCP server so the agent can call the API directly with your credentials.
  • Direct API access — give the agent your API key and workspace slug and let it issue curl/fetch requests against the base URL.

Either way, the skill provides the conventions; your credentials provide the access.

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 their 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 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.

Cursor

Install the skill the same way (npx skills add clarifyhq/skills) and Cursor can generate Clarify integration code with the right conventions baked in.

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 also import the spec directly to give you a ready-made request collection.

On this page