AF-01LIVE

LLM Inference API

公式 OpenAI SDK の base_urlapi_key を変えるだけで、Chat Completions とストリーミングを利用できます。

Endpoint
api.arcaneflux.com/v1
Protocol
REST / SSE
Compatibility
OpenAI SDK

01 / QUICKSTART

最初の API コール

OpenAI SDK の接続先とキーを変更し、成功レスポンスまでをこのページで確認します。

始める前に

  • LLM Inference API を利用できる ArcaneFlux アカウント
  • Secret を保存できるローカル環境
  • Node.js 18 以降、または curl

1. API キーを設定

キーをソースコードやシェル履歴へ直接残さず、環境変数または Secret Store から読み込みます。

SHELL
export ARCANEFLUX_API_KEY="your_api_key"

2. OpenAI SDK を接続

公式 SDK の baseURLapiKey だけを ArcaneFlux へ向けます。

JAVASCRIPT
import OpenAI from "openai";

const client = new OpenAI({
  apiKey: process.env.ARCANEFLUX_API_KEY,
  baseURL: "https://api.arcaneflux.com/v1"
});

3. リクエストを送信

JAVASCRIPT
const response = await client.chat.completions.create({
  model: "af-llm",
  messages: [{ role: "user", content: "Hello" }]
});

console.log(response.choices[0].message);

確認する項目

  • HTTP ステータスと応答本文
  • モデル識別子と usage
  • コンソールに記録された request ID と利用量

4. 運用前チェック

  • キーを開発、CI、本番で分離する
  • timeout と再試行回数に上限を設ける
  • request ID と失敗理由をログへ残す
  • キーの失効とローテーション手順を決める

02 / OPERATIONS

Usage & quota

利用量と上限は製品・API キー・期間を同じ基準で確認します。

コンソールでは製品、API キー、期間から利用記録を絞り込みます。障害調査では request ID と発生時刻を控えてください。

Limits & retry

Rate limit と利用可能枠はプランおよび API キーの Quota によって異なります。

429 の判定
HTTPcodeAction
429rate_limit_exceededRetry-After 後に指数バックオフで再試行
429insufficient_quota残高の追加またはプラン変更後に再開

03 / API REFERENCE

API Reference

認証、Chat Completions、Models、ストリーミング、上限、エラー形式を実装単位で確認します。

Base URL

TEXT
https://api.arcaneflux.com/v1

Authentication

HTTP Authorization ヘッダーへ Bearer API key を設定します。

HTTP
Authorization: Bearer $ARCANEFLUX_API_KEY

Endpoints

一期の対応エンドポイント
MethodPathPurpose
POST/chat/completionsChat 形式の応答を生成
GET/models利用可能なモデルを取得

Chat request

主要なリクエスト項目
FieldTypeRequired
modelstringYes
messagesarrayYes
streambooleanNo
stream_options.include_usagebooleanNo

Streaming

stream: true を指定すると SSE chunk を順次返します。利用量が必要な場合は最後の chunk まで読み取ります。

Errors

エラーコード
HTTPcodeClient action
401invalid_api_keyキーと Authorization 形式を確認
403subscription_required対象製品を開通
404unknown_productBase URL とパスを確認
429rate_limit_exceededRetry-After 後に再試行
502upstream_errorrequest ID を保存して再試行
504upstream_timeouttimeout と再試行上限を確認
JSON
{
  "error": {
    "code": "invalid_api_key",
    "message": "...",
    "request_id": "req_..."
  }
}

04 / SUPPORT

Frequently asked questions

接続できない場合は、設定値を順に切り分けます。
認証エラーになる

キーの値、失効状態、有効期限、Authorization 形式を確認します。

Rate limit が返る

エラー code で QPS 超限と利用枠不足を分け、Retry-After の有無を確認します。

利用記録が見つからない

対象製品、API キー、時間範囲、request ID を確認します。

05 / RELEASE NOTES

Product updates

仕様変更は影響範囲と適用日を明示してこの章へ追記します。