Sample requests:
POST /Export - Export all the versions in the documentation { "entity": "Project", // Project / version "versionId": [], // should be empty array "SelectedLanguages":[], "SelectedCategories":[], "FilterByArticleModifiedAt": { // filter articles by modified at date range "after": "2021-05-17T03:42:52.109Z", "before": "2021-05-17T03:42:52.109Z" }, "excludeMediaFiles": true // exculde media files on export }
POST /Export - Export specific versions in the documentation { "entity": "Version", // Project / version "versionId": ["695782c0-a0a3-4664-9bfd-0197d26379ee"], "SelectedLanguages":[], "SelectedCategories":[], "FilterByArticleModifiedAt": { // filter articles by modified at date range "after": "2021-05-17T03:42:52.109Z", "before": "2021-05-17T03:42:52.109Z" }, "excludeMediaFiles": true // exculde media files on export }
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.
Filter to export Full/Part of the documenation
To export the complete project set Entity as Project. versionId should be an empty array in this case.
{
"entity": "Project",
"version_id": [],
"selected_languages": null,
"selected_categories": null,
"exclude_media_files": true,
"filter_by_article_modified_at": null,
"export_type": 0
}To export one or more project versions set entity as Version. In VersionId pass an array of project version ids. To get the project version ids you can call /projectversions. Also modify the version according to the existing user, the example here shown is random versionId.
{
"entity": "Version",
"version_id": [
"6558-7607-4594-ac82-e9b56aa8ab4",
"de558-7607-4594-ac82-e9b5bdfve34"
],
"selected_languages": null,
"selected_categories": null,
"exclude_media_files": true,
"filter_by_article_modified_at": null,
"export_type": 0
}To export one or more Category, In SelectedCategory field, add categoryId (Id), LanguageId and VersionId. Set entity as Version and add versionIds to versionId field.
{
"entity": "Version",
"version_id": [
"",
""
],
"selected_languages": null,
"selected_categories": [
{
"language_id": "",
"id": "",
"version_id": ""
},
{
"language_id": "",
"id": "",
"version_id": ""
}
],
"exclude_media_files": true,
"filter_by_article_modified_at": {
"after": "2024-06-13T14:30:00Z",
"before": "2024-06-13T14:30:00Z"
},
"export_type": 0
}To export one or more Language set entity as Version. In SelectedLanguages pass LanguageId (Id), Code , versionId.
{
"entity": "Version",
"version_id": [
"",
""
],
"selected_languages": [
{
"code": "",
"id": "",
"version_id": ""
},
{
"code": "",
"id": "",
"version_id": ""
}
],
"selected_categories": null,
"exclude_media_files": true,
"filter_by_article_modified_at": {
"after": "2024-06-13T14:30:00Z",
"before": "2024-06-13T14:30:00Z"
},
"export_type": 0
}Filter the articles which are all modified after the given date
Filter the articles which are all modified before the given date
To export the complete project set Entity as Project. versionId should be an empty array in this case.
{
"entity": "Project",
"version_id": [],
"selected_languages": null,
"selected_categories": null,
"exclude_media_files": true,
"filter_by_article_modified_at": null,
"export_type": 0
}To export one or more project versions set entity as Version. In VersionId pass an array of project version ids. To get the project version ids you can call /projectversions. Also modify the version according to the existing user, the example here shown is random versionId.
{
"entity": "Version",
"version_id": [
"6558-7607-4594-ac82-e9b56aa8ab4",
"de558-7607-4594-ac82-e9b5bdfve34"
],
"selected_languages": null,
"selected_categories": null,
"exclude_media_files": true,
"filter_by_article_modified_at": null,
"export_type": 0
}To export one or more Category, In SelectedCategory field, add categoryId (Id), LanguageId and VersionId. Set entity as Version and add versionIds to versionId field.
{
"entity": "Version",
"version_id": [
"",
""
],
"selected_languages": null,
"selected_categories": [
{
"language_id": "",
"id": "",
"version_id": ""
},
{
"language_id": "",
"id": "",
"version_id": ""
}
],
"exclude_media_files": true,
"filter_by_article_modified_at": {
"after": "2024-06-13T14:30:00Z",
"before": "2024-06-13T14:30:00Z"
},
"export_type": 0
}To export one or more Language set entity as Version. In SelectedLanguages pass LanguageId (Id), Code , versionId.
{
"entity": "Version",
"version_id": [
"",
""
],
"selected_languages": [
{
"code": "",
"id": "",
"version_id": ""
},
{
"code": "",
"id": "",
"version_id": ""
}
],
"selected_categories": null,
"exclude_media_files": true,
"filter_by_article_modified_at": {
"after": "2024-06-13T14:30:00Z",
"before": "2024-06-13T14:30:00Z"
},
"export_type": 0
}Filter the articles which are all modified after the given date
Filter the articles which are all modified before the given date
To export the complete project set Entity as Project. versionId should be an empty array in this case.
{
"entity": "Project",
"version_id": [],
"selected_languages": null,
"selected_categories": null,
"exclude_media_files": true,
"filter_by_article_modified_at": null,
"export_type": 0
}To export one or more project versions set entity as Version. In VersionId pass an array of project version ids. To get the project version ids you can call /projectversions. Also modify the version according to the existing user, the example here shown is random versionId.
{
"entity": "Version",
"version_id": [
"6558-7607-4594-ac82-e9b56aa8ab4",
"de558-7607-4594-ac82-e9b5bdfve34"
],
"selected_languages": null,
"selected_categories": null,
"exclude_media_files": true,
"filter_by_article_modified_at": null,
"export_type": 0
}To export one or more Category, In SelectedCategory field, add categoryId (Id), LanguageId and VersionId. Set entity as Version and add versionIds to versionId field.
{
"entity": "Version",
"version_id": [
"",
""
],
"selected_languages": null,
"selected_categories": [
{
"language_id": "",
"id": "",
"version_id": ""
},
{
"language_id": "",
"id": "",
"version_id": ""
}
],
"exclude_media_files": true,
"filter_by_article_modified_at": {
"after": "2024-06-13T14:30:00Z",
"before": "2024-06-13T14:30:00Z"
},
"export_type": 0
}To export one or more Language set entity as Version. In SelectedLanguages pass LanguageId (Id), Code , versionId.
{
"entity": "Version",
"version_id": [
"",
""
],
"selected_languages": [
{
"code": "",
"id": "",
"version_id": ""
},
{
"code": "",
"id": "",
"version_id": ""
}
],
"selected_categories": null,
"exclude_media_files": true,
"filter_by_article_modified_at": {
"after": "2024-06-13T14:30:00Z",
"before": "2024-06-13T14:30:00Z"
},
"export_type": 0
}Filter the articles which are all modified after the given date
Filter the articles which are all modified before the given date
To export the complete project set Entity as Project. versionId should be an empty array in this case.
{
"entity": "Project",
"version_id": [],
"selected_languages": null,
"selected_categories": null,
"exclude_media_files": true,
"filter_by_article_modified_at": null,
"export_type": 0
}To export one or more project versions set entity as Version. In VersionId pass an array of project version ids. To get the project version ids you can call /projectversions. Also modify the version according to the existing user, the example here shown is random versionId.
{
"entity": "Version",
"version_id": [
"6558-7607-4594-ac82-e9b56aa8ab4",
"de558-7607-4594-ac82-e9b5bdfve34"
],
"selected_languages": null,
"selected_categories": null,
"exclude_media_files": true,
"filter_by_article_modified_at": null,
"export_type": 0
}To export one or more Category, In SelectedCategory field, add categoryId (Id), LanguageId and VersionId. Set entity as Version and add versionIds to versionId field.
{
"entity": "Version",
"version_id": [
"",
""
],
"selected_languages": null,
"selected_categories": [
{
"language_id": "",
"id": "",
"version_id": ""
},
{
"language_id": "",
"id": "",
"version_id": ""
}
],
"exclude_media_files": true,
"filter_by_article_modified_at": {
"after": "2024-06-13T14:30:00Z",
"before": "2024-06-13T14:30:00Z"
},
"export_type": 0
}To export one or more Language set entity as Version. In SelectedLanguages pass LanguageId (Id), Code , versionId.
{
"entity": "Version",
"version_id": [
"",
""
],
"selected_languages": [
{
"code": "",
"id": "",
"version_id": ""
},
{
"code": "",
"id": "",
"version_id": ""
}
],
"selected_categories": null,
"exclude_media_files": true,
"filter_by_article_modified_at": {
"after": "2024-06-13T14:30:00Z",
"before": "2024-06-13T14:30:00Z"
},
"export_type": 0
}Filter the articles which are all modified after the given date
Filter the articles which are all modified before the given date
Status of the export
The below example shows the status response for export documentation. Here the export for a new documentation will be triggered.
{
"id": "69c2a0ee-bbac-4563-921c-08efef575b64",
"status": "Initiated",
"extension_data": null,
"success": true,
"errors": [],
"warnings": [],
"information": []
}The ID of the export request. Use this ID to get export details
Current status of the export
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.
Bad Request
The below example shows the error status response says invalid language code.
{
"extension_data": null,
"success": false,
"errors": [
{
"extension_data": null,
"stack_trace": null,
"description": "The LanguageCode field is required",
"error_code": "400",
"custom_data": null
}
],
"warnings": [],
"information": []
}The below example shows the error status that you had reached the limit for the day.
{
"extension_data": null,
"success": false,
"errors": [
{
"extension_data": null,
"stack_trace": null,
"description": "Export API request limit(2) is reached for the day.",
"error_code": "400",
"custom_data": null
}
],
"warnings": [],
"information": []
}The below example shows the error status that the entity field should not be empty or invalid. Entity options are - 1.Project 2.Version , 3.Category , 4.Article
{
"extension_data": null,
"success": false,
"errors": [
{
"extension_data": null,
"stack_trace": null,
"description": "The Entity field is required.",
"error_code": "400",
"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.