Skip to main content
GET
/
apps
/
annotation-reply
/
{action}
/
status
/
{job_id}
Error
A valid request URL is required to generate request examples
{
  "job_id": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
  "job_status": "completed",
  "error_msg": ""
}

Authorizations

Authorization
string
header
required

API Key 認証です。すべての API リクエストにおいて、Authorization HTTP ヘッダーに Bearer プレフィックスを付けた API Key を含めてください。例:Authorization: Bearer {API_KEY}API Key はサーバーサイドに保存し、クライアントサイドで共有・保存しないことを強く推奨します。API Key の漏洩は深刻な結果につながる可能性があります。

Path Parameters

action
enum<string>
required

アクションタイプです。アノテーション返信を設定 の呼び出しと一致する必要があります。

Available options:
enable,
disable
job_id
string<uuid>
required

アノテーション返信を設定 から返されたジョブ ID です。

Response

タスクステータスの取得に成功しました。

job_id
string<uuid>

アノテーション返信を設定 呼び出しから取得したジョブ ID です。

job_status
string

現在のジョブステータスです。waiting はキュー待ち、processing は処理中、completed は完了、error は失敗を示します。

error_msg
string

ジョブが失敗した理由を説明するエラーメッセージです。job_statuserror でない場合は空文字列です。