照会とダウンロード

キューに入った変換はジョブ ID を返します。この 2 つのエンドポイントが、完了時期を知らせ、ファイルを渡します。

状態を確認する

GET https://rework.live/api/v1/jobs/:id を、同じベアラートークンで呼び出します。ジョブが待機している間は待ち順と所要時間の見込みも返るため、クライアントは読み込み中の表示より有用な情報を出せます。

curl https://rework.live/api/v1/jobs/6a84860000000000000000ab \
  -H "Authorization: Bearer rlv_your_key_here"
状態意味
queuedワーカー待ち。queuePosition が設定されます。
running現在変換中です。
done完了。download が利用可能です。
failed変換されませんでした。ご利用量には計上されません。

結果をダウンロードする

GET https://rework.live/api/v1/jobs/:id/download は、適切な Content-Type とファイル名とともに変換済みのバイト列を返します。ジョブの有効期限まで利用でき、その期限はご利用プランの保持期間で決まります。

curl -L -o converted.webp \
  https://rework.live/api/v1/jobs/6a84860000000000000000ab/download \
  -H "Authorization: Bearer rlv_your_key_here"

ジョブはキーに属します

あるアカウントが作成したジョブを別のアカウントが読むことはできません。他人のジョブを要求すると 403 ではなく 404 が返りますが、これは意図的です。ジョブ ID は推測しうる程度のものなので、「あなたのものではない」と「存在しない」を区別すれば、他人の変換が存在することを漏らしてしまいます。

妥当な間隔で照会してください。レスポンスに含まれる見込み時間は、そのためのものです。短い間隔で回し続ける照会も、他のリクエストと同様に 1 時間あたりの上限に数えられます。