Composio API Key
On this page
Purpose
Arkus components that use Composio (Gmail, Google Calendar, Google Docs, Google Meet, Google Sheets, and Outlook) need a Composio project API key. This page shows how to create a key with the permissions those components need.
When to use it
- You are setting up a Composio-based component for the first time.
- A component says your Composio API key does not have the permissions it needs.
Required setup
- Open the Composio Dashboard.
- Select Platform, then select your project.
- Go to Settings, then open the API Keys tab.
- Select Create API Key and set these permissions:
| Permission area | Access level |
|---|---|
| Connected accounts | Read and write |
| Auth configs | Read and write |
| Tools | Read only |
| Toolkits | Read only |
| Tool execution (Legacy) | Write only |
- Copy the key once. Save it as an Arkus Credential and select that Credential in the component. Never put the key in a prompt, example, or image.
Composio's project API key permissions page describes every permission area. A key with "No access" to an area cannot use that part of Composio.
How to use it
- Select the saved Credential in the Composio API Key field of the component.
- Connect the provider account using the component's authorization flow. The provider grant is separate from the Composio key.
- Run the component or enable its actions.
Configuration
| Setting | What it controls | Recommended starting point |
|---|---|---|
| Composio API Key | The Composio project key the component uses to reach Composio. | Select a saved Credential for a key with the permissions above. |
Expected result
The component can connect the provider account, load its actions, and run them.
If a component reports that your Composio API key does not have the permissions it needs, create a new key with the permissions above, save it as a Credential, and select it.
Reference details
- This error is about the Composio key only. A failed Google or Microsoft sign-in is a provider problem and is fixed by reconnecting the account.
- A deployed flow uses the owner's saved Credential. Update that Credential and the next run uses it.
Works well with
Gmail, Google Calendar, Google Docs, Google Meet, Google Sheet, and Outlook.