Skip to main content
POST
/
photos
Upload a photo
curl --request POST \
  --url https://api.guile.app/photos \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "encodedContent": "VGhpcyBpcyBqdXN0IGFuIGV4YW1wbGUsIG5vdCBhY3R1YWxseSBmaWxlIGNvbnRlbnQu"
}
'
{
  "id": "<string>",
  "binarySize": 123,
  "dimensions": {
    "width": 2,
    "height": 2
  },
  "url": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "thumbnail_URL": "<string>",
  "rejectionReason": "<string>"
}

Body

application/json

Request to upload a photo.

​
encodedContent
file
required

Base64 encoded photo binary data.

Response

Created.

An uploaded photo on the Guile Platform.

​
id
string
required

The unique identifier for the photo.

​
contentType
enum<string>
required

The content type of the photo.

Available options:
image/gif,
image/jpg,
image/jpeg,
image/png,
image/webp
​
binarySize
integer<int64>
required

The size of the photo in bytes.

​
dimensions
object
required

The dimensions of the photo.

​
url
string<uri>
required

The URL to access the photo.

Maximum string length: 1024
​
state
enum<string>
required

The current state of the photo.

Available options:
uploaded,
processing,
inReview,
approved,
rejected
​
createdAt
string<date-time>
required

The date-time when this resource was created, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. This is derived and immutable.

​
updatedAt
string<date-time>
required

The date-time when this resource was updated, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. This is derived and immutable.

​
thumbnail_URL
string<uri>

The thumbnail URL to access the photo, if available.

Maximum string length: 1024
​
rejectionReason
string

When state is rejected, this is the human-readable reason. It is populated either by the review team on manual denial or by the processing worker after exhausted retries. The rejection reason is excluded for all states except rejected.