We use cookies to enhance your experience and measure how the site performs. Choose "Essential Only" to disable analytics. Read our Privacy Policy.

    Odeus Docs

    Sharing Agents with API Keys

    Learn how to create an API key in Odeus and share an agent with it for programmatic access.

    Sharing Agents with API Keys

    Learn how to create an API key in Odeus and share an agent with it for programmatic access.

    This is the Agents API with native Vercel AI SDK compatibility.

    An admin needs to create the API key and share the agent with it. If you're not an admin, invite one as an editor to your agent using the "Share" button.

    How to create an API key

    1. Navigate to Odeus and open the workspace settings from the dropdown menu.

      Navigate to workspace settings

    2. Click on API under Products in the sidebar.

      Go to API settings

    3. Click Create API key, enter a name, select the required scopes (at minimum "Assistant API"), and confirm.

      Create new API key

    4. Copy your API key and store it securely. You won't be able to view it again.

      Save your API key

    How to share an agent with the API key

    1. Navigate to Agents in the sidebar.

      Navigate to Agents

    2. Create a new agent or select an existing one. Enter at least a name to save it.

      Create new agent

    3. In the agent editor, click the Share button in the top right corner.

      Edit agent and share

    4. The share dialog opens showing current access settings.

      Share dialog

    5. Search for your API key by name and add it to share the agent with the API.

      Invite API key

    Only admins can connect an agent with an API key. If you don't see API keys in the share menu, ask an admin to perform this step.

    Testing the API connection

    Once shared, you can test your agent via the Agent API documentation. Use your API key and the agent ID from the URL (https://app.odeus.ai/agents/AGENT_ID/edit).

    Odeus blocks browser-origin requests to protect your API key. For more information, see our guide on API Key Best Practices.

    Using MCP: You can also access your agents via the Odeus MCP Server. This lets MCP-compatible AI clients (like Claude Desktop or Cursor) call your agents directly.