Item Description

Generates a description for a given item title using AI and returns the result as an event stream.

Endpoint:

[GET] /api/ai/item_description

Parameters:

Authorization:
    location: header
    type: string
    required: false
    description: The authentication token required to access the endpoint.

Auth0-IdToken:
    location: header
    type: string
    required: false
    description: The Auth0 ID token from the user.

Accept-Language:
    location: header
    type: string
    required: false
    description: The preferred language for the response.

title:
    location: query
    type: string
    required: true
    description: The item title to generate a description for.

Examples:

Request:

curl \
  -H 'Auth0-IdToken: <AUTH0_IDTOKEN>' \
  -H 'Authorization: Bearer <AUTH0_ACCESS_TOKEN>' \
  'https://rnters-staging.herokuapp.com/api/ai/item_description?title=iPhone+13'

Item Photos

Generates a list of photos urls for a given item title and returns the result as a JSON array.

Endpoint:

[GET] /api/ai/item_photos

Parameters:

Authorization:
    location: header
    type: string
    required: false
    description: The authentication token required to access the endpoint.

Auth0-IdToken:
    location: header
    type: string
    required: false
    description: The Auth0 ID token from the user.

Accept-Language:
    location: header
    type: string
    required: false
    description: The preferred language for the response.

title:
    location: query
    type: string
    required: true
    description: The item title to generate a description for.

limit:
    location: query
    type: integer
    required: false
    default_value: 7
    description: The maximum number of photos to generate.
    
offset:
    location: query
    type: integer
    required: false
    default_value: 0
    description: The offset to start generating photos from.

Examples

Request:

curl \
  -H 'Auth0-IdToken: <AUTH0_IDTOKEN>' \
  -H 'Authorization: Bearer <AUTH0_ACCESS_TOKEN>' \
  'https://rnters-staging.herokuapp.com/api/ai/item_photos?title=iPhone+13'

Response:

{
  "images": [
    "https://example.com/image1.png",
    "https://example.com/image2.png",
    "https://example.com/image3.png",
    "https://example.com/image4.png",
    "https://example.com/image5.png",
    "https://example.com/image6.png",
    "https://example.com/image7.png",
  ],
  "meta": {
    "count": 7,
    "limit": 7,
    "offset": 0
  }
}