​
Getting Started

Alpharun’s API enables you to automate a variety of key workflows, from triggering interviews to exporting interview data.

​
1. Create an API key

An API key is required to use the Alpharun API. To create an API key, visit your Developer Settings, and then click “Create API Key”. Store the key you created in a safe place like a password manager.

​
2. Make your first API request

The base URL for Alpharun’s API is https://api.alpharun.com/api/v1, so all requests should include this URL. To see all available endpoints and their specifications, visit the API Reference.

To make a request, simply include the API key you generated in step 1 as your Bearer Token and provide any necessary parameters for the endpoint you’re using. We recommend using tools like Postman or curl to test requests.

For endpoints requiring a Project ID, you can find the ID by opening the desired Project in your Alpharun dashboard, then clicking the three-dot menu in the top-right corner and selecting “Copy Project ID”.

​
Webhooks

For integrations depending on real-time notifications, webhooks are available. To set up webhooks, please reach out to [email protected] with details on the real time updates you want to subscribe to.

​
Developer Support

Technical support is available at [email protected]. Feel free to reach out with any questions, issues, or feature requests and we’ll get back to you within 24 hours.