Developer API
Call the NextiqumAI agents (Iris, Mark, Loquelle and the Docs & Voice tools) from your own server with a secret key. Included with the Business plan.
API reference
How do I authenticate?
Generate a secret key in Settings → Developer API (Business plan). Send it as a Bearer token. Use the key from your own server only, never expose it in a browser or app. Calls draw on your plan’s run pool (see limits).
Base URL: https://www.nextiqumai.com/api
# every request carries your key in the Authorization header Authorization: Bearer nx_live_xxxxxxxxxxxxxxxxxxxx
POST Mark: project scope
/api/scope.php
Turn a plain-language project idea into a structured build plan (type, timeline, stack, phases, considerations).
curl https://www.nextiqumai.com/api/scope.php \ -H "Authorization: Bearer nx_live_..." \ -H "Content-Type: application/json" \ -d '{"description":"A booking app for dental clinics with reminders and payments."}'
POST Iris: website audit
/api/audit.php
Audit a public URL and return prioritised quick wins for SEO, UX and trust, with a score.
curl https://www.nextiqumai.com/api/audit.php \ -H "Authorization: Bearer nx_live_..." \ -H "Content-Type: application/json" \ -d '{"url":"https://example.com"}'
POST Ask a document (Docs & Voice)
/api/ask.php
Answer a question strictly from text you provide, plus the document’s main points. Returns { "answer": "...", "key_points": [...] }.
curl https://www.nextiqumai.com/api/ask.php \ -H "Authorization: Bearer nx_live_..." \ -H "Content-Type: application/json" \ -d '{"context":"<your document text>","question":"What is the refund window?"}'
POST Document extract (Docs & Voice)
/api/extract.php · multipart/form-data
Pull structured data from a photo of an invoice, receipt, ID or form. Returns { "data": {...} }. Image up to 8 MB.
curl https://www.nextiqumai.com/api/extract.php \ -H "Authorization: Bearer nx_live_..." \ -F "[email protected]"
POST Voice to notes (Docs & Voice)
/api/transcribe.php · multipart/form-data
Transcribe an audio file and return a clean transcript plus notes: a short summary and the key points or action items. Returns { "transcript": "...", "notes": "..." }. Length limit follows your plan.
curl https://www.nextiqumai.com/api/transcribe.php \ -H "Authorization: Bearer nx_live_..." \ -F "[email protected]"
POST Loquelle: recap and prep pack
/api/copilot.php · JSON
Two modes of the same endpoint. prep turns a brief and an optional document into a pre-call pack: likely questions with answers, points to land, questions to ask. keypoints turns a transcript into the recap Loquelle writes at the end of a call: key points, decisions, action items and a follow-up email. Each call is one run from your pool. Live suggestions during a call are not offered through the API; transcribe with the endpoint below and send the text here.
# prep pack curl https://www.nextiqumai.com/api/copilot.php \ -H "Authorization: Bearer nx_live_..." \ -H "Content-Type: application/json" \ -d '{"mode":"prep","context":"Sales call with a Shopify brand, I am the founder","doc":"optional document text"}' # recap from a transcript curl https://www.nextiqumai.com/api/copilot.php \ -H "Authorization: Bearer nx_live_..." \ -H "Content-Type: application/json" \ -d '{"mode":"keypoints","context":"Weekly status, I am the project manager","transcript":"...the call, as text...","mid":"any-id-for-this-meeting"}' # reply {"answer":"KEY POINTS:\n- ...\nDECISIONS:\n- ...\nACTION ITEMS:\n- ...\nFOLLOW-UP EMAIL:\nSubject: ..."}
POST Loquelle: transcribe a clip
/api/copilot-audio.php · multipart/form-data
The transcription Loquelle uses live. Send audio in chunks of a few seconds (webm, ogg or m4a, 8 MB each at most) and get the text back; join the chunks and send them to keypoints above. Counts against your Loquelle minutes, not the run pool.
curl https://www.nextiqumai.com/api/copilot-audio.php \ -H "Authorization: Bearer nx_live_..." \ -F "[email protected]" {"transcript":"...what was said in this chunk..."}
GET Usage: what is left on the key
/api/usage-summary.php
Your plan, the run pool (cap, used, and whether it resets daily or monthly), per-agent counts and Loquelle minutes, so a client can back off before it hits a limit instead of after.
curl https://www.nextiqumai.com/api/usage-summary.php \
-H "Authorization: Bearer nx_live_..."
{"user":{"plan":"biz",...},"pool":{"cap":5600,"used":112,"period":"month"},"agents":[...],"cue":{...}}
What are the rate limits and errors?
Each key draws on your plan’s shared run pool (Business: 5600 runs a month across Mark, Iris and Docs & Voice combined, with a burst cap of 300 in any single day). Loquelle has its own separate meeting-minute allowance. Responses are JSON. On a problem you get an { "error": "code" } with an HTTP status:
| Status | Meaning |
|---|---|
| 400 | Missing or unusable input: no file, no question, a description too short, an empty transcript |
| 401 | Wrong key (invalid_key; the body repeats the request id). With no key at all, Mark and Iris answer as a visitor on the free public limits, usage answers "user":null, and the other endpoints answer 401 login |
| 403 | Account paused for security (locked); confirm at nextiqumai.com/account |
| 405 | Wrong method (these endpoints are POST, usage is GET) |
| 409 | Another Loquelle session is already running on this account (busy) |
| 413 | File too large or clip too long |
| 415 | Unsupported file type |
| 422 | Iris could not read the page: the site refused our reader or did not answer (fetch_failed, blocked). The run is not counted |
| 429 | Rate or run limit reached; usage above tells you before it happens |
| 503 | The model or the speech service is busy or not set up (upstream, stt_failed); retry shortly |
Every response to a key-authenticated request carries an X-NX-Request-Id header, and a 401 repeats it in the body. Quote it when you write to support and we can find the exact call.
Questions developers ask
Which endpoints are available?
Eight, all under the same base URL and the same Bearer key:
- Mark, project scope: turns a plain-language brief into a structured scope
- Iris, website audit: the SEO and AI-search scores with the prioritised fixes
- Ask a document: answers a question from document text you send, with its main points
- Document extract: structured data from a photo of an invoice, receipt, ID or form
- Voice to notes: a transcript and written notes from an audio file
- Loquelle: a pre-call prep pack or a recap from a transcript (one endpoint), and live transcription (a second)
- Usage: what is left on the key, so a client backs off before a limit
Is the API free to use?
It is included with the Business plan: keys are created in Settings under Developer API. Calls draw on the same monthly run pool as the website, so there is no separate API bill and nothing to top up twice. Loquelle transcription counts against your Loquelle minutes; its prep and recap modes draw on the run pool like everything else.
Will the endpoints change?
Responses may gain fields, and we will not remove or rename a field without notice to the email on your account. Every error is a JSON object with a single error code and an HTTP status, so a client that checks either keeps working across changes.
Where do I report a problem or ask for an endpoint?
Email [email protected] with the X-NX-Request-Id from the response headers if you have it. Security issues go to the address in our security.txt. If you need something the API does not cover, that is usually a custom build, and the same team answers both.