Perform AI assistive search within project version

Prev Next
Post
/v2/ProjectVersions/ask-eddy
Security
API Key: api_token
Header parameter nameapi_token

The API token used for authenticating the request. This must be passed as a header parameter. To generate an API token, go to Settings > Knowledge base portal > API tokens. This token must correspond to a valid workspace and permission level.

Body parameters
object
prompt
string | null
version_id
string | null
language_code
string | null
enable_citation
boolean
object
prompt
string | null
version_id
string | null
language_code
string | null
enable_citation
boolean
object
prompt
string | null
version_id
string | null
language_code
string | null
enable_citation
boolean
object
prompt
string | null
version_id
string | null
language_code
string | null
enable_citation
boolean
Responses
200

Success

Success status response

This is sample response for this endpoint.

{
  "prompt": "How to configure single sign-on in Document360?",
  "result": "

To configure Single Sign On in Document360, follow these steps:



  1. Access the Azure AD portal and log in to your Microsoft Azure account.

  2. Add your application by logging in to your Azure account, visiting the Azure portal page, and selecting the New application option.

  3. Navigate to Document360 portal, select Settings → Users Security → SAML/OpenID → SAML, and set up your application by copying the parameters from Document360 to the Azure AD portal.

  4. Configure SAML based SSO settings by copying and pasting values between Document360 and Azure AD portal.

  5. Test the configuration by logging into Document360 using the credentials added to the registered application.

\",\r\n", "reference_articles": [ { "id": null, "citation_id": null, "category_id": "807cafd4-5d9b-4be6-becd-906f1509b0db", "category_title": "SAML", "category_slug": "saml", "version_name": "Document360 2.0", "version_slug": "help", "article_id": "fb0444b1-6ff6-41dc-b68b-93e86c0470cc", "article_title": "SAML SSO with Azure AD", "article_slug": "saml-sso-with-azure-ad", "version_display_name": null, "language_code": null, "data_source_type": 0, "external_source_link": null, "external_source_name": null, "external_source_id": null, "is_attachment": false, "attachment_url": null, "attachment_title": null }, { "id": null, "citation_id": null, "category_id": "807cafd4-5d9b-4be6-becd-906f1509b0db", "category_title": "SAML", "category_slug": "saml", "version_name": "Document360 2.0", "version_slug": "help", "article_id": "4a88b443-fbdb-4dc7-882a-e802bb9de6e9", "article_title": "Identity Provider (IdP) initiated login", "article_slug": "idp-initiated-login", "version_display_name": null, "language_code": null, "data_source_type": 0, "external_source_link": null, "external_source_name": null, "external_source_id": null, "is_attachment": false, "attachment_url": null, "attachment_title": null }, { "id": null, "citation_id": null, "category_id": null, "category_title": null, "category_slug": null, "version_name": null, "version_slug": null, "article_id": null, "article_title": null, "article_slug": null, "version_display_name": null, "language_code": null, "data_source_type": 1, "external_source_link": "https://example.com/", "external_source_name": "Example source", "external_source_id": null, "is_attachment": false, "attachment_url": null, "attachment_title": null } ], "limit_exceeded": false, "analytics_id": "8ac6020b-d329-4968-b562-5497c88e65a6", "remaining_credits": 10, "extension_data": null, "context": null, "success": true, "errors": [], "warnings": [], "information": [], "feature_explorer_status": null, "custom_page_element": null }
Expand All
object
prompt
string | null
result
string | null
reference_articles
Array of object (VectorSearchReferenceArticles) | null
object
id
string | null
citation_id
string | null
category_id
string | null
category_title
string | null
category_slug
string | null
version_name
string | null
version_slug
string | null
article_id
string | null
article_title
string | null
article_slug
string | null
version_display_name
string | null
language_code
string | null
data_source_type
integer (int32)
Valid values[ 0, 1 ]
external_source_link
string | null
external_source_name
string | null
external_source_id
string | null
is_attachment
boolean
attachment_url
string | null
attachment_title
string | null
limit_exceeded
boolean
analytics_id
string | null
remaining_credits
integer (int32)
extension_data
object | null
context
object | null
extension_data
object | null
caller_reference
string | null
success
boolean
errors
Array of object (BaseError) | null
object
extension_data
object | null

This is the Extension data object

stack_trace
string | null

A technical trace showing where the error occurred within the system. Intended for backend debugging.

description
string | null

A clear message explaining what caused the error. This helps quickly understand what went wrong.

error_code
string | null

A short, predefined code that identifies the type of error. Useful for logging the error or raising a support request.

custom_data
object | null

Any structured metadata for the error object.

property*
warnings
Array of object (BaseWarning) | null
object
extension_data
object | null

Extension Data for customer Api warning

description
string | null

A plain message that describes the warning and helps understand what should be reviewed.

warning_code
string | null

A short, predefined code that uniquely identifies the warning type.

information
Array of object (BaseInformation) | null
object
extension_data
object | null

Extension data for customer Api response information

description
string | null

