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

# Obtenir le déploiement

> Obtenez le statut de la dernière tentative de publication d'un chat

Obtient le statut de la dernière tentative de publication d'un chat, ou de la tentative désignée par `deploymentId`. La dernière tentative peut être encore en cours de build, ou avoir échoué alors qu'une version plus ancienne reste en ligne. Utilisez `liveUrl` pour obtenir l'URL de la version actuellement en ligne. Si le déploiement n'est pas dans un état final, cet endpoint synchronise le statut avec Vercel avant de répondre.

## Requête

```
GET /api/chat/{chatId}/deployment
```

### En-têtes

| En-tête | Requis | Description |
| - | - | - |
| `Authorization` | Oui | `Bearer macaly_...` |

### Paramètres de chemin

| Paramètre | Type | Description |
| - | - | - |
| `chatId` | string | L'ID du chat |

### Paramètres de requête

| Paramètre | Requis | Description |
| - | - | - |
| `deploymentId` | Non | L'`id` ou le `deploymentId` renvoyé par [`POST /deploy`](/docs/fr/api/deploy). Sans ce paramètre, l'endpoint renvoie la dernière tentative de publication du chat. |

### Exemple de requête

<CodeGroup>
  ```bash cURL theme={null}
  curl "https://www.macaly.com/api/chat/abc123/deployment?deploymentId=jzga0sttml37v6mbizb8tk1x" \
    -H "Authorization: Bearer macaly_abc123..."
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    `https://www.macaly.com/api/chat/${chatId}/deployment?deploymentId=${deploymentId}`,
    {
      headers: {
        'Authorization': 'Bearer macaly_abc123...',
      },
    }
  );

  const data = await response.json();
  console.log(data.status, data.liveUrl);
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      f'https://www.macaly.com/api/chat/{chat_id}/deployment',
      params={'deploymentId': deployment_id},
      headers={
          'Authorization': 'Bearer macaly_abc123...',
      },
  )

  data = response.json()
  print(data['status'], data['liveUrl'])
  ```
</CodeGroup>

## Réponse

### Déploiement prêt

```json theme={null}
{
  "id": "jzga0sttml37v6mbizb8tk1x",
  "url": "https://macaly-staging-abc123.macaly.app",
  "status": "READY",
  "deploymentId": "dpl_HKLBd2QDTwq58AMUJiaMyUzk8WUw",
  "createdAt": "2025-01-12T21:18:54.906Z",
  "error": null,
  "domain": "macaly-staging-abc123.macaly.app",
  "domains": [
    {
      "domain": "macaly-staging-abc123.macaly.app",
      "verified": true,
      "isCustomDomain": false
    }
  ],
  "liveUrl": "https://macaly-staging-abc123.macaly.app"
}
```

### Aucun déploiement

```json theme={null}
{
  "id": null,
  "url": null,
  "status": null,
  "deploymentId": null,
  "createdAt": null,
  "error": null,
  "domain": null,
  "domains": [
    {
      "domain": "macaly-staging-abc123.macaly.app",
      "verified": true,
      "isCustomDomain": false
    }
  ],
  "liveUrl": null
}
```

### Déploiement échoué

Une republication échouée laisse la version précédente en ligne : `liveUrl` reste donc renseigné.

```json theme={null}
{
  "id": "jzga0sttml37v6mbizb8tk1x",
  "url": "https://macaly-staging-abc123.macaly.app",
  "status": "ERROR",
  "deploymentId": "dpl_HKLBd2QDTwq58AMUJiaMyUzk8WUw",
  "createdAt": "2025-01-12T21:18:54.906Z",
  "error": ["Build failed: Module not found"],
  "domain": "macaly-staging-abc123.macaly.app",
  "domains": [],
  "liveUrl": "https://macaly-staging-abc123.macaly.app"
}
```

### Champs de la réponse

| Champ | Type | Description |
| - | - | - |
| `id` | string \| null | ID du déploiement en base de données (null si jamais déployé) |
| `url` | string \| null | L'URL du déploiement |
| `status` | string \| null | Statut du déploiement Vercel (voir ci-dessous) |
| `deploymentId` | string \| null | ID du déploiement Vercel |
| `createdAt` | string \| null | Horodatage ISO de la création du déploiement |
| `error` | string\[] \| null | Messages d'erreur en cas d'échec du déploiement |
| `domain` | string \| null | Domaine principal du déploiement |
| `domains` | array | Tous les domaines connectés |
| `domains[].domain` | string | Nom de domaine |
| `domains[].verified` | boolean | Si le domaine est vérifié |
| `domains[].isCustomDomain` | boolean | S'il s'agit d'un domaine personnalisé |
| `liveUrl` | string \| null | URL de la version en ligne (null si rien n'est en ligne) |

### Valeurs de statut du déploiement

| Statut | Description |
| - | - |
| `QUEUED` | Déploiement en file d'attente |
| `BUILDING` | Build en cours |
| `READY` | Déploiement réussi |
| `ERROR` | Déploiement échoué |
| `CANCELED` | Déploiement annulé |
| `UNPUBLISHED` | Déploiement dépublié |

## Codes de statut

| Statut | Description |
| - | - |
| 200 | Succès (même si aucun déploiement n'existe, retourne des champs null) |
| 401 | Clé API invalide ou manquante |
| 403 | Le chat n'appartient pas à votre équipe |
| 404 | Chat introuvable, ou `deploymentId` ne correspond à aucun déploiement de ce chat |

## Pattern de polling

Transmettez l'`id` renvoyé par `POST /deploy` comme `deploymentId`.

```bash theme={null}
while true; do
  DEPLOYMENT=$(curl -s "https://www.macaly.com/api/chat/$CHAT_ID/deployment?deploymentId=$DEPLOYMENT_ID" \
    -H "Authorization: Bearer macaly_...")

  STATUS=$(echo $DEPLOYMENT | jq -r '.status')
  echo "Status: $STATUS"

  if [[ $STATUS == "READY" ]]; then
    echo "Deployed: $(echo $DEPLOYMENT | jq -r '.liveUrl')"
    break
  elif [[ $STATUS == "ERROR" ]]; then
    echo "Failed: $(echo $DEPLOYMENT | jq -r '.error')"
    break
  fi

  sleep 3
done
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.