`POST /v1/conversations`

このHTTPエンドポイントに記載されたフィールドと権限を使用してください。

リクエスト例#

curl -X POST 'https://platform.tongai.io/v1/conversations' \  -H "Authorization: Bearer $TONG_API_KEY" \  -H "Content-Type: application/json" \  -H "Idempotency-Key: 45be69f1-c266-4a09-a82c-bf3c6303eb03" \  -d '{  "entrypoint": "assistant",  "mode": "guided"}'

設定

curl --version

認証#

自分のアカウントにはサーバー側のAPIキーを、顧客ごとのアカウントにはOAuthを使用します。プロンプトやツール引数にキーを含めないでください。

assistant:runcredits:spend

パラメーター#

Idempotency-Keystring必須

UUID。例：e8aa0a87-6cd9-42eb-975a-b72bf43218c8。

リクエスト本文#

application/json

entrypointstring必須

使用できる値"assistant""filmmaker"

modestring必須

ガイド付き実行はTongでの確認を待ち、自動実行は続行します。どちらも進行に応じて課金され、残高不足で一時停止します。

使用できる値"guided""automatic"

titlestring任意

最大文字数：100。

project_idstring任意

24文字の16進数ID。

model_preferencesobject任意

入れ子のフィールドを表示

imagestring | null必須

文字、数字、アンダースコア、ピリオド、コロン、スラッシュ、ハイフンを使用します。

最小文字数：1。

最大文字数：150。

videostring | null必須

文字、数字、アンダースコア、ピリオド、コロン、スラッシュ、ハイフンを使用します。

最小文字数：1。

最大文字数：150。

sourceobject任意

入れ子のフィールドを表示

kindstring必須

使用できる値"director""text"

idstring必須

24文字の16進数ID。

レスポンススキーマ#

レスポンス

JSON

{}

`HTTP 201`

application/json

object

エラーと制限#

HTTP	エラー	復旧
`400`	無効なリクエスト`REQUEST_INVALID`	再試行する前に、エラーで示されたフィールドを修正してください。
`401`	無効な認証情報`CREDENTIAL_INVALID`	認証情報の有効期限と失効状態を確認してください。
`402`	クレジット不足`INSUFFICIENT_CREDITS`	認証情報を所有するアカウントにクレジットを追加し、保存済みの作業を続行してください。
`403`	権限がありません`SCOPE_REQUIRED`	必要なスコープとリソースへのアクセス権を持つ認証情報を使用してください。
`404`	リソースを利用できません`RESOURCE_UNAVAILABLE`	リソースIDと、承認済みアカウントの所有物であることを確認してください。
`409`	意図IDの競合`IDEMPOTENCY_CONFLICT`	意図IDは元のリクエストにのみ再使用し、別の操作には新しいUUIDを使用してください。
`429`	レート制限に達しました`RATE_LIMITED`	Retry-Afterの待機時間が過ぎてから同じリクエストを再試行してください。
`503`	一時的に利用できません`DEPENDENCY_UNAVAILABLE`	Retry-After後に同じ意図IDで再試行してください。タイムアウト後は保存済みの操作を確認してください。

認証APIキーの利用料金は所有アカウントに請求されます。OAuthでは接続ユーザーが自分のクレジットを使えます。エラーとレート制限エラーを理解し、安全に再試行して、失敗した生成を復旧します。リクエストとログ受理済みでも生成完了ではありません。出力が準備できるまで保存済みジョブを追跡します。