API Access

Want to connect your own website, app, or internal tool directly to an agent, rather than going through a built-in channel like Slack or WhatsApp? Minicrew provides a Messaging API your developers (or a technical teammate) can call. Each agent has its own API Access page showing exactly what’s needed.

Where to find it

Open an agent and look for API Access (sometimes labelled API Docs) in its toolbar. This page is specific to that one agent.

What’s on the page

• Your agent’s ID — a unique identifier shown at the top with a copy button. Every API request needs it to say which agent should handle the message.
• Reference documentation — a sidebar covering authentication, sending a message and getting a reply, receiving replies asynchronously via a callback URL, pushing a message to a customer without them messaging first (for reminders and alerts), listing your agents, pulling usage data, and the error codes your integration might need to handle.

This page is meant for whoever does the technical integration work. It’s essentially a developer reference built into the agent, generated specifically for your account.

Getting an API key

Every request to the API needs an API key. These are managed separately, at the workspace level rather than per agent; see API Keys & Integrations for how to create one. The API Access page links directly to where you manage keys.

Note

Before an agent can receive messages through the API, the API channel has to be turned on for it. That toggle lives on the agent’s Channels tab.

Tip

This site covers how to use the Minicrew app. The full technical API reference (request/response formats, field-by-field detail, code samples) lives on the agent’s own API Access page inside the app, since it’s tailored to your specific agent ID and account.