Create persona set

posthttps://api.faraday.ai/v1/persona_sets

Invoke the build of a new persona set for a given cohort

Authentication

Bearer Authentication

Provide your API key in the Authorization header. You can find your API key in the Settings page of the dashboard.

Authorization: Bearer YOUR_TOKEN

Body

Configuration parameters for the new persona model

cohort_idstring<uuid>required
Example: "5bf9aa70-7bf1-4ef1-a131-8c84441be231"
exploreboolean

Whether to show the persona set in Explore, the map view on https://app.faraday.ai.

This will slow down persona set builds.

Example: true
modeling_fieldsarray[string]

Specify customer attributes to use in modeling

namestringrequired

Human-readable label for this persona set.

Example: "Customers personas"
Match pattern: ^(?!\s*$).+
number_of_clustersinteger

Specify the exact number of clusters (i.e. personas) there should be in the persona set.

By default, the optimal value for this parameter is determined automatically.

Setting this requires external ...

previewboolean

A persona set in preview mode will not build until preview is turned off.

Example: true

Responses

201The newly created persona set (still building)
activeboolean

Is the related cohort using this as the primary persona set?

archived_atstring<date-time>

If not null, this resource will no longer receive updates, but will still be visable.

cohort_idstring<uuid>required
Example: "5bf9aa70-7bf1-4ef1-a131-8c84441be231"
created_atstring<date-time>required

When this resource was created.

exploreboolean

Whether to show the persona set in Explore, the map view on https://app.faraday.ai.

This will slow down persona set builds.

Example: true
idstring<uuid>required

A unique ID for this resource.

Example: "4b3f42dd-b6c3-4f0f-ac18-9e6e47321f83"
last_read_input_atstring<date-time>

The last time this resource's input was read.

last_updated_config_atstring<date-time>

The last time this resource's configuration was updated. If this is more recent than last_updated_output_at, the resource will be rebuilt.

last_updated_output_atstring<date-time>

The last time this resource successfully built.

modeling_fieldsarray[string]

Specify customer attributes to use in modeling

namestringrequired

Human-readable label for this persona set.

Example: "Customers personas"
Match pattern: ^(?!\s*$).+
number_of_clustersinteger

Specify the exact number of clusters (i.e. personas) there should be in the persona set.

By default, the optimal value for this parameter is determined automatically.

Setting this requires external ...

personasarray[object]

The personas that belong to this persona set

Items of array[object]
avatarstringdeprecated

Deprecated: Value will be null until the key is eventually removed or replaced. Previously, an image used to represent this persona (only available if demographics (age and gender) are included in the model)

Example: "https://app.faraday.ai/images/persona_stereotypes/face-5.jpg"
Match pattern: ^https://app.faraday.ai/images/persona_stereotypes/[A-Za-z0-9_][-A-Za-z0-9_ ]*.jpg$
detailsobject

Statistics about the members of this persona.

Properties of object
binsobjectdeprecated

Deprecated: Use /persona_sets/{persona_set_id}/analysis/dimensions instead.

How much the members of the persona differ from an average member. This is represented as a histogram. For example, i...

Example: "{\n \"age\": [\n {\n \"max\": 20,\n \"min\": 0,\n \"count\": 0,\n \"percent\": 0.0\n },\n //...\n {\n \"max\": 30,\n \"min\": 20,\n \"count\": 6,\n \"percent\": 0.0035608308605341245\n },\n //...\n {\n \"max\": null,\n \"min\": 90,\n \"count\": 0,\n \"percent\": 0.0\n }\n ],\n \"gender\": [\n {\n \"count\": 1396,\n \"value\": \"Female\",\n \"percent\": 0.828486646884273\n },\n {\n \"count\": 289,\n \"value\": \"Male\",\n \"percent\": 0.171513353115727\n }\n ]\n //...\n}\n"
centerobject

The average traits of a member of this persona. A person does not need to match these traits exactly to be a member of the persona.

Example: "{\n \"age\": 38.98716,\n \"gender\": \"Female\",\n \"household_size\": 6.61248,\n \"household_income\": 148072.78481\n}\n"
idstring<uuid>required
Example: "5cc63c04-f451-43e4-98ce-0e755db8f8e6"
individuals_countinteger

The number of individuals that match this persona within the cohort used to generate the persona set.

Example: 1000
interpretationobject

Interpretation data for this persona

Properties of object
marketing_strategemsarray[string]

Marketing strategems for this persona

summarystring

A summary interpretation of this persona

namestringrequired

A human-readable label for this persona.

Example: "Cluster 0"
Match pattern: ^(?!\s*$).+
previewboolean

A persona set in preview mode will not build until preview is turned off.

Example: true
resource_typestringrequired

The type of this resource.

Example: "persona_sets"
statusstringrequired

The current state of this resource and any updates.

Example: "pending"
Allowed values: new, starting, running, ready, error
status_changed_atstring<date-time>

When the status of this resource was last updated.

status_errorstring

If this resource has status == "error", this will contain an error message.

updated_atstring<date-time>required

When this resource was last updated.

400The request was invalid.
errorstringrequired

A Faraday error code.

Some possible values include:

Generic HTTP Errors

  • BAD_REQUEST: The request could not be validated.
  • FORBIDDEN: You do not have permission to access the specified resour...
Example: "ERROR_TYPE"
Allowed values: BAD_REQUEST, FORBIDDEN, MAX_RESOURCES_REACHED, INTERNAL_SERVER_ERROR, INVALID_AUTHORIZATION, NOT_FOUND, MALFORMED_API_KEY, MISSING_API_KEY, EXPIRED_API_KEY, VALIDATION_FAILED, CONFLICT
idstring<uuid>required

