Skip to content
Get started

Create

POST/teams/{teamId}/ip-filters

Create a custom IP-detection filter for a team (built-in filters are toggled via PUT /teams/{teamId}/ip-filters/{filterId})

Path ParametersExpand Collapse
teamId: string
Body ParametersJSONExpand Collapse
category: "artist-style" or "brand-trademark" or "celebrity-likeness" or 2 more

Filter category; use “custom” for customer-authored filters

One of the following:
"artist-style"
"brand-trademark"
"celebrity-likeness"
"custom"
"fictional-character"
name: string

Display name for the filter

enabled: optional boolean

Whether the filter is active

instruction: optional string

Natural-language detection instruction (required for custom filters)

maxLength2000
minLength1
sourceAssetIds: optional array of string

Optional reference assets used only to generate the instruction

ReturnsExpand Collapse
filter: unknown

The created custom filter, including its enabled state

Create

curl https://api.cloud.scenario.com/v1/teams/$TEAM_ID/ip-filters \
    -H 'Content-Type: application/json' \
    -u "$SCENARIO_SDK_API_KEY:SCENARIO_SDK_API_SECRET" \
    -d '{
          "category": "artist-style",
          "name": "name"
        }'
{
  "filter": {}
}
Returns Examples
{
  "filter": {}
}