📋 Pre-Requisites

To begin using the Classet API, you must have:

• Access to a Classet Account There a few steps that must be taken through our UI in order to fully leverage our API to kick-off AI Recruiter calls and ingest their outcomes. To do this, you must have access to a Classet Account. Reach out to support@classet.org if you are in need of one.
• [Optional] Add FAQs: If you're interested in seeing how your AI recruiter can handle one-off questions that aren't in your job description, head over to the settings page and a few FAQs to your interview script!

Follow the steps below in order to test your first AI voice call via the API. (Typically takes ~10 minutes to get stood up)

🔐 Create your API Key

In order to access the Classet AI API, you'll need to create and store your own API Key.

Head over to Developer Settings in the Classet app and create a new key.

📜 Create an Interview Script

You can use the Scripts endpoint to create a new interview script. This will return a script_id and set up a basic interview script.

[Optional] Review/Update Your Script

Each script is comprised of a collection of tasks. Retrieving scripts will return the details of those tasks, which included information like what questions to ask. If you'd like to customize the questions that are asked, you can do so by updating a script's task

💼 Create a Job

Create a job so that your AI Recruiter will have relevant job details to reference on the call. Be sure to include the script_id of your newly created script! (otherwise, it will default to a basic, un-customized interview)

📲 Initiate your first call

Initiating your first call can be done with one API request by make a request to the Calls Endpoint. Be sure to include a properly formatted phone number and the appropriate job ID. You can use the Jobs collection to look up the available job IDs on your account (which should also be present on your dashboard).

From here, the candidate will receive a text message to start their phone screen.

🎁 Receiving the outcome of the call

There are two ways to get the data from the call after it occurs.

• Via Webhook You can set up a webhook through the developer settings page: Developer Settings. You will receive a POST request to this URL upon completion of the call.
  • To verify our webhook, your most recent, active api key will be passed in the header as x-classet-key. Currently, the webhook will retry 3 times if the response is something other than 200, 202, or 204.
  • Your webhook requests will also show up in the requests log on the Developer Settings page.
• Via Polling the API If you prefer not to use a webhook, you can also periodically call the Calls endpoint to retrieve the status and data for the call until it is complete.

We are also able to send custom text messaging to the candidate based on the outcome of their call, but that is turned off by default. Let us know if you would like to something.

💬 We're here to help!

If you ever bump into an issue, need some help troubleshooting, or have feedback for how we can improve our API, reach out to support@classet.org or via your dedicated slack channel!