非同期ジョブの取得 | API ドキュメント

# Get Async Job

Get the status and result of an asynchronous job created by the current account.

GET https://api.apihop.ai/v1/jobs/{id}

## Applicable Endpoints

- [Seedance 2.0](https://apihop.ai/en/docs/api-reference/BytePlus/seedance-2-0) and

[Seedance 2.5](https://apihop.ai/en/docs/api-reference/BytePlus/seedance-2-5) use `POST https://api.apihop.ai/v1/video/seedance`, which returns `data.jobId` and requires `GET https://api.apihop.ai/v1/jobs/{id}` to retrieve job status and results.

- The current [GPT-Image-2 Image Generation](https://apihop.ai/en/docs/api-reference/OpenAI/gpt-image-2)

endpoint returns results directly through JSON or SSE and does not use Jobs.

Use this endpoint only when a creation response explicitly contains `data.jobId`. The request must use an API Key belonging to the same account that created the job.

```text
GET https://api.apihop.ai/v1/jobs/{id}
```

## Authentication

```http
Authorization: Bearer YOUR_API_KEY
```

## Path Parameter

### `id` (string, required)

Numeric job ID returned as `jobId` when the job was created.

## Request Example

```bash
curl --request GET \
  --url https://api.apihop.ai/v1/jobs/123456789012345678 \
  --header 'Authorization: Bearer YOUR_API_KEY'
```

## Response

### `id` (string)

Job ID.

### `status` (string)

`PENDING`, `CONNECT`, `PROCESSING`, `COMPLETED`, `FAILED`, or `CANCELLED`.

### `inputParams` (object)

Input parameters submitted when the job was created.

### `outputResult` (unknown)

Final output. Image and video models return different structures.

### `createdAt` (string)

ISO 8601 creation timestamp.

### `startedAt` (string | null)

ISO 8601 processing start time.

### `completedAt` (string | null)

ISO 8601 completion time.

### Success Example

```json
{
  "success": true,
  "data": {
    "id": "123456789012345678",
    "status": "COMPLETED",
    "inputParams": {
      "model": "seedance-2.5",
      "prompt": "Create an eight-second brand film"
    },
    "outputResult": [
      {
        "url": [
          "https://video.example.com/generated/result.mp4"
        ]
      }
    ],
    "createdAt": "2026-08-20T08:24:00.000Z",
    "startedAt": "2026-08-20T08:24:02.000Z",
    "completedAt": "2026-08-20T08:26:30.000Z"
  },
  "requestId": "req_..."
}
```

## Polling Guidance

- Poll every 5 to 10 seconds.
- `PENDING`, `CONNECT`, and `PROCESSING` are non-terminal.
- Read `outputResult` after `COMPLETED`.
- Stop polling after `FAILED` or `CANCELLED`.
- Result URLs may expire; save completed assets promptly.

## Error Responses

See [Error Codes and Troubleshooting](https://apihop.ai/en/docs/api-reference/errors) for the full code reference, protocol differences, and diagnostic steps.

Job not found:

```json
{
  "success": false,
  "error": {
    "code": 30000,
    "message": "Job 123456789012345678 not found"
  },
  "requestId": "req_..."
}
```

Accessing another account's job:

```json
{
  "success": false,
  "error": {
    "code": 20001,
    "message": "Access denied"
  },
  "requestId": "req_..."
}
```

対象となるエンドポイント

Seedance 2.0 と Seedance 2.5 は POST https://api.apihop.ai/v1/video/seedance を使用します。このエンドポイントは data.jobId を返し、ジョブの状態と結果の取得には GET https://api.apihop.ai/v1/jobs/{id} が必要です。
現在の GPT-Image-2 の画像生成エンドポイントは、JSON または SSE で結果を直接返し、Jobs は使用しません。

このエンドポイントは、作成レスポンスに data.jobId が明示的に含まれている場合にのみ使用してください。リクエストには、ジョブを作成したアカウントと同じアカウントに属する API キーが必要です。

text

GET https://api.apihop.ai/v1/jobs/{id}

認証

http

Authorization: Bearer YOUR_API_KEY

パスパラメータ

idstring必須

ジョブの作成時に jobId として返された、数字で構成されるジョブ ID です。

リクエスト例

bash

curl --request GET \
  --url https://api.apihop.ai/v1/jobs/123456789012345678 \
  --header 'Authorization: Bearer YOUR_API_KEY'

レスポンス

idstring

ジョブ ID です。

statusstring

PENDING、CONNECT、PROCESSING、COMPLETED、FAILED、CANCELLED のいずれかです。

inputParamsobject

ジョブの作成時に送信した入力パラメータです。

outputResultunknown

最終的な出力です。画像モデルと動画モデルでは、返される構造が異なります。

createdAtstring

ISO 8601 形式の作成日時です。

startedAtstring | null

ISO 8601 形式の処理開始日時です。

completedAtstring | null

ISO 8601 形式の完了日時です。

成功時の例

json

{
  "success": true,
  "data": {
    "id": "123456789012345678",
    "status": "COMPLETED",
    "inputParams": {
      "model": "seedance-2.5",
      "prompt": "Create an eight-second brand film"
    },
    "outputResult": [
      {
        "url": [
          "https://video.example.com/generated/result.mp4"
        ]
      }
    ],
    "createdAt": "2026-08-20T08:24:00.000Z",
    "startedAt": "2026-08-20T08:24:02.000Z",
    "completedAt": "2026-08-20T08:26:30.000Z"
  },
  "requestId": "req_..."
}

ポーリングの指針

5〜10 秒ごとにポーリングしてください。
PENDING、CONNECT、PROCESSING は終了状態ではありません。
COMPLETED になったら outputResult を読み取ってください。
FAILED または CANCELLED になったらポーリングを停止してください。
結果の URL は失効する場合があります。完了したアセットは速やかに保存してください。

エラーレスポンス

コードの一覧、プロトコルごとの違い、診断手順については、エラーコードとトラブルシューティングを参照してください。

ジョブが見つからない場合：

json

{
  "success": false,
  "error": {
    "code": 30000,
    "message": "Job 123456789012345678 not found"
  },
  "requestId": "req_..."
}

別のアカウントのジョブにアクセスした場合：

json

{
  "success": false,
  "error": {
    "code": 20001,
    "message": "Access denied"
  },
  "requestId": "req_..."
}