← Docs/

§ 快速开始 · Quickstart

5 分钟接入.

从注册到第一次 API 调用. 三协议任选, 你已有的 SDK 改一行 baseURL 就能用.

01

注册 + 拿 key

访问 /register 注册. 邮箱 + 密码, 不绑卡, 默认 Free 套餐 (100 次/月).

注册成功后会自动登录并进入控制台. 在控制台点 创建新 Key 拿到一个 hipmm_sk_xxx 形式的密钥.

只显示一次

API key 在创建那一刻只在屏幕上显示一次. 请立即复制保存到 1Password 或你的 secret manager. 离开页面后无法再查看.
02

选一个 SDK / 协议

HiPMM Engine 同时讲三种 wire protocol, 选你团队已有的:

HiPMM 原生 · Python · 推荐

pip install hipmm

from hipmm import HiPMM
client = HiPMM(api_key="hipmm_sk_...")
result = client.codename.create(code="I-A-L-X-ID-AR(PR)-SE-LT")
print(result.data.short)  # 深思的孤勇者

Anthropic SDK · Python · 改 base_url

from anthropic import AsyncAnthropic
client = AsyncAnthropic(
    base_url="https://api.hipmm.com/v1",
    api_key="hipmm_sk_..."  # 用 HiPMM key, 不是 Anthropic key
)
msg = await client.messages.create(
    model="hipmm/codename",
    messages=[{"role": "user", "content": "I-A-L-X-ID-AR(PR)-SE-LT"}],
    max_tokens=1024,
)

OpenAI SDK · TypeScript · 改 baseURL

import OpenAI from "openai";
const client = new OpenAI({
  baseURL: "https://api.hipmm.com/v1",
  apiKey: "hipmm_sk_..."
});
const r = await client.chat.completions.create({
  model: "hipmm/codename",
  messages: [{ role: "user", content: "I-A-L-X-ID-AR(PR)-SE-LT" }]
});
03

第一次调用 (curl)

跳过 SDK, 直接 HTTP:

bash

curl -X POST https://api.hipmm.com/v1/codename \
  -H "Authorization: Bearer hipmm_sk_..." \
  -H "Content-Type: application/json" \
  -d '{"code": "I-A-L-X-ID-AR(PR)-SE-LT"}'

预期返回:

response · 200 OK · 1 unit

{
  "success": true,
  "data": {
    "short": "深思的孤勇者",
    "long": "深思的颠覆者 · 孤勇者",
    "portrait_type": "极端纯度型"
  },
  "metadata": {
    "engine_version": "0.3.0",
    "request_id": "req_a1b2c3d4...",
    "deterministic": true,
    "cost_units": 1,
    "cache_hit": false,
    "latency_ms": 4
  }
}
04

确认配额

每次调用扣 cost_units. 不同端点单价不同 (见 限流配额). 进控制台 → Usage 看本月已用 / 剩余.

Free 套餐 100 units / 月, 跑 100 次 codename 用满. 升级 Starter 5,000 / 月 / ¥99; Pro 100,000 / 月 / ¥999.

05

下一步

到这里你已经接入完成. 接下来推荐: