Persona Predict Logo
API docs by Redocly

Persona Predict (1.0.0)

Download OpenAPI specification:Download

API Support: [email protected] URL: https://docs.neuroquest.ai/persona-predict/ Terms of Service

Persona Predict API developer documentation. To test the service's features, you must request a login and password to access the token via email: [email protected] or using the Form.

Introduction

Persona Predict is an innovative service by NeuroQuest AI that leverages text analysis and artificial intelligence to unveil the personality of an author based on their written content. Our tool quantifies personality traits according to the Big Five Factors (Openness, Conscientiousness, Extroversion, Agreeableness, and Neuroticism), along with their respective sub-facets. This enables businesses to personalize interactions, enhance employee engagement, and optimize customer relationships more effectively. Transform your text data into valuable personality insights with NeuroQuest AI's Persona Predict.

OpenAPI Specification

This API is documented in OpenAPI format. In addition to the standard OpenAPI syntax, we use some vendor extensions.

Cross-Origin Resource Sharing

This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with W3C spec. And that allows cross-domain communication from the browser. All responses have a wildcard same-origin which makes them completely public and accessible to everyone, including any code on any site.

Authentication

Authentication Method: We adhere to the OAuth2 standard for authentication. To gain access to the service, you will need to provide a valid username and password to obtain an access token.

Token Expiry: The access token has a duration of 1 hour. After this period, you have the option to either refresh the token or log in again to continue using the service effectively.

Examples

In addition to the API specification, we provide several examples of using NeuroQuest AI products at: Hands-on with Persona Predict

token

Use the login endpoint to obtain your access token. The token must be added to the header on the other query endpoints.

Security Scheme Type: API Key
Header parameter name: token

Auth

User Authentication

User access login

Provide your access credentials, using your email and password that were provided.

Request Body schema: application/json
required

Return of the user object after login

email
string <email>

User email address

password
string <password>

Your access password

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "user_id": "MJumNgU0iud90UsEtohNeh6g0ju1",
  • "email": "[email protected]",
  • "token": "string",
  • "refresh_token": "string",
  • "expires_in": "string",
  • "products": [ ]
}

User logout

Closes the user session on the service.

Authorizations:
token
path Parameters
email
required
string

User email address (login)

Responses

Request samples 

curl -X GET https://api-persona-predict.neuroquest.ai/api/v1/auth/logout?email=morpheus@neuroquest.ai \
  -H "Content-Type: application/json" \
  -H "token: my-token"

Response samples

Content type
application/json
{
  • "code": 200,
  • "status": "success",
  • "data": { }
}

Health

Service Monitoring

Service health

Check the health of the service.

Authorizations:
token

Responses

Request samples 

curl -X GET https://api-persona-predict.neuroquest.ai/api/v1/health/check \
  -H "Content-Type: application/json" \
  -H "token: my-token"

Response samples

Content type
application/json
{
  • "env": "prod",
  • "service": "available",
  • "uptime": "string",
  • "provider": { }
}

Predict

Predictive Analyzes

Submit the text for the model to make personality predictions

Some points to keep in mind before sending your text:

- Ideally, the text should contain more than 1000 words to create a stronger and more reliable analysis.
- The text sent to the model must have been genuinely prepared by the author.
- It is possible to create the analysis in background, just provide 'task: true', the 'task_id' will be returned, which can be found in: /predict/task/status.

Authorizations:
token
Request Body schema: application/json
required

Returns the object with predictive analysis

name
string

The name of the person author of the text

essay
string

The author's original text

task
boolean

If 'true' run the process in background

Responses

Request samples

Content type
application/json
{
  • "name": "Morpheus",
  • "essay": "Throughout my career as a Director...",
  • "task": false
}

Response samples

Content type
application/json
{
  • "document_id": "SRjTG8LE1REyWuOtZ01r",
  • "predict_id": "7d4fc870-57a9-4d65-88d5-1b6fb3bb746c",
  • "person": {
    }
}

Checks the status of the task created by predict

If the analysis of /predict/create was created as 'task: true' you can check the status of the task with the 'task_id' that was generated. The result contains data such as 'predict_id' and 'document_id' that you can search for analysis with /predict/read.

Authorizations:
token
query Parameters
task_id
required
string
Example: task_id=4a791c11-f646-4c2a-b783-2cbde1290452

The task identification number

Responses

Request samples 

curl -X GET https://api-persona-predict.neuroquest.ai/api/v1/predict/task/status?task_id=4a791c11-f646-4c2a-b783-2cbde1290452 \
  -H "Content-Type: application/json" \
  -H "token: my-token"

Response samples

Content type
application/json
{
  • "code": 200,
  • "status": "success",
  • "data": { }
}

Search for one or more analyzes

All generated analysis is saved, it is possible to search for an analysis by creating it using one of the parameters: (document_id, predict_id, user_id, email).

- Using document_id you can search for a specific analysis.
- Using predict_id you can search for a specific analysis.
- Using email as a key to return numerous analyzes.
- Using user_id as a key to return numerous analyzes.

Authorizations:
token
query Parameters
document_id
string
Example: document_id=qMDxnbXEHQLpyROabOPf

The document ID generated at creation

predict_id
string
Example: predict_id=f995b602-c53a-4af7-a998-081b673d63f0

The UUID4 generated from creation

email
string

User email address (login)

user_id
string
Example: user_id=MJumNgU0iud90UsEtohNeh6g0ju1

The user's unique id

Responses

Request samples 

curl -X GET https://api-persona-predict.neuroquest.ai/api/v1/predict/read?document_id=qMDxnbXEHQLpyROabOPf \
  -H "Content-Type: application/json" \
  -H "token: my-token"

Response samples

Content type
application/json
{
  • "code": 200,
  • "status": "success",
  • "data": { }
}