開発者向けAPIリファレンス
ご自身のアプリをワークスペースにつなぐためのREST API、キーとスコープ、エラー、レート制限、Webhookの説明です。
場所
⚙️ 設定 › APIリファレンス · ホームページ › リソース › APIリファレンス
この画面を開く
ステップ
- サイドバーの「APIリファレンス」、またはホームページの「リソース」メニューの「APIリファレンス」を開きます。
- まず「はじめに」の「ベースURLと共通仕様」、「認証」、「スコープ」を読みます。
- 「エンドポイント」をグループごとに確認します。各エンドポイントに、パラメーター、リクエスト本文、レスポンス、エラーが例とともに載っています。
- 本番で使う前に、「エラーとステータスコード」、「レート制限」、「Webhook(送信)」を読みます。「OpenAPI JSON」で仕様全体をダウンロードできます。
トラブルシューティング
APIキーはどう入手しますか?
キーはご依頼に応じてワークスペースごとに発行します。アプリ内ではまだ作成できません。ワークスペースのキーはAI分野の開発者向けページに一覧され、ワークスペースの管理者はそこでWebhookの送信先の追加とテストもできます。
ヒント
- APIはサーバーからだけ呼び出してください。キーをWebページやモバイルアプリに入れないでください。
知っておきたいこと
- APIリファレンスはサインインしなくても読めます。
このガイドについて Synthia に質問する
自由な言葉で質問してください。Synthia はこのガイドの内容だけから答え、手順の記事へのリンクを示します。ガイドに載っていないことは、載っていないとお伝えします。
このページを共有
チャットアプリやSNS(LINE、Slack、X、Facebook、iMessage など)は、リンクごとに1つのプレビューを、リンクの言語で作ります。受け取る人それぞれの言語にはなりません。相手の言語でプレビューを表示したいときは、その言語のリンクをコピーして送ってください。