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

# Use your AI tool with the Hireflix skill

## What is this?

Hireflix publishes a **skill file** at [hireflixsl.mintlify.app/skill.md](https://hireflixsl.mintlify.app/skill.md). It contains everything your **AI tool** needs to talk to the Hireflix API directly: the GraphQL schema and example queries. Once you provide your API key, you can ask it to do things in plain English instead of writing GraphQL yourself. That includes **building a position from scratch** (name, questions, video or image prompts, intro/outro) just by filling in a short template in chat.

We've tested the skill with **Claude** and **ChatGPT / Codex**. We recommend Claude, as it works best with Hireflix.

**Quick path:**

1. [Complete setup](#setup): add the skill to your AI tool.
2. [Create a position via chat](#create-a-position-via-chat): fill in the position template, your AI tool builds it.
3. [Explore your account](#explore-your-account): ask about positions, stats, and interview results.

> [!NOTE]
>
> You'll need a Hireflix **API key** to use the skill. If you don't have one yet, follow the [Quickstart](https://hireflixsl.mintlify.site/tech/quickstart.md) to create an account and generate a key. In Claude, you'll also need to allow the Hireflix websites (see setup below) **before** starting your chat session.

## Setup

Choose your AI tool and follow the steps.

> [tab] Claude (recommended)
>
> **1. Allow the Hireflix websites in Claude**
>
> In Claude, click your account name and open **Settings → Capabilities**. Under **Create and edit files**, make sure **Use the internet while making files** is turned on. Then click **Manage** next to **Allowed websites**.
>
> ![The Capabilities page in Claude settings with Use the internet while making files turned on and the Manage button next to Allowed websites](https://mintcdn.com/hireflixsl/PL6j1Ov-vcXvxmE5/images/hireflix-userguide-claude-capabilities-allowed-websites.png?fit=max\&auto=format\&n=PL6j1Ov-vcXvxmE5\&q=85\&s=64381b1776b3bf72016eb7fd19e14085)
>
> Leave **Which sites to allow** on **Standard download sites only**. Then add each of the following websites before you start a new chat: type it in the **Add a website** field and click **Add**.
>
> * `api.hireflix.com` — the GraphQL API endpoint Claude talks to for every query and mutation.
>
> * `media.hireflix.com` — where signed video playback URLs resolve; needed whenever Claude fetches or plays back an interview video.
>
> * `com-hireflix-production-media.s3-accelerate.amazonaws.com` — the signed S3 URL Hireflix issues for video uploads (intro, outro, or per-question videos).
>
> * `images.hireflix.com` — where uploaded question images are served; needed whenever Claude fetches or shows you an image from an image prompt question. (Uploading an image goes through `api.hireflix.com`, so it doesn't need this domain.)
>
> > [!WARNING]
> >
> > Missing one of these websites can cause requests to silently fail partway through a task (e.g. Claude can create a position but can't upload the video you attached). Add all four now to avoid troubleshooting it later.
>
> ![The Allowed websites page in Claude settings with the Add a website field and the Hireflix websites in the list](https://mintcdn.com/hireflixsl/PL6j1Ov-vcXvxmE5/images/hireflix-userguide-claude-allowed-websites-add.png?fit=max\&auto=format\&n=PL6j1Ov-vcXvxmE5\&q=85\&s=84cb808e38464de08a560bd72acc1956)
>
> **2. Get the Hireflix skill file**
>
> Open [hireflixsl.mintlify.app/skill.md](https://hireflixsl.mintlify.app/skill.md) and save the page as `skill.md`. You can hit `CTRL + S` or on Mac `CMD + S` to store the page as `skill.md` on your machine.
>
> **3. Upload the skill to Claude**
>
> In Claude, click your account name and open **Settings**. Click **Customize** in the left menu and open the **Skills** tab. Then click the **Add** button in the top right and choose **Upload skill**.
>
> ![The Skills tab under Settings > Customize with the Add menu open, showing Upload skill](https://mintcdn.com/hireflixsl/PL6j1Ov-vcXvxmE5/images/hireflix-userguide-claude-skills-add.png?fit=max\&auto=format\&n=PL6j1Ov-vcXvxmE5\&q=85\&s=910cfbb3d72ef49f52c622f35762469d)
>
> Drag the `skill.md` file you just saved into the **Skill file** box (or click it to browse for the file), then click **Upload**. Claude runs a security scan on the skill when you upload it.
>
> ![The Upload a skill page in Claude settings with the Skill file drop zone and the Upload button](https://mintcdn.com/hireflixsl/PL6j1Ov-vcXvxmE5/images/hireflix-userguide-claude-skill-upload-file.png?fit=max\&auto=format\&n=PL6j1Ov-vcXvxmE5\&q=85\&s=9a3cc80aa3073e10d2c68c595079134c)
>
> **4. Start a new chat and add your API key**
>
> Start a **new** chat (so the allowed websites from step 1 apply), and give Claude your Hireflix API key so it can authenticate against `api.hireflix.com`. See the [Quickstart](https://hireflixsl.mintlify.site/tech/quickstart.md) if you still need to create one.
>
> > [!WARNING]
> >
> > When sharing an API key with Claude AI, make sure to revoke it after your session has ended as a safety precaution.

> [tab] ChatGPT / Codex
>
> ChatGPT and Codex use the same interface, so these steps work for both.
>
> > [!NOTE]
> >
> > You need a ChatGPT **Business**, Enterprise, or Edu plan to use the Hireflix skill.
>
> **1. Start creating a skill**
>
> Click **Customize** in the left menu (1), then **Skills** (2). Click the **Add** button in the top right (3) and choose **Create skill** (4). This opens a new chat with **Skill Creator** tagged.
>
> > [!NOTE]
> >
> > You might already see **Hireflix** under **Installed** in the left menu. That's the plugin from the [MCP tutorial](https://hireflixsl.mintlify.site/user/getting-started/mcp.md), not the skill.
>
> ![The Skills page under Customize with the Add menu open, showing Create skill](https://mintcdn.com/hireflixsl/FhH-Xy15PDlx_OP7/images/hireflix-userguide-chatgpt-skills-create-skill.png?fit=max\&auto=format\&n=FhH-Xy15PDlx_OP7\&q=85\&s=eb6960e558a413c21b804739b6345e4b)
>
> **2. Paste the skill file and send the instruction**
>
> Open [hireflixsl.mintlify.app/skill.md](https://hireflixsl.mintlify.app/skill.md), copy the full contents, and paste them into the chat. They pop up as an attached file (1).
>
> Prefer working with a file? Save the page as `skill.md` with `CMD + S` on Mac or `CTRL + S` on Windows, then attach that file to the chat instead. Copying the contents directly is usually easier.
>
> > [!WARNING]
> >
> > Add the contents of the file. Using the direct link to `skill.md` doesn't work.
>
> Then add this instruction and send your message (2):
>
> ```text theme={null}
> Can you create a skill for Hireflix based on the attached skill.md file
> ```
>
> ![A new chat with Skill Creator tagged, the pasted skill file attached, and the instruction typed in the message box](https://mintcdn.com/hireflixsl/FhH-Xy15PDlx_OP7/images/hireflix-userguide-chatgpt-skill-paste-file.png?fit=max\&auto=format\&n=FhH-Xy15PDlx_OP7\&q=85\&s=b3db790a16c138cf2ffaf2483fba7444)
>
> **3. Wait for the skill to be created**
>
> Creating the skill takes around 30 seconds to a minute. ChatGPT tells you when the Hireflix skill is created and installed.
>
> ![ChatGPT confirming that it created and installed the Hireflix skill](https://mintcdn.com/hireflixsl/FhH-Xy15PDlx_OP7/images/hireflix-userguide-chatgpt-skill-created.png?fit=max\&auto=format\&n=FhH-Xy15PDlx_OP7\&q=85\&s=236d22490c202f60339b6d7ffd371327)
>
> **4. Open the skill**
>
> Go back to **Customize → Skills**, find **Hireflix** in the **Installed** list on the page, and click it.
>
> ![The Skills page with the Hireflix skill highlighted in the Installed list](https://mintcdn.com/hireflixsl/FhH-Xy15PDlx_OP7/images/hireflix-userguide-chatgpt-skills-list.png?fit=max\&auto=format\&n=FhH-Xy15PDlx_OP7\&q=85\&s=b2ec520cd7c1def54226999cabb5dcdf)
>
> **5. Click Try now**
>
> Click **Try now**. This opens a new chat with the Hireflix skill already tagged.
>
> ![The Hireflix skill details with a Try now button](https://mintcdn.com/hireflixsl/FhH-Xy15PDlx_OP7/images/hireflix-userguide-chatgpt-skill-try-now.png?fit=max\&auto=format\&n=FhH-Xy15PDlx_OP7\&q=85\&s=4231725ba6ead624c8f396c97f5cfcc5)
>
> **6. Add your API key and ask a question**
>
> You can now ask anything. With the skill tagged (1), give it your Hireflix API key the first time you use it (2). See the [Quickstart](https://hireflixsl.mintlify.site/tech/quickstart.md) if you still need to create one. For example:
>
> ```text theme={null}
> Can you show all positions in my account? Here's my API key: <key>
> ```
>
> ![A new chat with the Hireflix skill tagged and a question that includes an API key placeholder](https://mintcdn.com/hireflixsl/FhH-Xy15PDlx_OP7/images/hireflix-userguide-chatgpt-skill-api-key-prompt.png?fit=max\&auto=format\&n=FhH-Xy15PDlx_OP7\&q=85\&s=a88a3046cf7d0193cbb3e03eed2b72d8)
>
> ChatGPT uses the skill to answer your question:
>
> ![ChatGPT listing six positions and reminding you to rotate the API key you pasted](https://mintcdn.com/hireflixsl/FhH-Xy15PDlx_OP7/images/hireflix-userguide-chatgpt-skill-demo.png?fit=max\&auto=format\&n=FhH-Xy15PDlx_OP7\&q=85\&s=f01354b066e6c56aa7139cbe9f208613)
>
> > [!WARNING]
> >
> > When you're done chatting, don't forget to rotate your key in your [API keys settings](https://admin.hireflix.com/en/my-account/api-keys).

## Create a position via chat

Once the skill is set up, you can build a new position just by chatting with your AI tool — no GraphQL required. It uses the `createPosition` mutation from the skill file (plus the matching upload steps for any videos or images you attach) to build the position exactly as you describe it.

The easiest way to start is to tell your AI tool **"I want to create a new Hireflix position"**. It replies with the fill-in template below, so you can see right away what's required and what's optional. If you've already given some details (for example the job title or a few questions), it fills those in for you and only leaves the missing fields open.

> [!TIP]
>
> You can also skip that step: copy the template below, fill it in, attach your files, and send it in one message. Your AI tool creates the position straight away.

### The position template

> [tab] Template
>
> ```text theme={null}
> POSITION
> Name:            (required, max 50 characters)
> Tags:            (optional, comma-separated, max 5, each max 25 characters)
> Intro video:     (optional: file name, or "none")
>
> QUESTION 1
> Title:           (required, max 40 characters)
> Description:     (optional, max 1200 characters)
> Attachment:      (optional: "video: <file>" OR "image: <file>", or "none")
>
> QUESTION 2
> Title:
> Description:
> Attachment:
>
> (add more questions the same way, up to 50)
>
> OUTRO (optional, delete this block to skip it; Title and Text are required if you keep it)
> Title:           (max 100 characters)
> Text:            (max 500 characters)
> Video:           (optional: file name, or "none")
> ```

> [tab] Example
>
> A filled-in template for a three-question interview: question 1 is text only, question 2 has a recorded video prompt, and question 3 shows an image. The files `intro.mp4`, `q2-upset-customer.mp4`, and `q3-churn-chart.png` are attached to the same chat message:
>
> ```text theme={null}
> POSITION
> Name:            Customer Success Manager
> Tags:            US, EMEA
> Intro video:     intro.mp4
>
> QUESTION 1
> Title:           Tell us about yourself
> Description:     Give us a short introduction: your background, what you're working on right now, and why this Customer Success role caught your eye.
> Attachment:      none
>
> QUESTION 2
> Title:           Handling an upset customer
> Description:     Watch the video, where a long-time customer explains why they're frustrated with our product. How would you respond to them, and what would you do in the first 48 hours to win back their trust?
> Attachment:      video: q2-upset-customer.mp4
>
> QUESTION 3
> Title:           What does this chart tell you?
> Description:     This chart shows the monthly churn rate for one of our customer segments over the past year. What stands out to you, and what would you look into first?
> Attachment:      image: q3-churn-chart.png
>
> OUTRO
> Title:           Thanks for completing the interview!
> Text:            We review every interview personally and will get back to you within 5 business days. Questions in the meantime? Reach out to jobs@example.com.
> Video:           none
> ```
>
> Texts can be in any language — your AI tool sends them exactly as you wrote them.

What each part means:

* **Name** — the job title candidates see.
* **Tags** — optional labels to organize your positions in the dashboard.
* **Intro video** — an optional video shown before the first question. There's no intro text: without a video, candidates see the job title, the number of questions, and the **Start Interview** button.
* **Question title and description** — the title is capped at 40 characters, so it's usually a short label (e.g. "Motivation"). Use the **description** (up to 1200 characters) for the actual question, context, or instructions — you'll want one on most questions.
* **Attachment** — optionally, **one** [video prompt](https://hireflixsl.mintlify.site/user/building-the-interview/creating-a-video-interview.md) (you asking the question on camera) **or one** [image](https://hireflixsl.mintlify.site/user/building-the-interview/image-prompt-questions.md) (a diagram, chart, design, ...) per question. Candidates always answer by recording a video, whatever the attachment.
* **Outro** — the screen candidates see after the last question: a title, a text, and optionally a video.

> [!WARNING]
>
> **Don't tailor question or position settings unless you really need to.** The template has no fields for thinking time, answer time limit, or retakes on purpose: Hireflix's defaults (30 seconds thinking time, 2 minutes to answer, no retakes) work well for most interviews, and your AI tool won't ask about them.
>
> If you do need something different, just say it in plain words:
>
> * **For the whole interview**, e.g. "give candidates 3 minutes per answer" — it sets this once for the entire position, so you can still change it later in one place.
> * **For one specific question**, e.g. "give question 4 five minutes, the rest can keep the defaults" — only do this when a question really needs it. A question with its own settings is marked as having **custom settings** and no longer follows the position-wide values, so later changes to the interview settings won't apply to it.
>
> See [Tailoring the Interview](https://hireflixsl.mintlify.site/user/building-the-interview/tailoring-the-interview.md) for what each setting means for candidates.

### Attaching videos and images

Attach files directly to your chat message and reference them by file name in the template (e.g. `video: intro.mp4`, `image: org-chart.png`). Your AI tool uploads them for you. In Claude, make sure you've allowed the websites from the [setup step](#setup) first.

* **Videos**: max **150 MB** each, any format (Hireflix converts it after upload). A 4:3 aspect ratio fills the screen best; 16:9 works but shows black bars.
* **Images**: max **10 MB** each, any image type (JPEG, PNG, GIF, WebP, SVG). **One image per question** — if you want to show several images, create one image question per image.

> [!NOTE]
>
> Your AI tool never compresses, resizes, or converts your files. If a file is too large or isn't a video/image, it tells you exactly what's wrong (e.g. "that file is 240 MB, 90 MB over the limit") so you can shrink it yourself, for example with [HandBrake](https://handbrake.fr/).

### What gets checked before creating the position

* **Required fields** — a name and at least one question with a title. Fields you leave empty, leave on the placeholder text, or set to "none" are skipped.
* **Character limits** — if a title or text is too long, your AI tool tells you which field and by how much, and asks you for a shorter version. It never shortens or rewrites your text itself.
* **Outro** — if you keep the outro block (even just for the video), it needs both a title and a text.
* **Your content stays yours** — your AI tool doesn't invent questions or texts. Want suggestions? Ask it to draft questions for a role first, then paste the ones you like into the template.

Once the position is created, your AI tool shares its ID. You can review it in the [interview builder](https://hireflixsl.mintlify.site/user/building-the-interview/creating-a-video-interview.md), add [branding](https://hireflixsl.mintlify.site/user/building-the-interview/branded-interview-page.md), or ask it to make changes, like adding a question or renaming the position.

## Explore your account

With your API key set for the session, try asking things like (make sure to first [create a position](#create-a-position-via-chat) so you have some dummy data):

* "Which candidates have been waiting the longest for someone to review their Hireflix interview? List all interviews that are completed but not yet evaluated, across all my active positions, with the one that has been waiting the longest at the top. For each, show the position, candidate name and email, the date they finished, how many days they've been waiting, and their score if there is one."
* "Give me an Excel sheet with all active positions and every candidate who has been invited, with each candidate's status (invited, to evaluate, shortlisted, discarded) in its own column."
* "Can you pull interview stats (per stage) for each of the positions (total, pending, to evaluate, shortlisted, and discarded)?"
* "Can you give me an overview of the questions and answers for the following completed interview for position `<position-id>`?"
* "Can you download all videos for position with ID `<position-id>`?"
* "Can you invite `<firstname>` `<lastname>` `<email>` to my new position?"
* "Can you help me list all positions for Hireflix in my account?"

Your AI tool will use the schema and examples from the skill file to write and run the right GraphQL queries against your account behind the scenes.

![Example Claude conversation using the Hireflix skill to list positions and interview stats](https://mintcdn.com/hireflixsl/Ypm7QQvPzDIYtdD0/images/hireflix-userguide-claude-skill-demo.png?fit=max\&auto=format\&n=Ypm7QQvPzDIYtdD0\&q=85\&s=c033fa0bd83e84c562e38f5eab5fad86)

Claude's response after being asked to list all positions

## What's next?

> [card] [Create a Video Interview](https://hireflixsl.mintlify.site/user/building-the-interview/creating-a-video-interview.md)
>
> Customize your interview questions and flow before inviting real candidates.

> [card] [Use the Hireflix MCP](https://hireflixsl.mintlify.site/user/getting-started/mcp.md)
>
> Connect your AI tool of choice to your Hireflix account with the MCP server: no API key needed.


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