Generate authentication token

Generates a single-use authentication token for accessing specific resources and actions. Requires a valid API key (x-client-key).

Body
required
application/json
  • actionResource
    Type: string
    min length:  
    1
    enum
    required

    The feature/resource name

    values
    • lens
    • 2d-to-3d
    • property-visualize
    • magic-background
    • room-visualize
    • object-detection
  • actionType
    Type: string
    min length:  
    1
    enum
    required

    The CRUD action type

    values
    • create
    • read
    • delete
  • catalogueId
    Type: string

    Catalogue ID (required for lens)

  • userReference
    Type: string

    User reference to identify the user

Responses
  • application/json
  • application/json
  • application/json
  • application/json
Request Example for post/api/v1/token
curl https://platform.youzu.ai/api/v1/token \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'x-client-key: YOUR_SECRET_TOKEN' \
  --data '{
  "actionResource": "lens",
  "actionType": "create",
  "userReference": "",
  "catalogueId": ""
}'
{
  "token": "string",
  "expiresIn": 1,
  "actionResource": "lens",
  "actionType": "create"
}