Skip to main content
POST
Generate an AI debrief for an individual profile

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

profileId
string
required

The ID of the profile to generate and retrieve debrief content for.

Response

Success

Standard response object for successful single-resource requests in the Profile Behavior API. Contains an HTTP status code, the returned resource data, and a status indicator.

code
integer<int32>
required

HTTP status code of the successful response.

status
enum<string>

Always "success" for successful responses.

Available options:
success
id
string

The ID of the debrief content document.

content
string

The generated text content debrief meant to help summarize the data of the profile indicated by the profileId

ratings
object[]

An array of user-submitted ratings indicating whether they thought the debrief was good or not, as well as any comments they may have about the given content.