The IQX AI Gateway is the single front door for every AI feature in IQX. Instead of each part of the product talking to an AI provider directly, everything — the IQXAssist chat your consultants use, the wiki help assistant, CV reformatting, document and photo reading, audio transcription — calls one internal service. That service picks a model, routes the request, retries elsewhere if something is down, meters the spend, logs the usage, and hands the answer back.

In short, it is an AI router and control plane: the clever bits (which model, failover, cost caps, encryption) live in one place, so every IQX feature behaves the same way and we can add or swap models without touching the apps.

—-

IQXAssist is the assistant your consultants talk to inside IQX. Unlike a standard “question and answer” bot, it is context-aware: it knows which candidate or contact record you are viewing and can pull live data specific to them.

Two modes

The chat works in two modes depending on what you ask:

• Conversational — answers general questions, drafts text, or summarises information already in the chat.
• Agent (live data) — when you ask for specific records or actions (e.g. “show me open shifts”), it uses secure tools to fetch real-time data from IQX before answering.

Every session is tied to the record you are viewing. Navigate to a different candidate and a new chat begins, so data can't cross over between records.

IQXAssist has strictly defined tools that let it read specific parts of a record. These are read-only and never change anything.

IQXAssist can also do things on your say-so — propose a shift booking or record an availability change.

One of the handiest features is drafting communications:

• Emails — ask it to “write an email…” and it produces a professional, contact-event-ready email (subject and body).
• Text / SMS — ask for a “text message” and it keeps the wording short and casual, suitable for mobile.

• Streaming responses — answers appear in real time as the AI works, rather than waiting for the whole reply.
• Auto-titling — each session is given a short title from the first few messages, so it's easy to find later.

—-

Every capability is also a single HTTP call, so any IQX service or script can use it. Authenticate with a Bearer key — the optional user id after the dot attributes usage to a person:

Authorization: Bearer YOUR_KEY.USER_ID

Here is what each endpoint takes in and gives back.

Send an image plus a prompt. Ask a plain question and get an answer, or ask for the fields and they come back parsed in response.json. Driving licences, passports, DBS certificates, timesheets, whiteboards — all fair game.

Finds the portrait on a licence, passport or ID card and crops it out — ready to save straight to the candidate's record as their profile picture.

Drop in a voice note or interview recording and get an accurate transcript straight back.

Upload a candidate's CV (PDF or Word) plus your template and logo; get back a consistent, branded CV. Personal contact details are automatically redacted in the process.

Clean up a candidate's own words into polished, professional CV copy.

Send a record (or any document) plus a prompt and get a tidy answer back — great for summaries embedded in other IQX screens.

Point any OpenAI SDK at /v1 and it just works — streaming and tools included. The gateway picks the model and handles failover underneath. GET /v1/models returns a friendly model list for a picker.

—-

—-

—-

Keys, capabilities and spend caps are managed by IQX in the gateway admin. If you need a key for a new service or client, or want a capability enabled, contact the IQX development team.