This article describes the API endpoint used to send a question to the Concierge AI assistant and retrieve its answer through the API Toolkit.
The following endpoint is covered:
/api/concierge: Send a question to Concierge and receive the AI-generated answer along with related search results, reports, and documentation answers.
Prerequisites:
- Set up API access, verify that you have API access, and obtain a token via the get_token call OR
- Generate Personal API Token.
Table of Contents
NOTES:
- The API Toolkit UI itself is available only to Admins and Power Users. The
/api/conciergeendpoint has no additional role restriction beyond being logged in, so any authenticated user, including a Regular User, can call it directly with an API token.
1. Access Admin > System > API Toolkit
2. Send a Question to Concierge
GET or POST request to /api/concierge sends a question to the Concierge AI assistant and returns its answer together with related search results, reports, and documentation answers.
- Item: concierge
- Method: GET or POST
- If GET is selected, fill the Query parameters in the following format:
q=Enter your question here&tools=tool - If POST is selected, choose JSON request and provide the values in the request body as in the example below:
- If GET is selected, fill the Query parameters in the following format:
{
"q": "What is my revenue trend?",
"tools": "search,docs"
}
- q: The question or prompt to send to Concierge. Required.
- tools (optional): Enter a comma-separated list of Custom Service names that Concierge uses to answer the question.
- Find valid names in Admin > Concierge > Concierge Setup > External Resource Configuration grid, or use the fixed names
search,glossary,faq,docsfor built-in content types enabled there.
- Find valid names in Admin > Concierge > Concierge Setup > External Resource Configuration grid, or use the fixed names
- Enter an API Token.
- [Run request]
Example Response
{
"response": "Canada's most recent Daily Sales figures show steady growth, with Country Analysis and Sales Analysis both reflecting an upward trend.",
"docs_answer": null,
"search_results": null,
"related_reports": {
"data_type": "related_reports",
"elements": [
{ "name": "Country Analysis", "element_id": 2279 },
{ "name": "Sales Analysis", "element_id": 2261 }
]
}
}
Fields Description
| Field | Description |
|---|---|
response | Concierge’s generated answer (HTML). Omitted when report_data=N, or when nothing was generated. |
docs_answer | Help Docs, Glossary, or FAQ answer, if one matched. docs_answer.data_sources identifies which:
Omitted when |
search_results | Results from a search-capable source; e.g., search. Only returned when tools explicitly includes one, regardless of report_data. |
related_reports | {data_type, elements: [{name,
element_id}]} listing MI Reports/Elements Concierge judged related to the question. Observed only when tools is left empty. |