Skip to main content
POST
/
public
/
candidates
/
expand
Public version of the Kicks off secondary calls to continue generating new candidate concats for a given generation event ID.
curl --request POST \
  --url https://api.example.com/public/candidates/expand \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "publicSessionToken": "<string>",
  "candidateConcatGenerationIDs": [
    1,
    2,
    3
  ],
  "expandQuantity": true,
  "expandScope": false,
  "languageID": 1,
  "page": 1,
  "pageSize": 30
}
'
{
  "success": true,
  "data": "<unknown>"
}

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json
publicSessionToken
string | null
candidateConcatGenerationIDs
integer<int32>[] | null

The generation event IDs to filter by.

expandQuantity
boolean
default:true

ExpandQuantity (boolean) determines if it expands the quantity of candidate concats

expandScope
boolean
default:false

ExpandScope (boolean) determines if it expands the scope of candidate concats

languageID
integer<int32>
default:1
page
integer<int32>
default:1
pageSize
integer<int32>
default:30

Response

Success

success
boolean
data
unknown