AIQ Control
PU

API reference

Legacy-compatible contracts for AIQ clients and server integrations.

Endpoints
GET/statusGET/cost?id={costId}POST/boolPOST/processPOST/listPOST/analyzePOST/analyzedataPOST/webcrawlPOST/netquery
Compatibility headers
All endpoints except /status require an organisation key. Legacy model and cost controls are preserved.
x-api-key: aiq_live_your_key

x-model: openai|gpt-5.4|low or openrouter|openai/gpt-5.4-mini|high. Add x-aiq-include-costs: true, ?includeCosts=true, or the equivalent body field to include per-result costs.

GET
/status
Public container health status.

Request

curl https://api.example.com/status

Response

{"status":"Application is running!"}
GET
/cost?id={costId}
Return the numeric cost for a persisted request.

Request

curl "https://api.example.com/cost?id=$COST_ID" \
  -H "x-api-key: $AIQ_API_KEY"

Response

0.00382
POST
/bool
Return a reasoned boolean decision.

Request

curl -X POST https://api.example.com/bool \
  -H "x-api-key: $AIQ_API_KEY" -H "content-type: application/json" \
  -d '{"query":"Is this application complete?"}'

Response

{"reasoning":"...","output":true}
POST
/process
Process a prompt using the supplied system instruction.

Request

curl -X POST https://api.example.com/process \
  -H "x-api-key: $AIQ_API_KEY" -H "content-type: application/json" \
  -d '{"prompt":"Summarise this","system":"Be concise"}'

Response

"The concise result"
POST
/list
Generate a structured string list. Query may be in JSON or the query string.

Request

curl -X POST https://api.example.com/list \
  -H "x-api-key: $AIQ_API_KEY" -H "content-type: application/json" \
  -d '{"query":"List the risks"}'

Response

["Risk one","Risk two"]
POST
/analyze
Analyze a multipart file once for each question.

Request

curl -X POST https://api.example.com/analyze \
  -H "x-api-key: $AIQ_API_KEY" \
  -F 'file=@document.pdf' -F 'questions=["What is the total?"]' \
  -F 'contextPrompt="Read the document carefully"'

Response

[{"question":"What is the total?","finalAnswer":"..."}]
POST
/analyzedata
Analyze supplied data once for each question.

Request

curl -X POST https://api.example.com/analyzedata \
  -H "x-api-key: $AIQ_API_KEY" -H "content-type: application/json" \
  -d '{"data":"...","questions":["What changed?"]}'

Response

[{"question":"What changed?","finalAnswer":"..."}]
POST
/webcrawl
Inspect a public website and answer questions with web search grounding.

Request

curl -X POST 'https://api.example.com/webcrawl?url=https://example.com' \
  -H "x-api-key: $AIQ_API_KEY" \
  -F 'questions=["What services are offered?"]' -F 'contextPrompt="Research the site"'

Response

[{"question":"...","consensusSummary":"...","finalAnswer":"..."}]
POST
/netquery
Answer internet research questions, optionally anchored to a URL.

Request

curl -X POST https://api.example.com/netquery \
  -H "x-api-key: $AIQ_API_KEY" \
  -F 'questions=["What are the latest requirements?"]' -F 'contextPrompt="Research comprehensively"'

Response

[{"question":"...","consensusSummary":"...","finalAnswer":"..."}]