A unique ID for this error. Please include this in bug reports.

Example: "082f9513-901c-4308-8081-902a8fe22d7e"
notestringrequired

A human-readable description of the error.

Example: "An error occurred"
validationErrorsarray[object]

JSON Schema validation errors, if any.

Items of array[object]
contextobjectrequired

More information about the error.

Properties of object
errorTypestringrequired

The type of validation error which occurred.

messagestringrequired

A human-readable error message.

pathstringrequired

The location in the document that failed validation.

suggestionstring

A suggestion for fixing this error.

401No API key was supplied.
errorstringrequired

A Faraday error code.

Some possible values include:

Generic HTTP Errors

  • BAD_REQUEST: The request could not be validated.
  • FORBIDDEN: You do not have permission to access the specified resour...
Example: "ERROR_TYPE"
Allowed values: BAD_REQUEST, FORBIDDEN, MAX_RESOURCES_REACHED, INTERNAL_SERVER_ERROR, INVALID_AUTHORIZATION, NOT_FOUND, MALFORMED_API_KEY, MISSING_API_KEY, EXPIRED_API_KEY, VALIDATION_FAILED, CONFLICT
idstring<uuid>required

A unique ID for this error. Please include this in bug reports.

Example: "082f9513-901c-4308-8081-902a8fe22d7e"
notestringrequired

A human-readable description of the error.

Example: "An error occurred"
validationErrorsarray[object]

JSON Schema validation errors, if any.

Items of array[object]
contextobjectrequired

More information about the error.

Properties of object
errorTypestringrequired

The type of validation error which occurred.

messagestringrequired

A human-readable error message.

pathstringrequired

The location in the document that failed validation.

suggestionstring

A suggestion for fixing this error.

403Access to this resource was forbidden.
errorstringrequired

A Faraday error code.

Some possible values include:

Generic HTTP Errors

  • BAD_REQUEST: The request could not be validated.
  • FORBIDDEN: You do not have permission to access the specified resour...
Example: "ERROR_TYPE"
Allowed values: BAD_REQUEST, FORBIDDEN, MAX_RESOURCES_REACHED, INTERNAL_SERVER_ERROR, INVALID_AUTHORIZATION, NOT_FOUND, MALFORMED_API_KEY, MISSING_API_KEY, EXPIRED_API_KEY, VALIDATION_FAILED, CONFLICT
idstring<uuid>required

A unique ID for this error. Please include this in bug reports.

Example: "082f9513-901c-4308-8081-902a8fe22d7e"
notestringrequired

A human-readable description of the error.

Example: "An error occurred"
validationErrorsarray[object]

JSON Schema validation errors, if any.

Items of array[object]
contextobjectrequired

More information about the error.

Properties of object
errorTypestringrequired

The type of validation error which occurred.

messagestringrequired

A human-readable error message.

pathstringrequired

The location in the document that failed validation.

suggestionstring

A suggestion for fixing this error.

404The requested resource ID was not found.
errorstringrequired

A Faraday error code.

Some possible values include:

Generic HTTP Errors

  • BAD_REQUEST: The request could not be validated.
  • FORBIDDEN: You do not have permission to access the specified resour...
Example: "ERROR_TYPE"
Allowed values: BAD_REQUEST, FORBIDDEN, MAX_RESOURCES_REACHED, INTERNAL_SERVER_ERROR, INVALID_AUTHORIZATION, NOT_FOUND, MALFORMED_API_KEY, MISSING_API_KEY, EXPIRED_API_KEY, VALIDATION_FAILED, CONFLICT
idstring<uuid>required

A unique ID for this error. Please include this in bug reports.

Example: "082f9513-901c-4308-8081-902a8fe22d7e"
notestringrequired

A human-readable description of the error.

Example: "An error occurred"
validationErrorsarray[object]

JSON Schema validation errors, if any.

Items of array[object]
contextobjectrequired

More information about the error.

Properties of object
errorTypestringrequired

The type of validation error which occurred.

messagestringrequired

A human-readable error message.

pathstringrequired

The location in the document that failed validation.

suggestionstring

A suggestion for fixing this error.

500An internal server error occurred.
errorstringrequired

A Faraday error code.

Some possible values include:

Generic HTTP Errors

  • BAD_REQUEST: The request could not be validated.
  • FORBIDDEN: You do not have permission to access the specified resour...
Example: "ERROR_TYPE"
Allowed values: BAD_REQUEST, FORBIDDEN, MAX_RESOURCES_REACHED, INTERNAL_SERVER_ERROR, INVALID_AUTHORIZATION, NOT_FOUND, MALFORMED_API_KEY, MISSING_API_KEY, EXPIRED_API_KEY, VALIDATION_FAILED, CONFLICT
idstring<uuid>required

A unique ID for this error. Please include this in bug reports.

Example: "082f9513-901c-4308-8081-902a8fe22d7e"
notestringrequired

A human-readable description of the error.

Example: "An error occurred"
validationErrorsarray[object]

JSON Schema validation errors, if any.

Items of array[object]
contextobjectrequired

More information about the error.

Properties of object
errorTypestringrequired

The type of validation error which occurred.

messagestringrequired

A human-readable error message.

pathstringrequired

The location in the document that failed validation.

suggestionstring

A suggestion for fixing this error.

Tags

persona_sets