> ## Documentation Index
> Fetch the complete documentation index at: https://docs.hireflix.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Quickstart

## Get started in three steps

Hireflix provides a GraphQL API that allows you to integrate one-way video interview functionality into your own systems. Using the Hireflix API, you can programmatically invite candidates to interviews, track interview progress, and retrieve video responses.

**Watch the quickstart video or follow the steps below:**

[YouTube video player](https://www.youtube.com/embed/ybJp0Y2JUCM)

> [!NOTE]
>
> You can try any query or mutation in the [Hireflix Dev Playground](https://cdn.hireflix.com/graphql-playground/index.html), which sends requests to the Hireflix API at `https://api.hireflix.com/me`.

**1. Create a Hireflix Account**

The easiest way to authenticate is with an API Key. Every Hireflix account can generate API keys, which carry your account permissions and should be kept secure. First, you need to sign up via the [Hireflix website](https://admin.hireflix.com/register).

![Hireflix Gettingstarted Register Pn](https://mintcdn.com/hireflixsl/A-epevDktMZyabHu/images/hireflix-gettingstarted-register.png?fit=max\&auto=format\&n=A-epevDktMZyabHu\&q=85\&s=675623e3eebb3f5ee0371663fab091c7)

**2. Create an API Key**

Log in to your Hireflix account, open your **profile** by clicking on your name at the top right of your screen, and navigate to the **API Keys** section. From there, create your first API key and give it a label so you can easily recognize it later.

![Hireflix Api Create Key Pn](https://mintcdn.com/hireflixsl/UCy_OExlS4JcoL9m/images/hireflix-api-create-key.png?fit=max\&auto=format\&n=UCy_OExlS4JcoL9m\&q=85\&s=beea67cf4c4ae7d7b72d1ae1f74a4915)

**3. Send your first API request (Dev Playground)**

All requests to the Hireflix API (`https://api.hireflix.com/me`) require authentication. Add your API key to the request headers as shown below:

```bash theme={null}
X-API-KEY: <your-api-key>
```

**Open the Hireflix Dev Playground**

The easiest way to try the API without writing code is the [Hireflix Dev Playground](https://cdn.hireflix.com/graphql-playground/index.html). It lets you run any query or mutation against your own account and create sample data, so you can experiment and learn quickly.

![The Hireflix Dev Playground with the getBasicInfo example query and its response](https://mintcdn.com/hireflixsl/1xncuPI2FosTyyfu/images/hireflix-quickstart-dev-playground.png?fit=max\&auto=format\&n=1xncuPI2FosTyyfu\&q=85\&s=fd558fd7a8ae78042342081922294c1b)

**Follow the tutorial**

The first time you open the playground, a tutorial starts. It walks you through every step and helps you generate demo data in your account, so you can try out all queries and mutations. If it doesn't start, click the **Tutorial** button in the top right.

**Add your API key and run your first query**

Paste your API key into the **API key** field at the top and click **Save**. You can now run any query or mutation against your account.

![The API key field at the top of the Dev Playground, with the Save button](https://mintcdn.com/hireflixsl/1xncuPI2FosTyyfu/images/hireflix-quickstart-dev-playground-api-key.png?fit=max\&auto=format\&n=1xncuPI2FosTyyfu\&q=85\&s=a6d3e398794a4889ab109bb196299e2b)

Open **Examples** in the left menu. It lists all queries and mutations referenced in these docs. If you skipped the tutorial, start with the first example, `getBasicInfo`:

```graphql theme={null}
query getBasicInfo {
  info {
    id
    name
    company {
      id
      name
    }
  }
}
```

Click the **Play** button. You should see your Hireflix account details appear in the response panel. 🎉 Success!

### What should I learn next?

Explore the GraphQL basics, or learn about interview and position management. Later, webhooks can help you trigger actions when events occur.

> [card] [Unfamiliar with GraphQL?](https://docs.hireflix.com/tech/graphql-basics.md)
>
> Get a quick introduction to GraphQL and learn the difference between queries and mutations.

> [card] [Interview Management](https://docs.hireflix.com/tech/features/overview.md#interview-flow)
>
> Explore the full interview flow: from inviting candidates to reviewing completed interviews.

> [card] [Position Management](https://docs.hireflix.com/tech/features/overview.md#position-management)
>
> Learn how to create, update, and organize positions (jobs).

> [card] [Webhooks](https://docs.hireflix.com/tech/webhooks/getting-started.md)
>
> Discover how to use webhooks to trigger actions when events occur, like when a candidate finishes an interview.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.