Developer Platform

Developer Platformで、Meshy APIとの連携を実行、モニタリング、設定できます。コードを書かずにエンドポイントを試せるPlayground、アカウント上のすべてのAPIリクエストのダッシュボード、そしてAPIキーとWebhookの管理機能が用意されています。

Freeプランでは、Playgroundで試せるのは画像から3Dのみで、テスト用に組み込まれたキーを使用します。Freeアカウントは自分でAPIキーを作成・管理できず、使用状況ダッシュボードやリクエストログもありません。Pro、Premium、Ultra、Studio、Enterpriseの各プランでは、すべてのPlaygroundエンドポイント、使用状況ダッシュボードとリクエストログ、そして自分専用のAPIキーを利用できます。

概要

ウェブアプリからDeveloper Platformを開いてください。サイドバーには3つのグループがあります。

Build：インタラクティブにエンドポイントを試せるPlayground。
Monitor：使用状況ダッシュボードとリクエストログ。
Configure：APIキーとWebhook。

Overviewページでは、新規アカウント向けに3つのステップを案内します。キーを作成し、Playgroundでリクエストを試し、リクエストログで結果を確認する、という流れです。また、アカウントの使用状況の直近7日間のスナップショットと、変更履歴の最新項目も表示されます。

3ステップの導入カード、7日間の使用状況スナップショット、最新のMeshy API変更履歴項目を示すDeveloper PlatformのOverviewページ

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

Playground

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

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

タスクの実行中は、Previewタブがリアルタイムでステータスの更新をストリーミングするため、ポーリングする必要はありません。

タスク実行中にリアルタイムでステータス更新をストリーミングするPlaygroundのPreviewタブのログ

Requestタブには、cURL、Python、JavaScriptですぐに実行できるコードスニペットが表示され、Responseタブには完全なJSONが表示されます。ウェブアプリのワークスペースとは異なり、Playgroundでは構築したすべてのリクエストをコードとして取得でき、そのまま自分のアプリにコピーして使えます。

RequestタブとResponseタブ

同じタスクを2通りの方法で見る：相当するcURLリクエストと、生のJSONレスポンス。

現在のリクエストに相当するcURLコマンドを示すPlaygroundのRequestタブ — Request

生のJSONレスポンスを示すPlaygroundのResponseタブ — Response

使用状況ダッシュボード

使用状況ダッシュボードでは、直接のAPI呼び出しとPlayground経由の両方を含む、アカウントのすべてのAPIアクティビティをグラフで確認できます。生成の成功率、総リクエスト数、平均処理時間、使用されたクレジットが表示されます。また、時系列でのリクエスト量や、エンドポイントごとの成功率とレイテンシも確認できます。

生成成功率、時系列のリクエスト量、エンドポイント別の成功率とレイテンシを示す使用状況ダッシュボード

リクエストログ

リクエストログには、直接のAPI呼び出しとPlayground経由の両方を含む、アカウント上のすべてのAPIタスクが一覧表示されます。各エントリには、ステータス、タイミング、リクエストを行ったAPIキーが表示されます。

タスクを選択すると、入出力の全内容、リクエストボディ、使用されたクレジットを確認できます。これにより、APIに再度問い合わせることなく呼び出しをデバッグできます。タスクをPlaygroundで開くには、Open in Playgroundをクリックします。レポートや照合のためにリスト全体をダウンロードするには、Export CSVをクリックします。

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

API管理

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

フィードバック

Developer PlatformのすべてのページにはFeedbackボタンがあります。これを使って、バグを報告したり、機能をリクエストしたり、わかりにくい点を教えてください。Meshyチームはすべての送信内容に目を通しています。

認証とクレジット

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