HopBase API
OpenAPI description of the HopBase multi-model API gateway: OpenAI-compatible chat, Responses, images and speech; Anthropic Messages; async video; account…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
OpenAPI description of the HopBase multi-model API gateway: OpenAI-compatible chat, Responses, images and speech; Anthropic Messages; async video; account endpoints. Image request bodies reference a per-model JSON Schema at https://hop-base.com/spec/models/ .json, generated from the gateway validation code. Generated by user-docs/docs-app/scripts/build-openapi.mjs; the docs API reference pages render from the same data.
Endpoints 24
Chat
- POSTCreate chat completion
/v1/chat/completionsGiven a list of messages, returns the model's reply. With the OpenAI SDK, just set the Base URL to https://api.hop-base.com/v1 and use an API key from the… - POSTCreate response
/v1/responsesOpenAI Responses-compatible endpoint; Codex CLI uses it. HopBase Responses is stateless: store is always false and previous_response_id is removed, so send… - POSTCreate message
/v1/messagesClaude models use the Anthropic protocol; DeepSeek, Qwen, and US-region (-us) models support it too, and for any other model its own page is authoritative.…
Images
- POSTCreate image
/v1/images/generationsGenerates images from a prompt. GPT Image and Gemini return data[].b64_json; Seedream returns data[].url by default (valid for 24 hours) and can also use… - POSTEdit image
/v1/images/editsGenerates from reference images or edits locally. multipart/form-data is recommended (local files; reference image field image / image[], repeatable); JSON is… - GETGet image task
/v1/images/tasks?task_id=stringCreate image or Edit image with Prefer: respond-async returns 202 and a task_id immediately; then query it with this endpoint. The task ID can only go in the…
Video
- POSTSubmit video task
/v1/video/generateSeedance, MiniMax, Kling and Grok video share this single submission endpoint. HopBase routes each request to the matching family based on the request's model… - GETGet video task
/v1/video/tasks/:task_idPoll with the task ID returned at submission, ideally every 5 seconds; polling uses no concurrency and is not billed. Seedance / Grok responses are wrapped in… - GETList video tasks
/v1/video/tasksLists tasks submitted through the API, paginated (tasks submitted from the console Studio are excluded). Each element is a task object with the same shape as… - GETList custom subjects
/v1/kling/subjectsReturns the list of existing custom subjects. Takes no query parameters and is not billed. To check whether a creation has finished and get the new subject's… - POSTCreate custom subject
/v1/kling/subjectsimage_refer needs one frontal image plus 1–3 supporting reference images; video_refer needs one video and can optionally bind a voice_id. The fields of the… - POSTLip-sync face identification
/v1/kling/facesSynchronous endpoint, billed per call. The result contains a session ID, face IDs and each face's StartTime / EndTime (milliseconds), valid for 24 hours. In…
Speech
- POSTCreate speech
/v1/audio/speechSynthesizes text into audio synchronously; the response is the audio itself, with no task to poll. Works directly with the OpenAI SDK's audio.speech.create;… - POSTCreate T2A v2 audio
/v1/t2a_v2Takes the MiniMax T2A v2 request body as is, so official SDK code works after changing the Base URL and key; fields the gateway does not know pass through… - POSTUpload clone audio
/v1/files/uploadSubmitted as multipart/form-data with only the purpose and file fields; any other field returns 400. voice_clone is the recording to clone, and prompt_audio… - GETList clone audio
/v1/files/list?purpose=voice_cloneReturns only files you uploaded that have not been used for a clone and have not expired (within 24 hours of upload), filtered by purpose. Uploaded audio… - GETRetrieve clone audio
/v1/files/retrieve?file_id=1Only returns files you uploaded that are still valid; files already used for a clone or older than 24 hours return 404. - POSTDelete clone audio
/v1/files/deletefile_id and purpose must match the upload. Deleting a file does not affect voices already cloned; a successful clone already deletes the source files… - POSTCreate a cloned voice
/v1/voice_cloneMiniMax and Doubao share this path; HopBase routes by the request body and the key's group. The two request bodies and responses differ, so pick a series… - POSTList voices
/v1/get_voiceMiniMax and Doubao share this path; pick a series below to see its request body and response. MiniMax Speech 2.8: voice_type voice_cloning lists your cloned… - POSTDelete voice
/v1/delete_voiceMiniMax and Doubao share this path; pick a series below to see its request body and response. MiniMax Speech 2.8: Only cloned voices can be deleted, and…
Account and catalog
- GETList models
/v1/modelsThe list contains only models in the key's groups (for a key with several groups, the union of all of them) and is returned in full in one response (no… - GETGet balance and quota
/v1/usagebalance is what this key can spend right now: without a key quota it is the account balance; with a key quota it is the key's remaining quota. Keys of team… - GETPublic model catalog
/api/v1/models/pricingNo key required. Any site may read the response cross-origin, and it is cached for up to 5 minutes (Cache-Control: public, max-age=300). Prices are USD list…
API details
- Base URL
https://api.hop-base.com- Authentication
- A bearer token in the Authorization header
An API key in the x-api-key header - Operations
- 24 operations on 23 pathsPOST 15GET 9
- Main resources
- Speech 9Video 6Account and catalog 3Chat 3Images 3
- Response formats
application/jsonaudio/mpeg- Description format
- OpenAPI 3.1.0, API version
2026-09-25 - Links
- OpenAPI document
- Listed from
- Hop Base's published OpenAPI description
How to test the HopBase API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the HopBase API collection, without the publisher's secrets.
- Add your credentialsThis API uses A bearer token in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Create chat completion” (POST /v1/chat/completions), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the HopBase API?
OpenAPI description of the HopBase multi-model API gateway: OpenAI-compatible chat, Responses, images and speech; Anthropic Messages; async video; account… It is listed under AI & machine learning and has 24 endpoints.
Who publishes the HopBase API?
It is listed from HopBase's public API description (an OpenAPI document), not published by HopBase on Swastik Codes. Anyone who controls hop-base.com can claim the profile by adding a DNS TXT record.
What is the base URL of the HopBase API?
Requests go to https://api.hop-base.com. Endpoint paths are added to this base URL.
How do I authenticate with the HopBase API?
It accepts 2 methods: A bearer token in the Authorization header; an API key in the x-api-key header.
How many endpoints does the HopBase API have?
24 operations on 23 paths (15 POST, 9 GET). The largest groups are Speech, Video, Account and catalog, Chat.
Is forking the HopBase API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.