add-hosted-key

Configure hosted API key injection and metered billing for Sim tools.

1|Updated Jun 11, 2025
One-click install
npx skills add https://github.com/AdelEddarai/agent --skill add-hosted-key-adeleddarai
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: add-hosted-key
Source: https://github.com/AdelEddarai/agent/tree/main/.agents/skills/add-hosted-key
Command: npx skills add https://github.com/AdelEddarai/agent --skill add-hosted-key-adeleddarai

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires envKeyPrefix, apiKeyParam, byokProviderId, and includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill facilitates the addition of API key hosting for a tool, ensuring that Sim provides the API key when a user doesn't bring their own, and bills the workspace for metered usage.

Core Features & Use Cases

  • API Key Hosting: Automatically injects API keys from Sim when the user does not provide one.
  • Billing Transparency: All API key usage is metered and billed to the workspace, ensuring cost transparency.
  • Use Case: For tool administrators looking to enhance a tool with Sim's key management features without the complexity of BYOK.

Quick Start

To enable hosted API key support for a tool, run the 'add-hosted-key' skill and follow the instructions in the SKILL.md file.

Frequently Asked Questions about add-hosted-key

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I add metered API key support for a tool using Sim-hosted keys?

To add metered API key support, run the 'add-hosted-key' skill and follow the SKILL.md instructions to configure hosting parameters, pricing models, and rate limits. This automatically injects Sim-provided API keys when users do not supply their own.

How does metered billing work with Sim-hosted API keys?

Metered billing tracks all API key usage injected by Sim and bills the workspace accordingly. This ensures cost transparency by automatically charging the workspace for metered usage when a user does not bring their own API key.

What configuration do I need to set up hosted API keys in Sim?

Setting up hosted API keys requires configuring environment variables and parameters such as 'envKeyPrefix', 'apiKeyParam', and 'byokProviderId'. You must also define pricing models and rate limits to manage key distribution and cost tracking.

Can I use Sim-hosted keys instead of building a Bring Your Own Key (BYOK) integration?

Yes, Sim-hosted keys provide an alternative to complex BYOK setups by automatically managing key distribution. Tool administrators can use this feature to let Sim provide and inject API keys, billing the workspace for metered usage without requiring users to supply keys.

Does add-hosted-key work with existing tool configuration environments?

Yes, the skill integrates with existing tool configurations by leveraging environment setup and configuration management. It relies on setting specific parameters like 'envKeyPrefix' and 'apiKeyParam' to seamlessly inject API keys into the established workspace environment.