Skip to main content
アカウントとキーは、引き続きコンソールでご自身で作成する必要があります。「キーを取得した」から「コードが動作する」までのすべてを、以下の3つの方法のいずれかを通じてAIに任せられます。

​
パスを選択

スキル · チャットエージェント

OpenClaw、Claude Codeなど、スキルシステムを備えたエージェントです。スキルを一度インストールすれば、自然言語でAPIYIを呼び出せます。

CLI · ターミナル

コードは不要です。キーを確認し、モデルを一覧表示し、メッセージを送信して、ターミナルから画像を生成できます。npx apiyi@latest checkのインストールは不要です。

開発キット · コーディングエージェント

Cursor、Claude Code、Codexは、統合コードを書く前にコントラクトとモデルレジストリを読み込みます。存在しないエンドポイントを作ることはありません。

​
キットの内容

すべてのファイルは公開されています。ログインは不要で、どのエージェントからでも直接取得できます。
このページのプレーンテキスト版は https://docs.apiyi.com/en/developer-kit.md です。

​
コーディングエージェント向けルール

コーディングエージェントで最もよくある失敗は、コードが悪いことではありません。記憶を頼りに書くことです。存在しないエンドポイントを作り出したり、gpt-5-4-miniの代わりにgpt-5.4-miniと入力したり、Anthropic SDKのベースURLに余分な/v1を追加したりすることです。次の5つのルールで防止できます。
  1. エンドポイント、パラメータ名、列挙値、レスポンス形式を作り出さないでください。 skill.mdエンドポイント表に記載されたパスだけを使用してください。パラメータは、使用するプロトコル（OpenAI、Anthropic、Gemini）の公式定義に従います。
  2. model-registry.jsonをモデル IDの唯一の信頼できる情報源とします。 IDはドット区切りのバージョン表記で、大文字と小文字が区別されます。ドキュメントURL内のハイフンはURLで安全に使用するための置き換えであり、モデル IDではありません。
  3. ベースURLはモデルではなくSDKで選択してください。 OpenAI SDKではhttps://api.apiyi.com/v1を使用し、Anthropic SDKではルートのhttps://api.apiyi.comを使用します。Google GenAI SDKでは、ルートにapi_versionを設定し、その値をv1betaにします。
  4. キーはAPIYI_API_KEY環境変数からのみ読み取ってください。 ハードコードしたり、コミットしたり、チャットに貼り付けたりしないでください。
  5. まず説明し、その後に編集してください。 エージェントに、使用するエンドポイント、モデル、タイムアウトを伝えさせます。あなたが確認してからコードを編集させてください。

Cursor、Claude Code、Codex、その他のコーディングエージェント向けの完全なプロンプトです。そのままコピーして貼り付けてください。

​
スキル

本スキルは skill.md そのものであり、マシン向けに書かれた統合リファレンスです。一度インストールすれば、エージェントは APIYI を呼び出す必要があるときにいつでもこれらのルールを思い出します。インストール方法は3通りあります：
Claude Code、Cursor、Codex、および Agent Skills 仕様をサポートするその他のツール向け：
検出はこのサイトの /.well-known/agent-skills/index.json を経由して行われます。これにより、スクリプトなしで skill.md 自体がインストールされます。セルフチェックには npx apiyi@latest check を使用してください。

OpenClaw、Claude Code、Cursor、およびスキルをサポートするその他のエージェント向け。そのままコピー＆ペーストしてください。

​
キーがエージェントに渡る仕組み

  • 環境変数 APIYI_API_KEY が最優先されます。 スキル、CLI、および本ドキュメントのすべてのサンプルはそこから読み取ります。
  • OpenClaw は、キーを ~/.openclaw/openclaw.json 内の skills.entries.apiyi.apiKey に保存し、実行時に APIYI_API_KEY として注入します。これはスキルのフロントマターにある primaryEnv フィールドで宣言されているものです。ファイルレイアウトについては、OpenClaw 設定ファイルを参照してください。
  • CLI は、npx apiyi@latest auth set-key を使用してパーミッション 0600 で ~/.config/apiyi/config.json に保存します。

​
セルフチェックのステータス

スキルのスクリプト、CLI、および手動の curl はすべて同じステータスセットを返します：
通常の sk- キーでは残高を読み取ることができないため、no_balance ステータスは存在しません。残高とログには別の認証情報であるパーソナルアクセストークン（nap_ で始まるもの）が使用されます。パーソナルアクセストークンとは？を参照してください。429 はレート制限または残高不足のいずれかを意味する可能性があります。エージェントは推測せず、コンソールを案内する必要があります。

​
CLI

コードを書かずに、ターミナルから最初のリクエストを実行できます。Node 18以降であれば、インストールは不要です。
npx は apiyi コマンドをインストールせずに CLI を実行します。以下の表では、コマンドを簡潔にするため apiyi … と表記しています。npx では npx apiyi@latest … を使用してください（例：npx apiyi@latest auth set-key）。apiyi をそのまま入力するには、npm i -g apiyi で一度インストールしてください。ターミナルに「apiyi コマンドが見つかりません」と表示されるのはなぜですか？を参照してください。

ターミナルコマンドを実行できるエージェントに依頼するか、自分で以下の行を実行してください。

​
コマンド

グローバルフラグ：--api-key、--access-token、--node api|vip|b|cf（ノードを選択）、--base-url、--timeout、--json（機械可読形式の出力）。

​
キーの検索順序

--api-key フラグ、次に APIYI_API_KEY 環境変数、次に ~/.config/apiyi/config.json、最後に OpenClaw の ~/.openclaw/openclaw.json の順です。OpenClaw のスキルをすでにインストールしている場合、CLI はそのキーを再利用します。

​
終了コード

スクリプトやエージェントは、テキストを解析する代わりに終了コードで処理を分岐できます。 ソースコードは github.com/apiyi-com/cli にあり、npmパッケージは apiyi です。npx が古いバージョンをキャッシュするため、ドキュメントでは常に npx apiyi@latest と記載しています。

​
model-registry.json のフィールド

価格表が更新されるたびに、モデル価格ページと同じデータから再生成されます。トップレベルのフィールド： 各モデルエントリ：
レジストリ内の価格は定価です。チャージボーナスとグループ割引は含まれておらず、実際の課金はコンソールに従います。グループについては、グループの説明を参照してください。

​
関連ページ

はじめに

2つの方法があります。AIに統合させるか、自分で行います。

ワンクリック統合はありますか？

ボタンではなく、ドキュメントをAIに渡す形で利用できます。

OpenClaw

オープンソースのローカルAIアシスタントです。スキルをインストールすると、自然言語でAPIYIを呼び出せます。

モデルの料金

レジストリを人間が読みやすい形式にしたもので、ベンダーごとにグループ化し、段階的な料金を掲載しています。