API 概要

すべてのエンドポイントは https://apirouter.pleum.ai/v1 配下にあり、OpenAI API と互換性があります。

Base URL#

base url

https://apirouter.pleum.ai/v1

OpenAI SDK を使用する場合は、上記のアドレスを base_url（Python）または baseURL（JS）に設定してください。

すべての推論リクエストは Authorization ヘッダーに API キーを含めて送信します。 API キーはダッシュボード → API キーで発行し、plm_ プレフィックスで始まります。

header

Authorization: Bearer plm_xxxxxxxxxxxxxxxx

API キーは発行時に一度だけ表示され、サーバーにはハッシュのみが保存されます。キーが漏えいした場合はダッシュボードから直ちに無効化してください。キーごとに許可モデルと月次予算上限を制限できます。

POST/v1/chat/completions

チャット補完を生成します。リファレンス →

GET/v1/models

利用可能なモデル一覧と価格を取得します。リファレンス →

GET/v1/credits

クレジット残高を取得します。リファレンス →

GET/v1/fx-rate

本日適用中の USD/KRW 為替レートを取得します（韓国輸出入銀行の売買基準レート）。認証は不要です。

POST/v1/3d/generations

BytePlus ModelArk に非同期 3D 生成タスクを送信します。リファレンス →

エラーは HTTP ステータスコードとともに detail フィールドで返されます。構造化エラー（クレジット不足など）には error コード文字列が含まれます。

402 Payment Required

{
  "detail": {
    "error": "insufficient_credits",
    "message": "Insufficient credits: 120 credits < 540 credits"
  }
}

すべてのエラーコード一覧はエラーコードのドキュメントを参照してください。