Consulter une tâche asynchrone | Documentation des 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_..."
}
```

Endpoints concernés

Seedance 2.0 et Seedance 2.5 utilisent POST https://api.apihop.ai/v1/video/seedance, qui renvoie data.jobId et nécessite GET https://api.apihop.ai/v1/jobs/{id} pour récupérer l’état et les résultats.
L’endpoint actuel de génération d’images GPT-Image-2 renvoie directement les résultats en JSON ou SSE et n’utilise pas Jobs.

Utilisez cet endpoint uniquement si la réponse de création contient explicitement data.jobId. La requête doit utiliser une clé API appartenant au compte ayant créé la tâche.

text

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

Authentification

http

Authorization: Bearer YOUR_API_KEY

Paramètre de chemin

idstringobligatoire

ID numérique de la tâche renvoyé comme jobId lors de sa création.

Exemple de requête

bash

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

Réponse

idstring

ID de la tâche.

statusstring

PENDING, CONNECT, PROCESSING, COMPLETED, FAILED ou CANCELLED.

inputParamsobject

Paramètres d’entrée envoyés lors de la création de la tâche.

outputResultunknown

Sortie finale. Les modèles d’images et de vidéo renvoient des structures différentes.

createdAtstring

Horodatage de création ISO 8601.

startedAtstring | null

Heure de début de traitement ISO 8601.

completedAtstring | null

Heure de fin ISO 8601.

Exemple réussi

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_..."
}

Conseils d’interrogation périodique

Interrogez toutes les 5 à 10 secondes.
PENDING, CONNECT et PROCESSING ne sont pas des états terminaux.
Lisez outputResult après COMPLETED.
Arrêtez l’interrogation après FAILED ou CANCELLED.
Les URL de résultats peuvent expirer ; sauvegardez rapidement les ressources terminées.

Réponses d’erreur

Consultez Codes d’erreur et dépannage pour la référence complète des codes, les différences de protocole et les étapes de diagnostic.

Tâche introuvable :

json

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

Accès à la tâche d’un autre compte :

json

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