Get Order Details

Get Order Details

Explanation

This API endpoint retrieves the details of a specific order in the system using the provided order ID.

---

GET https://api.aihomedesign.com/v1/order/{order_id}

---

Path Parameters

• order_id: The unique identifier of the order to retrieve details for.

Headers

Key	Value
x-api-key*	{your_api_key_here}

Response

200: OK

{
  "id": "order-id",
  "user_id": "user-id",
  "email": "[e-mail]",
  "before_image_id": "before-image-id",
  "before_image_src": "https://s3.amazonaws.com/aihd-before/before-image-id.jpeg",
  "space": "",
  "status": "idle",
  "service": {
      "ID": "service-id",
      "name": "service-day-to-dusk",
      "title": "AI Day to Dusk",
      "steps": "1",
      "credit": 1,
      "price": 0,
      "need_segment": false,
      "description": "Add the magical touch of dusk to your exterior photos!",
      "result_count": 1,
      "generate_tool_name": "D2D",
      "service_type": "real-estate-hub",
      "prompt": "",
      "ai_service_segment_type": "",
      "need_object_validation": false,
      "required_space": false,
      "required_widgets": []
  },
  "service_name": "service-day-to-dusk",
  "object": "",
  "sample_image_used": true,
  "generated_images": [
      {
          "id": "generated-image-id",
          "using_free_plan": false,
          "sequence": 1,
          "src": "https://s3.amazonaws.com/aihd-after/generated-image-id.jpeg",
          "segmented_image_id": "",
          "prompt": "Twilight Sky Without Cloud without Shadow",
          "sky_style": "Twilight Sky Without Cloud",
          "shadow_removal": true,
          "status": "regular_finished",
          "order_id": "order-id",
          "space": "",
          "comment": "",
          "updated_at": "0001-01-01T00:00:00Z",
          "created_at": "2024-06-19T08:45:40.704Z"
      }
  ],
  "created_at": "2024-06-19T08:45:23.509Z"
}

400: Bad Request

{
    "error": string,
    "key": string
}