Ask Eddy AI API

Plans supporting the use of Ask Eddy AI API

The Eddy AI Public API is an invaluable feature designed to enhance the functionality and flexibility of our Eddy AI search feature. The Eddy AI Public API is particularly useful for businesses looking to deeply integrate AI-driven search capabilities directly into their own platforms or services. By embedding Eddy AI into your product, you provide users with the ability to access powerful search functionality without needing to visit your documentation site.

This API offers greater flexibility in customizing the user interface, allowing you to tailor aspects like color, naming, and placement to align with your brand and user experience. With this seamless integration, Eddy AI becomes a natural extension of your product, enhancing user interactions and improving search efficiency. By exposing the API endpoints, you can incorporate them into your platforms, effortlessly extract answers from Eddy AI and build a customized search experience.

NOTE

Other than English (en-US, en-GB), the Eddy AI Public API supports five more languages such as

French (fr)

Spanish (es)

German (de)

Norwegian (no)

Dutch (nl)

Using the Public API

1. Navigate to the Settings () > AI Features > Eddy AI in the Knowledge base portal.

2. In AI assistive search, select the Public API checkbox.

NOTE

1. Ensure at least one of the checkboxes is selected. Otherwise, the AI assistive search toggle will be automatically disabled.

2. If the Public API is not enabled, you'll receive a 500 response code error while using Ask Eddy AI API.

3. Each API call will reduce your total credit count by one.

3. Create authorization API token.

NOTE

1. In the Knowledge Base portal, navigate to Settings () > Knowledge Base Portal > API Tokens.

2. Click Create API Token, enter the token name, and specify the POST method.

3. Click Create and copy the generated API token.

4. You can find the API structure at the API hub.

Try the Eddy AI Public API in our API docs

1. Navigate to the Document360 API documentation.

2. On the right side of the page, click the Try it section.

3. In the Token field, field, enter the API token generated from your Document360 project.

4. Enter the desired values in the Body section. The default request box will appear as follows:

   1. Prompt: Enter the question or query.

   2. Version ID: Obtain the current version ID.

   3. Language Code: Specify the desired language code for the input.

5. Click Try it & see response and the response will be generated.

Try the Eddy AI Public API in Swagger

1. Navigate to the Swagger API hub. Under project versions, you can find the Ask Eddy AI API.

2. In the top right of the Swagger API hub and click Authorize.

3. The Available authorizations panel will appear, prompting you to enter the API token.

4. Paste the API token into the Available Authorizations window and click Authorize.

5. Once authorized, navigate to Project versions > /v2/ProjectVersions/ask-Eddy AI and click Try it out.

6. The default request box will appear as follows:

• Prompt: Enter the question or query.

• Version ID: Obtain the current version ID from the /v2/ProjectVersions endpoint.

  

• Language Code: Specify the desired language code.

7. Click Execute to receive a successful response containing all required information.

NOTE

If you receive a service unavailable message, ensure the Public API is enabled in the settings.

{
  "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
}