AI Description Status

Endpoint for checking the status of AI description generation

This endpoint allows checking the processing status of an AI description generation request, using the ID returned when sending the request.

Endpoint URL

 https://api.ovesio.com/v1/ai/generate-description/status/{id}

Method

 GET

Example request

 https://api.ovesio.com/v1/ai/generate-description/status/654321

URL parameters

Possible answers

Successful response (HTTP 200)

{
  "success": true,
  "data": {
    "id": 654321,
    "ref": "1234ABC",
    "language": "en",
    "status": "completed",
    "result": "This Philips LED ceiling lamp with three adjustable arms offers warm light and includes a remote control. Ideal for modern living spaces.",
    "created_at": "2024-08-13T13:12:41.000000Z"
  }
}

The response contains details about the processed request: status, language, generated description, creation time, and the reference originally sent.

Error response (HTTP 400 / 404)

{
  "success": false,
  "errors": {
    "not_found": "Description generation request not found"
  }
}

If the request ID does not exist or is invalid, the response will contain the key success: false and the corresponding error message.

Integration examples

You can check out integration examples available on the official Ovesio GitHub page .