Workspace

API access: connect your AI agent to Heythere's API

Let an agent or one of your services call Heythere's API as you, with a token you approve or a key you create, and take that access back anytime.

An online shop's owner wants Claude to write the Ember jacket news, and the shop's CRM to read its contacts. Both call Heythere's API as the owner, in every organization the owner belongs to, each with its own credential:

  • An access token, which an agent obtains once you approve it. The agent connects over MCP or REST, and the API llms.txt explains how. It lists every operation, and the agent reads the contract of the one it needs with getApiOperation, small enough to fit its context.

  • An API key, which you create in the console, on the API access page, for a service of yours that calls the REST API, such as that CRM.

Both go in the Authorization: Bearer header and act as you, with your role in each organization. Only you create an API key, from a signed-in browser. An agent never obtains one.

How do I create and store an API key?

Name the key after the service that uses it, and choose when it expires: after 30 days, 90 days, a year, or never. Heythere shows the key only once, at creation, so store it in your service's secrets right away. Afterwards, the console shows only its last four characters and when it was last used.

How do I take access back?

The API access page lists your API keys and the agents connected as you. Revoke a key, or disconnect an agent, and every later request with its credential is rejected with a 401. Each user holds at most 20 API keys and 20 connected agents.

In the API

Every operation is a REST endpoint and, unless marked REST only, an MCP tool of the same name. The OpenAPI document describes their parameters, payloads, and errors.

  • GET

    getApiOperation

    Get the contract of one operation

    /api/operations/{operationName}
  • GET

    getApiSchema

    Get one schema of the API

    /api/schemas/{schemaName}