text stringlengths 0 59.1k |
|---|
| Scaleway | `scaleway` | `SCALEWAY_API_KEY` | [Docs](https://www.scaleway.com/en/docs/generative-apis/) | |
| SiliconFlow | `siliconflow` | `SILICONFLOW_API_KEY` | [Docs](https://cloud.siliconflow.com/models) | |
| SiliconFlow (China) | `siliconflow-cn` | `SILICONFLOW_CN_API_KEY` | [Docs](https://cloud.siliconflow.com/models) | |
| submodel | `submodel` | `SUBMODEL_INSTAGEN_ACCESS_KEY` | [Docs](https://submodel.gitbook.io) | |
| Synthetic | `synthetic` | `SYNTHETIC_API_KEY` | [Docs](https://synthetic.new/pricing) | |
| Together AI | `togetherai` | `TOGETHER_API_KEY` | [Docs](https://docs.together.ai/docs/serverless-models) | |
| Upstage | `upstage` | `UPSTAGE_API_KEY` | [Docs](https://developers.upstage.ai/docs/apis/chat) | |
| v0 | `v0` | `V0_API_KEY` | [Docs](https://sdk.vercel.ai/providers/ai-sdk-providers/vercel) | |
| Venice AI | `venice` | `VENICE_API_KEY` | [Docs](https://docs.venice.ai) | |
| Vercel AI Gateway | `vercel` | `AI_GATEWAY_API_KEY` | [Docs](https://github.com/vercel/ai/tree/5eb85cc45a259553501f535b8ac79a77d0e79223/packages/gateway) | |
| Vivgrid | `vivgrid` | `VIVGRID_API_KEY` | [Docs](https://docs.vivgrid.com/models) | |
| Vultr | `vultr` | `VULTR_API_KEY` | [Docs](https://api.vultrinference.com/) | |
| Weights & Biases | `wandb` | `WANDB_API_KEY` | [Docs](https://weave-docs.wandb.ai/guides/integrations/inference/) | |
| xAI | `xai` | `XAI_API_KEY` | [Docs](https://docs.x.ai/docs/models) | |
| Xiaomi | `xiaomi` | `XIAOMI_API_KEY` | [Docs](https://platform.xiaomimimo.com/#/docs) | |
| Z.AI | `zai` | `ZHIPU_API_KEY` | [Docs](https://docs.z.ai/guides/overview/pricing) | |
| Z.AI Coding Plan | `zai-coding-plan` | `ZHIPU_API_KEY` | [Docs](https://docs.z.ai/devpack/overview) | |
| ZenMux | `zenmux` | `ZENMUX_API_KEY` | [Docs](https://docs.zenmux.ai) | |
| Zhipu AI | `zhipuai` | `ZHIPU_API_KEY` | [Docs](https://docs.z.ai/guides/overview/pricing) | |
| Zhipu AI Coding Plan | `zhipuai-coding-plan` | `ZHIPU_API_KEY` | [Docs](https://docs.bigmodel.cn/cn/coding-plan/overview) | |
<|endoftext|> |
# source: VoltAgent__voltagent/website/prompt-engineering-docs/usage.md type: docs |
--- |
title: Usage |
--- |
# Using Prompts in Agents |
This guide covers how to integrate VoltOps prompts into your VoltAgent agents, including setup, fetching prompts, using labels, template variables, and caching strategies. |
## Setup |
### Get API Keys |
<video controls loop muted playsInline style={{width: '100%', height: 'auto'}}> |
<source src="https://cdn.voltagent.dev/docs/voltop-docs/observability-settings.mp4" type="video/mp4" /> |
Your browser does not support the video tag. |
</video> |
1. Sign up at [console.voltagent.dev](https://console.voltagent.dev/) |
2. Navigate to Settings → [Projects](https://console.voltagent.dev/settings/projects) |
3. Copy your public and secret keys |
### Configure Environment |
```bash |
VOLTAGENT_PUBLIC_KEY=pk_your_public_key_here |
VOLTAGENT_SECRET_KEY=sk_your_secret_key_here |
``` |
### Initialize VoltOpsClient |
```typescript |
import { VoltOpsClient } from "@voltagent/core"; |
const voltOpsClient = new VoltOpsClient({ |
publicKey: process.env.VOLTAGENT_PUBLIC_KEY, |
secretKey: process.env.VOLTAGENT_SECRET_KEY, |
}); |
``` |
## Basic Usage |
Fetch prompts using the `prompts` helper available in dynamic instructions: |
```typescript |
import { openai } from "@ai-sdk/openai"; |
import { Agent, VoltAgent, VoltOpsClient } from "@voltagent/core"; |
const voltOpsClient = new VoltOpsClient({ |
publicKey: process.env.VOLTAGENT_PUBLIC_KEY, |
secretKey: process.env.VOLTAGENT_SECRET_KEY, |
}); |
const agent = new Agent({ |
name: "SupportAgent", |
model: openai("gpt-4o-mini"), |
instructions: async ({ prompts }) => { |
return await prompts.getPrompt({ |
promptName: "customer-support-prompt", |
}); |
}, |
}); |
new VoltAgent({ |
agents: { agent }, |
voltOpsClient: voltOpsClient, |
}); |
``` |
## Local Prompts (CLI Pull) |
You can pull prompts to local Markdown files and have agents load them before making |
network calls. This is useful for offline development or fast iterations. |
1. Pull prompts to disk: |
```bash |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.