AI 安装引导 | API 文档

AI 接入提示词

You are integrating with API Hop's public APIs.

Base URL:
https://api.apihop.ai

Canonical Base URL for this session:
https://api.apihop.ai

When creating the skill, store this exact Base URL string. Do not replace it with another URL.

API Key:
<API_KEY>

Authentication:
Use the same Bearer API Key for every request:
Authorization: Bearer <API_KEY>

AI installation guide and public API docs:
https://apihop.ai/cn/docs/api-reference/ai-installation-guide

Machine-readable public API catalog:
https://apihop.ai/docs/public-api-catalog.json

Documentation fallback rule:
First open the AI installation guide URL above. If the hash-routed docs page cannot be read directly by fetch, you MUST fetch this exact machine-readable catalog URL:
https://apihop.ai/docs/public-api-catalog.json

Do not guess endpoints, parameters, response shapes, streaming events, pagination, or errors from memory, old docs, training data, or unrelated local files.

Credential precedence:
The value <API_KEY> is a placeholder, not a credential. Ask the user to configure APIHOP_API_KEY locally through an environment variable or secret store. Never ask the user to paste a key into an AI conversation, or retrieve a full key from the console.

Your task:
Create a reusable agent skill for API Hop's public APIs. Paid or live API verification requires explicit user approval.

Skill name:
api-hop-public-api

Skill creation requirements:
1. If your environment supports persistent skills, plugins, tools, agent memory, custom instructions, or project rules, install this as a reusable capability named api-hop-public-api. Follow the current agent platform's official installation convention. If you cannot find one, create a SKILL.md or equivalent platform-specific skill spec in the current workspace or conversation.
2. Keep the skill lightweight. Do not copy the full installation guide or endpoint documentation into the skill. Store only the project name, the exact Base URL from this prompt, Bearer authentication rule, this installation guide URL, this exact catalog URL, and the workflow for reading docs on demand.
3. The skill must instruct future calls to open the installation guide URL first, read its public API documentation link list, then open only the endpoint docs needed for the current task. Tool integration docs such as Codex setup are helpful for configuring that tool, but they are not public API endpoint docs. If the hash docs page is not readable without a browser, you MUST fetch https://apihop.ai/docs/public-api-catalog.json. Treat the Public API Docs section and catalog as the source of truth for every public endpoint, parameter, response, streaming event, pagination rule, and error shape.
4. "Every public API" means every endpoint link under the Public API Docs section of the installation guide, including future links added there, and no endpoints outside those docs. Do not treat links under Tool Integration Docs as endpoints unless they also appear in Public API Docs or the machine-readable catalog.
5. The skill must preserve the API Hop project name from this prompt.
6. Do not put the API Key into the skill, generated source files, tests, logs, screenshots, or commits. Keep <API_KEY> as a placeholder in examples and instructions. Do not make a live request until a valid API Key is configured locally and the user explicitly approves the call. Recommend a local environment variable or secret store for credentials.

The skill content should be concise and roughly follow this structure:
- name: api-hop-public-api
- description: Use API Hop's public APIs by reading the official public API docs on demand.
- connection: Base URL https://api.apihop.ai. Store this exact Base URL string. Send Authorization: Bearer <API key from the current session or configured secret>.
- docs: Always open https://apihop.ai/cn/docs/api-reference/ai-installation-guide, read the Public API Docs section for endpoint docs, and optionally read Tool Integration Docs only when configuring a named tool such as Codex. If a browser-only hash URL cannot be fetched directly, fetch https://apihop.ai/docs/public-api-catalog.json. Do not guess.
- workflow: read docs -> build request -> call API -> parse response, errors, SSE events, pagination, and generated image URLs according to the endpoint docs.
- security: Never store or reveal the full API Key.

