Skip to main content
POST
/
candidates
/
generation-events
/
filter
Filters already-created generation events by specific filter criterion.
curl --request POST \
  --url https://api.example.com/candidates/generation-events/filter \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "constrainToHasCandidateConcats": false,
  "candidateConcatGenerationIDs": null,
  "entityTypeID": -2,
  "entityID": null,
  "entitySlug": null,
  "prompt": null,
  "depth": 1,
  "languageID": 1,
  "emotionTypeIDs": null,
  "contentTypeIDs": [
    1
  ],
  "voiceTypeID": 2,
  "aiModelTypeIDs": null,
  "howManyExtraRecords": 10,
  "howManyDaysRecent": 10,
  "minimumSeedCount": 20,
  "newsKeywordIDs": null,
  "newsTopicIDs": null,
  "newsCategoryIDs": null,
  "newsPeopleIDs": null,
  "url": null,
  "isNarrowlyScoped": false,
  "page": 1,
  "pageSize": 10
}
'
{
  "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
​
constrainToHasCandidateConcats
boolean | null
default:false
​
candidateConcatGenerationIDs
integer<int32>[] | null
​
entityTypeID
integer<int32> | null
default:-2
​
entityID
integer<int32> | null
​
entitySlug
string | null
​
prompt
string | null
​
depth
integer<int32> | null
default:1
​
languageID
integer<int32>
default:1
​
emotionTypeIDs
integer<int32>[] | null
​
contentTypeIDs
integer<int32>[] | null

1: Isms 2: Comments 3: Chains Default (null) is 1, Isms.

​
voiceTypeID
integer<int32> | null
default:2

1: Iser's voice 2: Neutral voice

​
aiModelTypeIDs
integer<int32>[] | null
​
howManyExtraRecords
integer<int32>
default:10
​
howManyDaysRecent
integer<int32>
default:10
​
minimumSeedCount
integer<int32>
default:20
​
newsKeywordIDs
integer<int32>[] | null
​
newsTopicIDs
integer<int32>[] | null
​
newsCategoryIDs
integer<int32>[] | null
​
newsPeopleIDs
integer<int32>[] | null
​
url
string | null

the URL of the generic entity. this really only applies in 2 instances:

  1. a URL
  2. a URL that also happens to exists in our database as a news article
​
isNarrowlyScoped
boolean | null
default:false

if true, then the generation event will be scoped to only the entityID and entityTypeID provided. if false, then the generation event will be scoped to all related entities of the one provided, (while still including the entityID passed in).

​
page
integer<int32>
default:1
​
pageSize
integer<int32>
default:10

Response

Success

​
success
boolean
​
data
unknown