agent

複数本をまとめて作る（最大20件）

post/api/v1/agent/generate/batch

Request

  • Base URL: https://app.yukkurigen.com
  • URL: https://app.yukkurigen.com/api/v1/agent/generate/batch
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Headers

Prefer'respond-async'

respond-async を付けると（Authorization: Bearer のときだけ）、認証・1件目のスコープ・本文の大きさ・レート上限・進行中のバッチの数をその場で見てから、数秒で 202 とジョブが返る（RFC 7240。サーバの設定によっては付けてもジョブにならず、同期で処理して 200 を返す）。各件は1件ずつ順に作られ、GET /api/v1/jobs/{jobId} の result に同期の 200 と同じ封筒が入る。省略すると同期処理（既存互換。サーバの設定によっては、同じ受け付けのあと一定時間だけ完了を待ち、終わらなければ 202 を返す）。

Request body

idempotencyKeyPrefixstring

指定すると各件へ <prefix>:<index> を Idempotency-Key として渡す。同じ prefix で投げ直せば、既に作られた分は二重課金されない。バッチ全体に付けた Idempotency-Key ヘッダは各件へは配らない（配ると2件目以降が1件目の結果を返す）。

Response

1件ずつの結果。全件失敗でも 200（どれが失敗かは results を見る）。同期の経路のほか、Prefer なしの呼び出しをサーバが待つ設定で待つ間にジョブが終わったときと、ジョブで受け付けるときに受け付けられる件が1件も無かったとき（全件がその場で 400 の結果になり、何も作らない）もこの形で返る。

requestedinteger
succeededinteger
failedinteger
stoppedAtIndexinteger

打ち切った位置（打ち切った場合のみ）。

stopReasonstring
notAttemptedinteger

手つかずの件数。失敗ではないので、投げ直してよい。投げ直すときは、全件を同じ idempotencyKeyPrefix でそのまま送り直す（作った件の冪等キーが効くのはその件が終わってから 24 時間以内だけ）か、打ち切った件（stoppedAtIndex）とこの分だけを新しい idempotencyKeyPrefix の新しいバッチで送る。同じ idempotencyKeyPrefix で一部だけを送ると、番号がずれて別の件の冪等キーに当たり、その件の前の結果が返るだけで作られない。

nextStepstring

打ち切った場合のみ。次に何をするかと、投げ直し方の2通り（全件を同じ idempotencyKeyPrefix で送り直す／打ち切った件と notAttempted の分だけを新しい idempotencyKeyPrefix の新しいバッチで送る）。

Example response

{
  "results": [
    {
      "status": 200
    }
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.