Retrieve Image Information

Retrieves information about a specific photo including its image URL, photo ID, and other details.

Endpoint

GET /api/images/{id}

Parameters

Parameter
Type
Required
Description

id

string

Yes

The identifier of the selected image.

Temporary File Access

When retrieving a file, a temporary URL will be generated, allowing access to the file for a limited time (1 hour). The image_url field in the response will contain a signed URL with a short-lived token, enabling secure and temporary access to the file.

Note: The temporary URL will expire after 1 hour, and any attempts to access the file after that time will result in a 403 error.

Request Example

curl -X GET "https://api.deepmode.ai/api/images/d5c6b8a9f7e5d1c3a2f91" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_SECRET_API_KEY"

Response

Upon successful retrieval, the API returns the following response:

{
  "id": "d5c6b8a9f7e5d1c3a2f91",
  "file_name": "120e453f-3a73-4016-ad6a-5cd5e00ddd45.jpeg",
  "model_id": "a9f7e5d1c3a2f91e3d5c6",
  "image_url": "https://deepmodeimage.blob.core.windows.net/deepmode-user-image/120e453f-3a73-4016-ad6a-5cd5e00ddd45.jpeg?st=2024-04-29T14%3A28%3A02Z&se=2024-04-29T15%3A28%3A02Z&sp=r&sv=2023-11-03&sr=b&sig=NaLrBA8mqrBMiFL1e9gCbuQAvgEMmG39D6iyHkbuy2E%3D",
  "prompt": "A beautiful landscape with mountains and a river.",
  "negative_prompt": "rainy, foggy",
  "upscaled": true,
  "ratio": "portrait"
}

Last updated