How do I use the Crystal API? (Closed Beta)

Explore the functions of the Crystal API below (closed beta).

The Crystal API is currently in closed beta.

Table of Contents

Overview

The Crystal API is currently available in beta. 

Activate your Token

We are not currently offering API tokens because the API is in closed beta.

Getting Started

Every request requires this header:

Authorization: Bearer YOUR_TOKEN

Analysis API

The Analysis API enables you to predict someone's personality from a text sample or PDF resume.

API Info

URL: 

https://api.crystalknows.com

POST /v1/analysis/pdf

Pass a PDF file in the body and it will return an ID that you can poll to see when it’s done analyzing your file.

Body:

{

  file: FILE.pdf  

}

Response:

{

  data: {

    id: string

  }

}

POST/v1/analysis/text

Pass an unstructured text sample of at least 60 words in the body.

Body:

{

 text: string,
first_name: string (optional),
last_name: string (optional),
email: string (optional) 

}

Response:

{
“data”: {
“personality”: {
“disc_type”: “IS”
},
“images”: {
“disc_map”: <URL>
},
“content”: {
“behavior”: {
phrase: [
“Find ways around the rules”,
“Feel comfortable as the primary speaker in a group”,
“Elevate new ideas”,
“Speak persuasively in a one-on-one meeting”,
“Take big risks”
]
},
“motivations”: {
phrase: [
“Opportunities to advance”,
“Winning other people over”,
“Ambitious goals”,
“Opportunities to perform and entertain”,
“Challenges”
]
},
“drains”: {
phrase: [
“Feeling held back by process”,
“Over-planning”,
“Repetitive, routine tasks”,
“Using too much caution”,
“Following lots of rules”
]
}
}
}

People API

The People API enables you to access all of the personality profiles associated with anyone on your Crystal team. This includes predicted profiles (e.g. people your team looked up using the Crystal Chrome Extension) and verified profiles (e.g. anyone who your team invited to take the personality test). Team administrators can use this data to create integrations to your own internal database or CRM.

GET /v1/people

Query Parameters:

query: string - filters people by name or email address

Response:

{
“data”: [
{
“first_name”: “John”,
“last_name”: “Smith”,
“photo_url”: “photo.png”,
“personality”: {
“disc_type”: “IS”,
“enneagram_type”: “1",
“myers_briggs_type”: “INFP”
},
“content”: {
“behavior”: {
phrase: [
“Find ways around the rules”,
“Feel comfortable as the primary speaker in a group”,
“Elevate new ideas”,
“Speak persuasively in a one-on-one meeting”,
“Take big risks”
],
},
“motivation”: {
phrase: [
“Opportunities to advance”,
“Winning other people over”,
“Ambitious goals”,
“Opportunities to perform and entertain”,
“Challenges”
]
},
“drain”: {
phrase: [
“Feeling held back by process”,
“Over-planning”,
“Repetitive, routine tasks”,
“Using too much caution”,
“Following lots of rules”
]
}
}
],
“total_pages”: 1,
“total_count”: 1
}

Unlocked Content

By default, the People API returns the default content objects that are available on the Crystal website as if a user signed up and took the personality test. If you want to access full, unlocked profile, you'll need to purchase credits through the dashboard by going to this link: https://www.crystalknows.com/app/team-assessments

To use profile credits, pass the `use_credit` query parameter. For example:

https://api.crystalknows.com/v1/people?use_credit=true

Unlocked content includes:

communication
meeting
emailing
selling
negotiation
feedback
conflict
change
strength
blind_spot
working_together