Agents

For AI assistants: ask a business's public website assistant a question (no key).

POST/v1/agents/{org}/{door}/ask

Ask a business's website assistant a question

askAgentDoorNo keySince 2026-10-01

For AI assistants and search tools, with no key: one question to a business's public website assistant, answered in writing from what the business has told it, with the same rules as a typed conversation on its page. Only for a public page whose business opted it in (its agent card is at /v/{org}/{door}/agent-card.json, its llms.txt at /v/{org}/llms.txt); any other address is 404 not_found. Nothing is stored and no details are taken: a person is pointed to url to talk, book or reach the team. The question and the answer have email addresses, phone numbers and payment or identity numbers removed, and the answer is marked aiGenerated. Limited per caller and per page (429 rate_limited with Retry-After); 503 capacity when no answer could be written just then.

Path parameters

orgstringrequired
The name in the assistant's public page address: https://app.zentiqai.com/v/{org}/{door}.
doorstringrequired
The name in the assistant's public page address: https://app.zentiqai.com/v/{org}/{door}.

Body

questionstringrequired
One question, up to 800 characters. Leave out people's names and contact details: email addresses, phone numbers and payment or identity numbers are removed before it is read.
1-800 characters

Returns

200 The answer. data is AgentAnswer.

Fields of data

answerstringrequired
The assistant's written answer, from what the business has told it. Email addresses, phone numbers and payment or identity numbers are removed.
urlstringrequired
The assistant's own page, where a person can talk to it, book or reach the team.
aiGeneratedtruerequired
Always true: the answer is AI-generated (EU AI Act Article 50(2)). Say so when you pass it on.

Errors

invalid_request not_found rate_limited server_error capacity

Request

curl -X POST "https://app.zentiqai.com/v1/agents/ORG/DOOR/ask" \
  -H "Content-Type: application/json" \
  -d '{
  "question": "Are you open on Saturdays?"
}'

import { Zentiq } from "@zentiq/node";

const zentiq = new Zentiq({ apiKey: process.env.ZENTIQ_API_KEY });
const result = await zentiq.askAgentDoor("ORG", "DOOR", {
  question: "Are you open on Saturdays?",
});

import os
from zentiq import Zentiq

zentiq = Zentiq(api_key=os.environ["ZENTIQ_API_KEY"])
result = zentiq.ask_agent_door("ORG", "DOOR", {
    "question": "Are you open on Saturdays?",
})

Example answer

Response

{
  "data": {
    "answer": "Yes, we're open on Saturdays from 9am to 1pm.",
    "url": "https://www.example.com",
    "aiGenerated": true
  },
  "error": null,
  "requestId": "req_4f1c2e9a7b3d5e6f7a8b9c0d"
}