velokey's picture
Update README.md
fb20526 verified
|
Raw
History Blame Contribute Delete
1.54 kB
---
title: VeloKey OpenAI-Compatible API Playground
emoji: ๐Ÿ”‘
colorFrom: blue
colorTo: green
sdk: gradio
sdk_version: 4.44.1
app_file: app.py
pinned: true
license: mit
short_description: Test VeloKey's API from Hugging Face
tags:
- openai-compatible
- ai-api
- llm
- gradio
- api-playground
---
# VeloKey OpenAI-Compatible API Playground
Test VeloKey's OpenAI-compatible AI model API directly from a Hugging Face Space.
This demo lets you:
- Send a chat completion request to `https://api.velokey.ai/v1/chat/completions`
- Use your own VeloKey API key without storing it in the Space
- Choose or enter a model ID available to your account
- Inspect the raw JSON response for debugging
- List models available through `GET /v1/models`
## How to use
1. Get a VeloKey API key from [velokey.ai/console/keys](https://velokey.ai/console/keys?ref=huggingface-space).
2. Paste the key into the API key field.
3. Click **List available models** if you are not sure which model ID to use.
4. Enter a prompt and click **Run chat completion**.
Your API key is only used for the request you send from this app. Do not paste production secrets into third-party apps unless you understand the risk.
## Resources
- [VeloKey website](https://velokey.ai?ref=huggingface-space)
- [API documentation](https://docs.velokey.ai/api/introduction)
- [Model catalog](https://velokey.ai/model?ref=huggingface-space)
- [Pricing](https://velokey.ai/pricing?ref=huggingface-space)
- [Get API key](https://velokey.ai/console/keys?ref=huggingface-space)