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.
Success
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:
- Access the Azure AD portal and log in to your Microsoft Azure account.
- Add your application by logging in to your Azure account, visiting the Azure portal page, and selecting the New application option.
- 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.
- Configure SAML based SSO settings by copying and pasting values between Document360 and Azure AD portal.
- 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
}This is the Extension data object
A technical trace showing where the error occurred within the system. Intended for backend debugging.
A clear message explaining what caused the error. This helps quickly understand what went wrong.
A short, predefined code that identifies the type of error. Useful for logging the error or raising a support request.
Any structured metadata for the error object.
Extension Data for customer Api warning
A plain message that describes the warning and helps understand what should be reviewed.
A short, predefined code that uniquely identifies the warning type.
Extension data for customer Api response information
A plain message offering helpful context about the response, such as confirmation of fallback logic or skipped operations.
Bad Request
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": []
}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": []
}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": []
}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": []
}Extension data for customer API response
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.
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.
This is the Extension data object
A technical trace showing where the error occurred within the system. Intended for backend debugging.
A clear message explaining what caused the error. This helps quickly understand what went wrong.
A short, predefined code that identifies the type of error. Useful for logging the error or raising a support request.
Any structured metadata for the error object.
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.
Extension Data for customer Api warning
A plain message that describes the warning and helps understand what should be reviewed.
A short, predefined code that uniquely identifies the warning type.
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.
Extension data for customer Api response information
A plain message offering helpful context about the response, such as confirmation of fallback logic or skipped operations.