A plain message offering helpful context about the response, such as confirmation of fallback logic or skipped operations.

feature_explorer_status
object | null
feature_usage_score
number (double)
section
integer (int32)
Valid values[ 0, 1, 2, 3, 4, 5 ]
feature_id
string | null
feature_name
integer (int32)
Valid values[ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26 ]
advanced_feature_user_role
integer (int32)
Valid values[ 0, 1, 2 ]
feature_explorer_user_analytics
object | null
id
string | null
project_id
string | null
user_id
string | null
trophy_status
object | null
first
boolean
second
boolean
third
boolean
fourth
boolean
show_default
boolean
show_advanced_section_popup
boolean
hide_popup
boolean
hide_popup_date
string (date-time)
is_advanced_section_unlocked
boolean
usage_score
number (double)
features
Array of object (FeatureAnalytics) | null
object
section
integer (int32)
Valid values[ 0, 1, 2, 3, 4, 5 ]
feature_name
integer (int32)
Valid values[ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26 ]
is_feature_explored
boolean
time_stamp
string (date-time)
is_closed_content_reuse_info
boolean
custom_page_element
object | null
element_type
integer (int32)
Valid values[ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 100, 101, 102, 103, 104, 105, 106, 107, 108 ]
element_name
string | null
element_guid
string | null
display_name
string | null
view_styles
object | null
property*
view_properties
object | null
property*
editable_properties
Array of object (FormEditableProperties) | null
object
element_name
string | null
element_type
integer (int32) | null
Valid values[ 0, 1, 2, 3, 4, 5, 6, 7, 8 ]
label
string | null
value
string | null
view_form_control
object | null
property_key
string | null
is_children
integer (int32)
view_type
string | null
element_name
string | null
is_children_root
boolean
element_type
string | null
inverted_value
boolean
is_dirty
boolean
editable_properties
object | null Recursive
element_guid
string | null
children
Array of object (FormEditableProperties) | null
object Recursive
edit_component_style_properties
object | null
property*
edit_component_properties
object | null
property*
children
Array of object (UIElement) | null
object Recursive
400

Bad Request

Invalid prompt

Kindly ensure the prompt is not empty and perform the task again.

{
  "extension_data": null,
  "success": false,
  "errors": [
    {
      "extension_data": null,
      "stack_trace": null,
      "description": "Prompt should not be empty",
      "error_code": null,
      "custom_data": null
    }
  ],
  "warnings": [],
  "information": []
}
Invalid project version ID

Kindly ensure the project version ID is not empty and perform the task again.

{
  "extension_data": null,
  "success": false,
  "errors": [
    {
      "extension_data": null,
      "stack_trace": null,
      "description": "Project version ID should not be empty",
      "error_code": null,
      "custom_data": null
    }
  ],
  "warnings": [],
  "information": []
}
Invalid language code

Kindly ensure the language code is not empty and perform the task again.

{
  "extension_data": null,
  "success": false,
  "errors": [
    {
      "extension_data": null,
      "stack_trace": null,
      "description": "Language Code should not be empty",
      "error_code": null,
      "custom_data": null
    }
  ],
  "warnings": [],
  "information": []
}
Public API access is disabled

Kindly ensure the public API is enabled and perform the task again.

{
  "extension_data": null,
  "success": false,
  "errors": [
    {
      "extension_data": null,
      "stack_trace": null,
      "description": "API access is disabled. Please contact your project administrator.",
      "error_code": null,
      "custom_data": null
    }
  ],
  "warnings": [],
  "information": []
}
Expand All
object
extension_data
object | null

Extension data for customer API response

success
boolean

Indicates the status of the API response. A value of true signifies that the request was successfully processed, while false indicates a failure or error occurred.

errors
Array of object (BaseError) | null

A list of errors encountered during the API request. Each error object provides details about the problem, including an error code and a message explaining the issue. This field is populated when the request fails or encounters issues.

object
extension_data
object | null

This is the Extension data object

stack_trace
string | null

A technical trace showing where the error occurred within the system. Intended for backend debugging.

description
string | null

A clear message explaining what caused the error. This helps quickly understand what went wrong.

error_code
string | null

A short, predefined code that identifies the type of error. Useful for logging the error or raising a support request.

custom_data
object | null

Any structured metadata for the error object.

property*
warnings
Array of object (BaseWarning) | null

A list of warnings generated during the API request. These are non-critical issues or recommendations that might affect the request but won't stop it from processing. Each warning object provides a message to inform the user of potential problems.

object
extension_data
object | null

Extension Data for customer Api warning

description
string | null

A plain message that describes the warning and helps understand what should be reviewed.

warning_code
string | null

A short, predefined code that uniquely identifies the warning type.

information
Array of object (BaseInformation) | null

Contains additional non-critical information relevant to the request or response. This field provides extra details that might assist in understanding the context of the API response but is not essential for processing.

object
extension_data
object | null

Extension data for customer Api response information

description
string | null

A plain message offering helpful context about the response, such as confirmation of fallback logic or skipped operations.