開発者プラットフォーム

開発者プラットフォームは、Meshy APIとの連携に関するあらゆることを実行、モニタリング、設定できる場所です — コードを書かずにエンドポイントを試せるPlayground、アカウント上のすべてのAPIリクエストを網羅するダッシュボード、そしてAPIキーとWebhookの管理機能があります。


Overview

ウェブアプリから開発者プラットフォームを開くことができます。サイドバーは以下のように構成されています。

  • Build — エンドポイントをインタラクティブに試すためのPlayground。
  • Monitor — Usageダッシュボードとリクエストログ。
  • Configure — APIキーとWebhook。

Overviewページ自体では、新規アカウント向けに以下の3ステップ(キーの作成、Playgroundでのリクエストの試行、リクエストログでの結果の確認)を案内し、その後、自分のアカウントの活動状況を示す7日間の使用状況スナップショットと、Meshy APIの変更履歴の最新エントリを表示します。

開発者プラットフォームのOverviewページ。3ステップのはじめ方カード、7日間の使用状況スナップショット、最新のMeshy API変更履歴の更新が表示されている

APIを初めて使う方は、クイックスタートから始めてください。

Playground

Playgroundは、コードを書かずにエンドポイントを試せるインタラクティブなコンソールです。エンドポイントを選び、インラインガイダンスに従ってパラメータを入力し、送信するだけです — タスクはAPIと同じ非同期パイプラインで実行されるため、タスクがPENDINGからSUCCEEDEDへと移り変わる様子を確認でき、完全なレスポンスと生成されたモデルを調べることができます。

画像から3Dのリクエストを実行しているPlayground。モデルのライブプレビューと、Preview、Request、Responseの各タブが並んで表示されている

タスクの実行中は、Previewタブがライブのステータス更新をストリーミング表示します — ポーリングは不要です。

タスク実行中にライブのステータス更新をストリーミング表示しているPlaygroundのPreviewタブのログ

Requestタブに切り替えると、cURL、Python、JavaScriptですぐに実行できるスニペットが表示され、Responseタブでは完全なJSONを確認できます — ここがPlaygroundがウェブアプリのワークスペースに対して真価を発揮する部分です。作成したすべてのリクエストは、コピー&ペーストひとつで自分のコード内で実行できます。

Request and Response tabs
The same task, viewed two ways: the equivalent cURL request, and the raw JSON response.
The Playground's Request tab showing the equivalent cURL command for the current request
Request
The Playground's Response tab showing the raw JSON response
Response

Usage dashboard

Usageダッシュボードは、アカウントのすべてのAPI活動を可視化します — API経由で直接行われたリクエストか、Playgroundから行われたリクエストかを問いません。生成成功率、総リクエスト数、平均処理時間、消費クレジットに加え、時系列でのリクエスト量や、エンドポイントごとの成功率とレイテンシの内訳を表示します。

Usageダッシュボード。生成成功率、時系列でのリクエスト量、エンドポイントごとの成功率とレイテンシの内訳が表示されている

Request logs

リクエストログには、アカウント上のすべてのAPIタスクが一覧表示されます — API直接呼び出しとPlaygroundからのリクエストの両方が対象で、ステータス、タイミング、そのリクエストを行ったAPIキーが表示されます。タスクを選択すると、その完全な入力と出力、リクエストボディ、使用されたクレジットを確認できます — これは、APIを再クエリすることなく特定の呼び出しをデバッグするのに便利です — また、Playgroundへ直接ジャンプすることもできます。Export CSVを使えば、レポート作成や照合のためにリスト全体を取得できます。

リクエストログ。選択されたタスクのステータス、入力/出力のプレビュー、リクエストボディが詳細パネルに表示されている — Export CSVボタンとOpen in Playgroundボタンがハイライトされている

API management

  • APIキー — キーの作成、命名、失効を行い、それぞれに月間クレジット上限を設定し、各キーの使用状況を確認できます。
  • Webhook — ポーリングする代わりに、APIタスクのステータスが変化した際にリアルタイムで更新を受け取れます。設定手順、配信要件、サンプルペイロードについてはWebhooksガイドを参照してください。

Feedback

開発者プラットフォームのすべてのページには、右下にFeedbackボタンがあります — バグの報告、機能のリクエスト、分かりにくい点のご指摘などにご利用ください。すべての投稿に目を通しています。

Authentication & credits

リクエストは、直接のAPI呼び出しとまったく同様に、Authorization: Bearerヘッダーで渡されたAPIキーによって認証されます。Playgroundはあなた自身のアカウント上で実行されるため、他のAPI呼び出しと同じく、すべてのリクエストはあなたのプランのクレジットを消費し、レート制限にもカウントされます。キーの形式とセキュリティの詳細については、認証ガイドを参照してください。