Ask Eddy AI API

The Eddy AI Public API lets you embed Eddy AI's assistive search directly into your own platform or service, so users can query your knowledge base without visiting your documentation site. You call the API endpoint with a prompt and receive an AI-generated answer drawn from your knowledge base content. This gives you full control over the search interface — including how it looks, where it appears, and how it behaves within your product. The API is available through the Document360 API hub.

When to use the Eddy AI Public API

• Embedded search in your product — surface knowledge base answers inside your application UI, without redirecting users to a separate documentation site.
• Custom search interfaces — build a search experience that matches your brand's color scheme, terminology, and layout.
• Automated support workflows — integrate Eddy AI into chatbots, ticketing systems, or onboarding flows that query your knowledge base programmatically.

Before you begin

• The Eddy AI Public API must be enabled in your project settings (see How to enable the Public API below).
• You need an API token with the POST method enabled (see How to create an API token below).
• The AI assistive search toggle requires at least one delivery checkbox (Public API or others) to remain selected — deselecting all checkboxes will automatically turn off the toggle.

How to enable the Public API

1. In the Knowledge Base portal, select Settings (⚙) in the left navigation bar.
2. In the left navigation pane, go to AI features > Eddy AI.
3. Expand the AI search suite accordion.
4. In the AI assistive search section, select the Public API checkbox.

How to create an API token

You need an API token to authenticate requests to the Eddy AI Public API.

1. In the Knowledge Base portal, select Settings (⚙) in the left navigation bar.
2. In the left navigation pane, go to Knowledge base portal > API Tokens.
3. Click Create API Token, enter a token name, and set the method to POST.
4. Click Create, then copy the generated API token and store it securely.

How to test the API

You can test the Eddy AI Public API in two ways — through the Document360 API documentation or through the Swagger API hub.

Test via API documentation

1. Go to the Document360 API documentation.
2. On the right side of the page, select the Try it section.
3. In the Token field, enter your API token.
4. Fill in the Body fields:

5. Click Try it & see response. The AI-generated response appears below.

Test via Swagger

1. Go to the Swagger API hub. The Ask Eddy AI API is listed under Project versions.

2. In the top-right corner, click Authorize.

3. In the Available authorizations panel, paste your API token and click Authorize.

4. Navigate to Project versions > /v2/ProjectVersions/ask-Eddy AI and click Try it out.

   The default request box appears with the following fields to complete:

To retrieve your Version ID, call the /v2/ProjectVersions endpoint first:

5. Click Execute. A successful response contains the AI-generated answer and source article details.

Best practices

• Store API tokens securely — treat your API token as a secret. Do not expose it in client-side code or public repositories. Rotate it if it is compromised.
• Use the correct ID type for your content — standard articles use articleID, but Pagecategory articles require categoryID. Using the wrong ID returns null fields in the response. See the FAQ for details.
• Specify the language code explicitly — always pass the correct language code in the request body to ensure Eddy AI searches the right language version of your knowledge base.
• Handle error responses — implement error handling for 400 (API access disabled) and 500 (service error) responses. Both typically indicate the Public API checkbox is not enabled.

FAQ

{
"category_id": "_categoryid",

"category_title": "Title",

"category_slug": "slug",

"version_name": "v1",

"version_slug": "v1",

"article_id": null,

"article_title": null,

"article_slug": null,

"version_display_name": null

}