AI Installation Guide | API Docs

AI integration prompt

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/en/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/en/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.

Copy the "AI-ready template" and give it to your AI tool. All AI integration templates use <API_KEY> and never read or include an account key.

Keep <API_KEY> in the prompt. Configure REQUESTBEAM_API_KEY locally through an environment variable or secret store. Never paste a credential into an AI conversation, repository, log, or screenshot.

AI-ready integration

Use the "AI-ready template" entry at the top of this page. Copying does not select or retrieve a key.

When you are ready to connect, sign in to the console and manage your credentials on the API Keys page. Save credentials securely outside the prompt.

Steps

Sign in to the console and create a new key on the API Keys page.
Store the key in a local environment variable or secret store. "Copy for AI" copies only the integration instructions and <API_KEY> placeholder, not the key.
Paste the placeholder template into your AI tool to generate the integration. Confirm the model, request and expected cost before explicitly approving any paid or live verification.

Tool Integration Docs

Codex Integration: Codex base_url = https://api.apihop.ai/openai
Claude Code Integration: Claude Code ANTHROPIC_BASE_URL=https://api.apihop.ai/anthropic

Text Model Guides

DeepSeek Models: V4 Flash / V4 Pro
Gemini Models: 3.6 Flash / 3.7 Flash / 3.8 Flash / 3.5 Flash-Lite
Kimi Model: Kimi K3
MiniMax Model: MiniMax M3

Public API Docs

If the target AI cannot read the rendered page directly, it can fetch the machine-readable catalog: /docs/public-api-catalog.json.

Model Catalog: GET https://api.apihop.ai/v1/models
Error Codes and Troubleshooting: error codes, retry boundaries, and a redacted diagnostic template
Common Chat Completions: POST https://api.apihop.ai/v1/chat-completions
OpenAI Multimodal Responses: POST https://api.apihop.ai/openai/responses
GPT-Image-2 Image Generation: POST https://api.apihop.ai/openai/v1/images/generations
Seedance 2.0 Video Generation: POST https://api.apihop.ai/v1/video/seedance
Seedance 2.5 Video Generation: POST https://api.apihop.ai/v1/video/seedance
Get Async Job: GET https://api.apihop.ai/v1/jobs/{id}
Claude Messages: POST https://api.apihop.ai/anthropic/v1/messages
Get Twitter User By Username: GET https://api.apihop.ai/v1/twitter/users?username=...
Get Twitter User By ID: GET https://api.apihop.ai/v1/twitter/users/{id}
Get Twitter User Timeline: GET https://api.apihop.ai/v1/twitter/users/{id}/tweets