Skip to main content
POST
Recommend

Authorizations

Authorization
string
header
required

A personal API key (adside_pat_…) or a token from adside login. Either carries the permissions of the person it belongs to.

Path Parameters

workspaceId
string
required
Minimum string length: 1

Body

application/json
task
string
required
Required string length: 1 - 4000
type
enum<string>
Available options:
image,
video
aspectRatio
string
Maximum string length: 10
duration
integer
Required range: 1 <= x <= 30
generateAudio
boolean
inputs
object
maxPriceUsd
number
Required range: x <= 1000
priority
enum<string>
Available options:
quality,
balanced,
cost

Response

200 - application/json

Success

useCase
string
required
type
enum<string>
required
Available options:
image,
video
classified
boolean
required
constraints
object
required
note
string | null
required
recommendations
object[]
required
Maximum array length: 3
unmet
string[]
required
guidanceVersion
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991