Runtime behavior requirements:
1. Do not make an API request while the Authorization value is <API_KEY>. Use the locally configured APIHOP_API_KEY without printing or exposing it.
2. Before calling an endpoint, read the installation guide and the relevant endpoint doc instead of relying on memory or copied documentation. If the installation guide cannot be fetched because it is a hash-routed page, fetch https://apihop.ai/docs/public-api-catalog.json before making any API call.
3. Implement or use SSE parsing for streaming endpoints and stop on completion signals described in the endpoint docs.
4. For paginated Twitter timeline APIs, read meta.next_token and send it back as pagination_token when fetching the next page.
5. For image generation, handle non-streaming responses with data[].url and streaming image_generation.completed events with final image URLs.
6. Implement unified error handling for flat OpenAI-compatible errors and Twitter errors shaped as { success: false, error, requestId }.
7. Only call endpoints listed in the installation guide's Public API Docs section or the machine-readable catalog.
8. Before any explicitly approved verification call, confirm the request URL starts with https://api.apihop.ai and the Authorization header uses the locally configured credential without displaying it.
9. After explicit user approval and local credential setup, make one minimal verification call through the skill using a model confirmed available to the current account. Read the endpoint documentation and agree on the model and request first; do not copy endpoint docs into the skill. If the call returns 401 or an invalid/expired token error, ask the user to update their local credential configuration. Do not retry with another stored key. For any failure, report the HTTP status, redacted response body, and likely next step without revealing the full API Key.

复制「AI 接入模板」并交给 AI 工具。所有 AI 接入模板固定使用 <API_KEY>，不会读取或包含账户密钥。

在提示词中保留 <API_KEY>，通过本地环境变量或密钥存储配置 REQUESTBEAM_API_KEY。不要把真实密钥粘贴进 AI 对话、仓库、日志或截图。

AI 友好接入

使用本页顶部的「AI 接入模板」入口。复制模板不会选择或读取密钥。

准备接入时，请登录控制台并到 API Keys 页面管理密钥，在提示词之外安全保存凭据。

使用步骤

登录控制台，到 API Keys 页面创建新 Key。
将密钥存入本地环境变量或密钥存储。「复制给 AI」只会复制接入说明与 <API_KEY> 占位符，不会复制密钥。
将占位符模板粘贴给 AI 工具生成接入代码。确认模型、请求和预计费用后，再明确批准任何收费或线上验证。

工具接入文档

Codex 接入：Codex base_url = https://api.apihop.ai/openai
Claude Code 接入：Claude Code ANTHROPIC_BASE_URL=https://api.apihop.ai/anthropic

文本模型指南

DeepSeek 模型：V4 Flash / V4 Pro
Gemini 模型：3.6 Flash / 3.7 Flash / 3.8 Flash / 3.5 Flash-Lite
Kimi 模型：Kimi K3
MiniMax 模型：MiniMax M3

公开接口文档

如果目标 AI 无法直接读取本页渲染后的内容，也可以读取机器可读目录：/docs/public-api-catalog.json。

模型目录：GET https://api.apihop.ai/v1/models
错误码与错误处理：错误枚举、重试边界和脱敏排查模板
通用对话接口：POST https://api.apihop.ai/v1/chat-completions
OpenAI 多模态 Responses：POST https://api.apihop.ai/openai/responses
GPT-Image-2 图像生成：POST https://api.apihop.ai/openai/v1/images/generations
Seedance 2.0 视频生成：POST https://api.apihop.ai/v1/video/seedance
Seedance 2.5 视频生成：POST https://api.apihop.ai/v1/video/seedance
查询异步任务：GET https://api.apihop.ai/v1/jobs/{id}
Claude Messages：POST https://api.apihop.ai/anthropic/v1/messages
根据用户名获取用户：GET https://api.apihop.ai/v1/twitter/users?username=...
根据 ID 获取用户：GET https://api.apihop.ai/v1/twitter/users/{id}
获取用户时间线：GET https://api.apihop.ai/v1/twitter/users/{id}/tweets