Create a persona definition.

post

https://api.sandbox-65ebc.chico.ai/v1/persona

Creates a persona definition from a list of facet weights.

Personas enable you to define a weighted combination of interests, demographics, and financial behaviors
to create highly targeted audiences for specialized use cases.
They are defined using a list of facet weights, each containing a facet name and a weight.
To create a persona, you must provide at least one facet weight. Each facet weight must contain a valid facet name
and must be registered in the field with corresponding facet type. For example, if you want to create a persona with
a facet weight for the "Travel" interest facet, you must provide a facet weight with the name "Travel" with the facet
type "interest", the facet weight must be defined in the interest_facets field.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

model_version

string

Defaults to "latest"

Model Version

Body Params

Persona Request Body

Defines a persona. Stores various weighted facets including their interests, demographics, location, company affinity, as well as predefined personas.

company_facets

array of objects

Optional list of behavioral facet component objects. Each object outlines how a user's likelihood
to consume from a particular company's products and how much it contributes to the persona definition. If left
empty, no company-based scoring is done. Company facets can be found by listing personas of facet type
'company'. Facet name must be a valid company facet in the persona taxonomy.

company_facets

demographic_facets

array of objects

Optional list of interest facet component objects. Defines how much each demographic attribute
(location, affluence, household composition, etc.) weighs in the persona. If left empty, no demographic-based
scoring is done. Demographic facets can be found by listing personas of facet type 'demographic'. Facet name
must be a valid demographic facet in the persona taxonomy.

demographic_facets

interest_facets

array of objects

Optional list of interest facet component objects. Each object represents how much an interest
weighs in the persona. If left empty, no interest-based scoring is done. Interests can be found
by listing personas of facet type 'interest'. Facet name must be a valid interest in the persona taxonomy.

interest_facets

locations

array of strings

Optional list of zip codes or city ids to filter users by. If left empty, no location-based filtering is done.

locations

persona_name

string

required

A name for describing this persona. Used for easy human-friendly identification.

pre_defined_personas

array of objects

Optional list of pre-defined persona facet component objects. Each object outlines how a pre-defined
persona ('Car Owners' or 'International Travelers') contributes to the persona definition. If left
empty, no predefined personas are incorporated into the persona definition. Pre-defined personas have
been optimized for financial use cases and have been validated at scale. They can be found by listing
personas of facet type 'pre_defined_persona'. Facet name must be a valid pre-defined persona facet in
the persona taxonomy.

pre_defined_personas

Responses

200OK

400Will return a 400 (Bad Request) error if no facets are provided, one or more of the facet names does not exist, or is a custom facet.

409Will return a 409 (Conflict) error if a persona with the same name already exists.