CueFrame

List clip suggestions for a media item

Required permission: media:read

GET
/v1/media/{id}/suggestions

Authorization

AuthorizationBearer <token>

API key auth. Prefix cf_live_ for production orgs, cf_test_ for sandbox.

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/media/string/suggestions"
{  "status": "idle",  "createdAt": "string",  "analyzedAt": "string",  "jobId": "string",  "topics": [    "string"  ],  "suggestions": [    {      "id": "string",      "rank": 1,      "trim": {        "start": 0,        "end": 0      },      "score": 0,      "title": "string",      "reason": "string",      "topic": "string",      "hook": "string",      "platforms": [        "string"      ],      "format": "string",      "caption": "string",      "hashtags": [        "string"      ],      "textOverlays": [        "string"      ],      "editingNotes": "string",      "motionStyle": {        "textAnimation": "string",        "transitions": "string",        "colorMood": "string",        "captionStyle": "string"      },      "visualTreatment": [        {          "time": 0,          "visual": "string"        }      ],      "brollSuggestions": [        {          "moment": "string",          "searchTerms": [            "string"          ],          "rationale": "string"        }      ],      "thumbnailConcept": "string"    }  ],  "pagination": {    "hasMore": true,    "nextCursor": "string",    "prevCursor": "string"  }}
{  "error": {    "code": "string",    "message": "string",    "details": {      "property1": null,      "property2": null    }  }}
{  "error": {    "code": "string",    "message": "string",    "details": {      "property1": null,      "property2": null    }  }}
{  "error": {    "code": "string",    "message": "string",    "details": {      "property1": null,      "property2": null    }  }}
{  "error": {    "code": "string",    "message": "string",    "details": {      "property1": null,      "property2": null    }  }}
{  "error": {    "code": "string",    "message": "string",    "details": {      "property1": null,      "property2": null    }  }}
{  "error": {    "code": "string",    "message": "string",    "details": {      "property1": null,      "property2": null    }  }}
{  "error": {    "code": "string",    "message": "string",    "details": {      "property1": null,      "property2": null    }  }}