skills.rest
simstudioai
simstudioaiOFFICIAL
Explore all skills by this author →
Website𝕏@simdotaiGitHub

add-hosted-key

Automate hosted API key support with BYOK provider registration and UI updates.

29.4k|3.8k|Updated Jan 5, 2025
Search Tags:#ui#pricing#security#hosting#tools#api-key#byok
One-click install
npx skills add https://github.com/simstudioai/sim --skill add-hosted-key
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: add-hosted-key
Source: https://github.com/simstudioai/sim/tree/main/.cursor/skills/add-hosted-key
Command: npx skills add https://github.com/simstudioai/sim --skill add-hosted-key

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Add hosted API key support to a tool so Sim provides the key when users don't bring their own, enabling BYOK, hideWhenHosted, and hosted key pricing for tools or blocks.

Core Features & Use Cases

  • Automates the integration of hosted keys into tool configurations, BYOK provider registration, and UI adjustments to hide API keys when hosted.
  • Supports end-to-end steps: register BYOK provider IDs, research pricing and rate limits, add hosting config to the tool, hide key fields when hosted, and update BYOK settings UI.

Quick Start

Register the BYOK provider, add hosting configuration to the tool (envKeyPrefix, apiKeyParam, byokProviderId, pricing, rateLimit), and hide the API key field when hosted.

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 hosted API key support to a tool?▼

To add hosted API key support, you register a BYOK provider ID, add a hosting configuration with envKeyPrefix, apiKeyParam, pricing, and rateLimit to the tool, and hide the API key field in the UI when hosted.

What does BYOK provider registration do for hosted keys?▼

BYOK provider registration links your tool to a specific provider ID so Sim can automatically supply hosted API keys to users who do not bring their own keys, enabling hideWhenHosted UI behavior and hosted key pricing.

Can I hide the API key field in the UI when a hosted key is provided?▼

Yes, you can hide the API key field when a hosted key is provided by applying the hideWhenHosted configuration during the UI adjustment step of the hosted key integration process.

What configuration parameters are required to set up hosted API keys?▼

Setting up hosted API keys requires a hosting config that includes envKeyPrefix, apiKeyParam, byokProviderId, pricing, and rateLimit to properly route and manage the automated key delivery.

How do I configure pricing and rate limits for hosted keys?▼

You configure pricing and rate limits for hosted keys by defining the pricing and rateLimit fields within the tool's hosting configuration after researching the appropriate values for your BYOK provider.

Does adding hosted keys work for tools and blocks that require API keys?▼

Yes, adding hosted keys works for both tools and blocks that require API keys, applying the same hosting config, BYOK provider registration, and UI adjustments across all supported components.

Related Skills

Explore More Software Engineering Skills→
tunacosguntunacosgun

add-hosted-key

Register BYOK providers and hosting configs to supply hosted API keys.

Community
Advanced
ZurybrZurybr

letta-configuration

Configure LLM models and providers for AI agents and servers.

Community
Intermediate
AdelEddaraiAdelEddarai

add-hosted-key

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

Community
Intermediate
bhanu91221bhanu91221
2

shield-encryption

Automate Salesforce Shield Platform Encryption setup, key management, and tenant secret rotation.

Community
Advanced