Download OpenAPI specification:Download
Power Skills 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.
The Power Skills, developed by NeuroQuest AI in collaboration with psychologists, is an innovative service that utilises text or audio authored by individuals to extract future professional skills, vocational interests, and much more. This approach enables the sculpting of skills directly from textual content, providing a unique and effective method for identifying and enhancing key characteristics crucial for professional success.
This API is documented in OpenAPI format. In addition to the standard OpenAPI syntax, we use some vendor extensions.
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 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.
In addition to the API specification, we provide several examples of using NeuroQuest AI products at: Hands-on with Power Skills
Provide your access credentials, using your email and password that were provided.
Return of the user object after login
string <email> User email address | |
password | string <password> Your access password |
{- "password": "my-password"
}
{- "user_id": "PLnkNgUpiud10UsKvohAeh615it9",
- "token": "string",
- "refresh_token": "string",
- "expires_in": "string",
- "products": { }
}
Closes the user session on the service.
email required | string User email address (login) |
curl -X GET https://api-power-skills.neuroquest.ai/api/v1/auth/logout?email=bruce.wayne@neuroquest.ai \ -H "Content-Type: application/json" \ -H "token: my-token"
{- "code": 200,
- "status": "success",
- "data": { }
}
curl -X GET https://api-power-skills.neuroquest.ai/api/v1/health/check \ -H "Content-Type: application/json" \ -H "token: my-token"
{- "env": "prod",
- "service": "available",
- "uptime": "string",
- "provider": { }
}
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.
- An analysis must contain at least 100 words.
- The text sent to the model must have been genuinely prepared by the author.
Returns the object with predictive analysis
name | string The name of the person author of the text |
essay | string The author's original text |
{- "name": "Bruce Wayne",
- "essay": "Tell your story..."
}
{- "document_id": "OVjQG8LE1ACyOiOtZ71v",
- "predict_id": "0a6gp921-16n0-1gh9-14r8-0a8db1au902f",
- "person": {
- "name": "Bruce Wayne",
- "analysis": {
- "essay": { },
- "metrics": [ ],
- "warnings": [
- "string"
], - "provider": {
- "name": "string",
- "product": "string",
- "date": "string",
- "api": {
- "version": "string"
}, - "model": {
- "name": "string",
- "theory": "string",
- "version": "string"
}
}
}
}
}
Some points to keep in mind before sending your audio:
- The audio must first be transcribed using the Spectrum API to obtain the document ID.
- If it is an audio, ideally it should have at least 10 minutes of speech.
- The audio sent to the model must have been genuinely prepared by the author.
Returns the object with predictive analysis
name | string The name of the person author of the audio |
document_id | string The document ID generated by the Spectrum API |
{- "name": "Bruce Wayne",
- "document_id": "AZIF6ajPHgDDQ7mcfXcp"
}
{- "document_id": "OVjQG8LE1ACyOiOtZ71v",
- "predict_id": "0a6gp921-16n0-1gh9-14r8-0a8db1au902f",
- "person": {
- "name": "Bruce Wayne",
- "analysis": {
- "essay": { },
- "metrics": [ ],
- "warnings": [
- "string"
], - "provider": {
- "name": "string",
- "product": "string",
- "date": "string",
- "api": {
- "version": "string"
}, - "model": {
- "name": "string",
- "theory": "string",
- "version": "string"
}
}
}
}
}
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.
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 |
user_id | string Example: user_id=MJumNgU0iud90UsEtohNeh6g0ju1 The user's unique id |
curl -X GET https://api-power-skills.neuroquest.ai/api/v1/predict/read?document_id=qMDxnbXEHQLpyROabOPf \ -H "Content-Type: application/json" \ -H "token: my-token"
{- "code": 200,
- "status": "success",
- "data": { }
}