Scene Classification

POST 
/api/v1/assets/:asset_id/addons/scene_classification

Classify scenes and environments in an image.

Request JSON

{
    "disposition": {
        "update_metadata": true
    }
}

Parameter	Type	Description
disposition	JSON	(optional) Indicates how analysed data must be disposed
disposition .update_metadata	Boolean	true if Asset Metadata should be updated for reserved field _filespin_scene_labels. All labels will be updated as space separated strings into Asset metadata field.

Response JSON when is_synchronous is true

{
    "data": [
      { "label": "amusement_park", "confidence": 0.637 },
      { "label": "tower", "confidence": 0.430 },
      { "label": "castle", "confidence": 0.297 }
    ]
}

Response JSON when is_synchronous is false

{
    "job_id": "9172985e-a6f2-4bb7-abaa-9026fcabf297"
}

Key	Value	Description
job_id	String	The job ID to track the job

Request

Responses

200

Successful operation

401

Unauthorized - Invalid or missing authentication

403

Forbidden - Insufficient permissions

500

Internal server error