AUauthentified
Analysis

Create a product analysis

Create a product analysis

post/unstable/analysis

Request

  • Base URL
    https://api.authentified.co
  • Auth
    API key in header X-Authentified-API-Key

Request body

asyncboolean

Whether to process the analysis asynchronously

callbackUrlstring uri

The URL to send the analysis result to when processing asynchronously

Example request

{
  "images": [
    {
      "id": "img_001",
      "url": "https://example.com/photo1.jpg"
    }
  ]
}

Response

Product analysis created successfully

uuidstring uuid

The UUID of the product analysis

status'started' | 'failed' | 'finalising' | 'complete'

The current status of the analysis

Example response

{
  "uuid": "550e8400-e29b-41d4-a716-446655440000",
  "status": "complete",
  "images": [
    {
      "id": "img_001",
      "url": "https://example.com/photo1.jpg"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.