> ## Documentation Index
> Fetch the complete documentation index at: https://docs.xhuoapi.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Intégration et utilisation de l'API SeeDream Tasks

> ByteDance Seedream Image Generation 集成指南 - XHuoAPI

La principale fonctionnalité de l'API SeeDream Tasks est de permettre la consultation de l'état d'exécution d'une tâche en entrant l'ID de tâche généré par l'API SeeDream Images Generation.

Ce document détaillera les instructions d'intégration de l'API SeeDream Tasks, vous aidant à intégrer facilement et à tirer pleinement parti de la puissance de cette API. Grâce à l'API SeeDream Tasks, vous pouvez facilement interroger l'état d'exécution des tâches de l'API SeeDream Images Generation.

## Processus de demande

Pour utiliser l'API SeeDream Tasks, vous devez d'abord vous rendre sur la page de demande [SeeDream Images Generation API](https://api.xhuoapi.ai/documents/seedream-images) pour demander le service correspondant, puis copier l'ID de tâche de l'API SeeDream Images Generation, comme indiqué sur l'image ci-dessous :

<p>
  <img src="https://cdn.xhuoapi.ai/om6p6g.png" width="500" className="m-auto" />
</p>

Enfin, accédez à la page de l'API Tasks [SeeDream Tasks API](https://api.xhuoapi.ai/documents/seedream-tasks) pour demander le service correspondant. Une fois sur la page, cliquez sur le bouton « Acquire », comme indiqué sur l'image ci-dessous :

![Page de demande](https://cdn.xhuoapi.ai/rci31i.png)

Si vous n'êtes pas encore connecté ou inscrit, vous serez automatiquement redirigé vers la [page de connexion](https://api.xhuoapi.ai) vous invitant à vous inscrire et à vous connecter. Après vous être connecté ou inscrit, vous serez automatiquement renvoyé à la page actuelle.

Lors de votre première demande, un quota gratuit sera offert, vous permettant d'utiliser cette API gratuitement.

## Exemple de demande

L'API SeeDream Tasks peut être utilisée pour interroger les résultats de l'API SeeDream Images Generation. Pour savoir comment utiliser l'API SeeDream Images Generation, veuillez consulter le document [SeeDream Images Generation API](https://api.xhuoapi.ai/documents/seedream-images-integration).

Prenons un exemple avec un ID de tâche retourné par le service SeeDream Images Generation. Supposons que nous ayons un ID de tâche : 20068983-0cc9-4c6a-aeb6-9c6a3c668be0, nous allons maintenant démontrer comment procéder en passant cet ID de tâche.

### Exemple de tâche

<p>
  <img src="https://cdn.xhuoapi.ai/om6p6g.png" width="500" className="m-auto" />
</p>

### Configuration des en-têtes de requête et du corps de la requête

**Request Headers** comprend :

* `accept` : spécifie que la réponse doit être au format JSON, ici rempli avec `application/json`.
* `authorization` : la clé d'API pour appeler l'API, que vous pouvez sélectionner directement après la demande.

**Request Body** comprend :

* `id` : l'ID de tâche téléchargé.
* `action` : la manière d'opérer sur la tâche.

Configurez comme indiqué sur l'image ci-dessous :

<p>
  <img src="https://cdn.xhuoapi.ai/yuyte9.png" width="500" className="m-auto" />
</p>

### Exemple de code

Vous pouvez constater que diverses langues de code ont déjà été générées automatiquement sur le côté droit de la page, comme indiqué sur l'image ci-dessous :

<p>
  <img src="https://cdn.xhuoapi.ai/b0wt0d.png" width="500" className="m-auto" />
</p>

Voici quelques exemples de code :

#### CURL

```bash theme={null}
curl -X POST 'https://api.xhuoapi.ai/v1/seedream/tasks' \
-H 'accept: application/json' \
-H 'authorization: Bearer {token}' \
-H 'content-type: application/json' \
-d '{
  "id": "a6e0d456-189b-4c78-9232-2fe72166ab39",
  "action": "retrieve"
}'
```

### Exemple de réponse

Après une demande réussie, l'API renverra les détails de la tâche ici. Par exemple :

```json theme={null}
{
  "success": true,
  "task_id": "84d1544a-9043-4dde-a98b-e889dacd75f6",
  "trace_id": "176acf03-7ca7-4fc6-85db-e3724d4f59eb",
  "data": [
    {
      "prompt": "un chat siamois blanc",
      "size": "2048x2048",
      "image_url": "https://platform.cdn.xhuoapi.ai/seedream/6e5f9085-cc4a-4801-b77b-31550129ff19.jpg"
    }
  ]
}
```

Le résultat de la réponse contient plusieurs champs, décrits comme suit :

* `success`, l'état de la tâche de génération de vidéo à ce moment.
* `task_id`, l'ID de la tâche de génération de vidéo à ce moment.
* `trace_id`, l'ID de suivi de la génération de vidéo à ce moment.
* `data`, la liste des résultats de la tâche de génération d'images à ce moment.
  * `image_url`, le lien de la tâche de génération d'images à ce moment.
  * `prompt`, le mot clé.
  * `size`: les pixels de l'image générée.

## Opération de requête en masse

Ceci est destiné à interroger les détails de plusieurs ID de tâche, contrairement à ce qui précède, il faut sélectionner l'action comme retrieve\_batch.

**Request Body** comprend :

* `ids` : tableau des ID de tâche téléchargés.
* `action` : la manière d'opérer sur la tâche.

Configurez comme indiqué sur l'image ci-dessous :

<p>
  <img src="https://cdn.xhuoapi.ai/ycc4th.png" width="500" className="m-auto" />
</p>

### Exemple de code

Voici quelques exemples de code :

### Exemple de réponse

Après une demande réussie, l'API renverra les détails spécifiques de toutes les tâches en masse. Par exemple :

```json theme={null}
{
  "items": [
    {
      "_id": "69498b9bff2676299c5cb7a6",
      "id": "84d1544a-9043-4dde-a98b-e889dacd75f6",
      "api_id": "86ad30f3-0bc8-4b9b-b019-b9fa5b05672e",
      "application_id": "11e25072-de6d-4bd6-81e7-77ee0055499a",
      "created_at": 1766427547.107,
      "credential_id": "50892af9-597f-426e-a455-bc1739de95b0",
      "request": {
        "action": "générer",
        "model": "doubao-seedream-4-0-250828",
        "prompt": "un chat siamois blanc"
      },
      "trace_id": "176acf03-7ca7-4fc6-85db-e3724d4f59eb",
      "type": "images",
      "user_id": "b60a9491-1eba-4ab8-a93f-12c0fd81dab4",
      "response": {
        "success": true,
        "task_id": "84d1544a-9043-4dde-a98b-e889dacd75f6",
        "trace_id": "176acf03-7ca7-4fc6-85db-e3724d4f59eb",
        "data": [
          {
            "prompt": "un chat siamois blanc",
            "size": "2048x2048",
            "image_url": "https://platform.cdn.xhuoapi.ai/seedream/6e5f9085-cc4a-4801-b77b-31550129ff19.jpg"
          }
        ]
      }
    },
    {
      "_id": "69498b9bff2676299c5cb7a6",
      "id": "84d1544a-9043-4dde-a98b-e889dacd75f6",
      "api_id": "86ad30f3-0bc8-4b9b-b019-b9fa5b05672e",
      "application_id": "11e25072-de6d-4bd6-81e7-77ee0055499a",
      "created_at": 1766427547.107,
      "credential_id": "50892af9-597f-426e-a455-bc1739de95b0",
      "request": {
        "action": "générer",
        "model": "doubao-seedream-4-0-250828",
        "prompt": "un chat siamois blanc"
      },
      "trace_id": "176acf03-7ca7-4fc6-85db-e3724d4f59eb",
      "type": "images",
      "user_id": "b60a9491-1eba-4ab8-a93f-12c0fd81dab4",
      "response": {
        "success": true,
        "task_id": "84d1544a-9043-4dde-a98b-e889dacd75f6",
        "trace_id": "176acf03-7ca7-4fc6-85db-e3724d4f59eb",
        "data": [
          {
            "prompt": "un chat siamois blanc",
            "size": "2048x2048",
            "image_url": "https://platform.cdn.xhuoapi.ai/seedream/6e5f9085-cc4a-4801-b77b-31550129ff19.jpg"
          }
        ]
      }
    }
  ],
  "count": 2
}
```

Retourne les résultats avec plusieurs champs, où `items` contient les détails spécifiques des tâches en lot, chaque tâche ayant des informations spécifiques identiques aux résultats de la requête d'une seule tâche ci-dessus, les informations des champs sont les suivantes.

* `items`, tous les détails spécifiques des tâches en lot. C'est un tableau, chaque élément du tableau ayant le même format que le résultat de la requête d'une seule tâche ci-dessus.
* `count`, le nombre de tâches dans cette requête en lot.

#### CURL

```bash theme={null}
curl -X POST 'https://api.xhuoapi.ai/v1/seedance/tasks' \
-H 'accept: application/json' \
-H 'authorization: Bearer {token}' \
-H 'content-type: application/json' \
-d '{
  "ids": ["84d1544a-9043-4dde-a98b-e889dacd75f6","84d1544a-9043-4dde-a98b-e889dacd75f6"],
  "action": "récupérer_en_lot"
}'
```

## Gestion des erreurs

Lors de l'appel de l'API, si une erreur se produit, l'API renverra le code d'erreur et les informations correspondantes. Par exemple :

* `400 token_mismatched` : Mauvaise requête, probablement en raison de paramètres manquants ou invalides.
* `400 api_not_implemented` : Mauvaise requête, probablement en raison de paramètres manquants ou invalides.
* `401 invalid_token` : Non autorisé, jeton d'autorisation invalide ou manquant.
* `429 too_many_requests` : Trop de requêtes, vous avez dépassé la limite de taux.
* `500 api_error` : Erreur interne du serveur, quelque chose s'est mal passé sur le serveur.

### Exemple de réponse d'erreur

```json theme={null}
{
  "success": false,
  "error": {
    "code": "api_error",
    "message": "échec de la récupération"
  },
  "trace_id": "2cf86e86-22a4-46e1-ac2f-032c0f2a4e89"
}
```

## Conclusion

Grâce à ce document, vous avez compris comment utiliser l'API SeeDream Tasks pour interroger les détails spécifiques d'une tâche unique ou en lot. Nous espérons que ce document vous aidera à mieux intégrer et utiliser cette API. Si vous avez des questions, n'hésitez pas à contacter notre équipe de support technique.
