Edit

Knowledge Articles

API Reference

Knowledge Ingestion

post

Enables ingestion of new knowledge articles or of updates to existing knowledge articles. The request body depends on the field mappings defined on the data source to which the API will push the data.

Authorizations
Header parameters
x-app-tokenstringOptionalExample: {{Client ID / App Token}}
Bodyobject[]
groupsstring[]OptionalExample: ["Grp1","Grp2"]
idstringOptionalExample: 1
textstringOptionalExample: <!DOCTYPE html><html><head> <meta charset="UTF-8"> <title>Sample</title></head><body> <p>Lorem ipsum dolor, sit amet consectetur adipisicing elit. Quaerat quo corrupti unde aliquam magnam, maxime labore eos omnis possimus autem similique quae, quia nam, molestiae aperiam ratione est ut repellendus?</p> <p>Lorem ipsum dolor, sit amet consectetur adipisicing elit. Quaerat quo corrupti unde aliquam magnam, maxime labore eos omnis possimus autem similique quae, quia nam, molestiae aperiam ratione est ut repellendus?</p> <p>Lorem ipsum dolor, sit amet consectetur adipisicing elit. Quaerat quo corrupti unde aliquam magnam, maxime labore eos omnis possimus autem similique quae, quia nam, molestiae aperiam ratione est ut repellendus?</p> <p>Lorem ipsum dolor, sit amet consectetur adipisicing elit. Quaerat quo corrupti unde aliquam magnam, maxime labore eos omnis possimus autem similique quae, quia nam, molestiae aperiam ratione est ut repellendus?</p> <p>Lorem ipsum dolor, sit amet consectetur adipisicing elit. Quaerat quo corrupti unde aliquam magnam, maxime labore eos omnis possimus autem similique quae, quia nam, molestiae aperiam ratione est ut repellendus?</p> <p>Lorem ipsum dolor, sit amet consectetur adipisicing elit. Quaerat quo corrupti unde aliquam magnam, maxime labore eos omnis possimus autem similique quae, quia nam, molestiae aperiam ratione est ut repellendus?</p> <p>Lorem ipsum dolor, sit amet consectetur adipisicing elit. Quaerat quo corrupti unde aliquam magnam, maxime labore eos omnis possimus autem similique quae, quia nam, molestiae aperiam ratione est ut repellendus?</p> <p>Lorem ipsum dolor, sit amet consectetur adipisicing elit. Quaerat quo corrupti unde aliquam magnam, maxime labore eos omnis possimus autem similique quae, quia nam, molestiae aperiam ratione est ut repellendus?</p> <p>Lorem ipsum dolor, sit amet consectetur adipisicing elit. Quaerat quo corrupti unde aliquam magnam, maxime labore eos omnis possimus autem similique quae, quia nam, molestiae aperiam ratione est ut repellendus?</p> <p>Lorem ipsum dolor, sit amet consectetur adipisicing elit. Quaerat quo corrupti unde aliquam magnam, maxime labore eos omnis possimus autem similique quae, quia nam, molestiae aperiam ratione est ut repellendus?</p> <p>Lorem ipsum dolor, sit amet consectetur adipisicing elit. Quaerat quo corrupti unde aliquam magnam, maxime labore eos omnis possimus autem similique quae, quia nam, molestiae aperiam ratione est ut repellendus?</p> <p>Lorem ipsum dolor, sit amet consectetur adipisicing elit. Quaerat quo corrupti unde aliquam magnam, maxime labore eos omnis possimus autem similique quae, quia nam, molestiae aperiam ratione est ut repellendus?</p></body></html>
Responses
200Success
No content
post
/knowledge-articles
POST /knowledge-articles HTTP/1.1
Host: <Name of your Aisera tenant>.api.aisera.cloud
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 3464

[
  {
    "groups": [
      "Grp1",
      "Grp2"
    ],
    "id": "1",
    "text": "<!DOCTYPE html><html><head>    <meta charset=\"UTF-8\">    <title>Sample</title></head><body>    <p>Lorem ipsum dolor, sit amet consectetur adipisicing elit. Quaerat quo corrupti unde aliquam magnam, maxime labore        eos omnis possimus autem similique quae, quia nam, molestiae aperiam ratione est ut repellendus?</p>    <p>Lorem ipsum dolor, sit amet consectetur adipisicing elit. Quaerat quo corrupti unde aliquam magnam, maxime labore        eos omnis possimus autem similique quae, quia nam, molestiae aperiam ratione est ut repellendus?</p>    <p>Lorem ipsum dolor, sit amet consectetur adipisicing elit. Quaerat quo corrupti unde aliquam magnam, maxime labore        eos omnis possimus autem similique quae, quia nam, molestiae aperiam ratione est ut repellendus?</p>    <p>Lorem ipsum dolor, sit amet consectetur adipisicing elit. Quaerat quo corrupti unde aliquam magnam, maxime labore        eos omnis possimus autem similique quae, quia nam, molestiae aperiam ratione est ut repellendus?</p>    <p>Lorem ipsum dolor, sit amet consectetur adipisicing elit. Quaerat quo corrupti unde aliquam magnam, maxime labore        eos omnis possimus autem similique quae, quia nam, molestiae aperiam ratione est ut repellendus?</p>    <p>Lorem ipsum dolor, sit amet consectetur adipisicing elit. Quaerat quo corrupti unde aliquam magnam, maxime labore        eos omnis possimus autem similique quae, quia nam, molestiae aperiam ratione est ut repellendus?</p>    <p>Lorem ipsum dolor, sit amet consectetur adipisicing elit. Quaerat quo corrupti unde aliquam magnam, maxime labore        eos omnis possimus autem similique quae, quia nam, molestiae aperiam ratione est ut repellendus?</p>    <p>Lorem ipsum dolor, sit amet consectetur adipisicing elit. Quaerat quo corrupti unde aliquam magnam, maxime labore        eos omnis possimus autem similique quae, quia nam, molestiae aperiam ratione est ut repellendus?</p>    <p>Lorem ipsum dolor, sit amet consectetur adipisicing elit. Quaerat quo corrupti unde aliquam magnam, maxime labore        eos omnis possimus autem similique quae, quia nam, molestiae aperiam ratione est ut repellendus?</p>    <p>Lorem ipsum dolor, sit amet consectetur adipisicing elit. Quaerat quo corrupti unde aliquam magnam, maxime labore        eos omnis possimus autem similique quae, quia nam, molestiae aperiam ratione est ut repellendus?</p>    <p>Lorem ipsum dolor, sit amet consectetur adipisicing elit. Quaerat quo corrupti unde aliquam magnam, maxime labore        eos omnis possimus autem similique quae, quia nam, molestiae aperiam ratione est ut repellendus?</p>    <p>Lorem ipsum dolor, sit amet consectetur adipisicing elit. Quaerat quo corrupti unde aliquam magnam, maxime labore        eos omnis possimus autem similique quae, quia nam, molestiae aperiam ratione est ut repellendus?</p></body></html>"
  },
  {
    "groups": [
      "Grp1",
      "Grp4"
    ],
    "id": "2",
    "text": "<HTML><HEAD><TITLE>Your Title Here</TITLE></HEAD><BODY BGCOLOR=\"FFFFFF\"><CENTER><IMG SRC=\"clouds.jpg\" ALIGN=\"BOTTOM\"> </CENTER><HR><a href=\"http://somegreatsite.com\">Link Name</a>is a link to another nifty site<H1>This is a Header</H1><H2>This is a Medium Header</H2>Send me mail at <a href=\"mailto:[email protected]\">[email protected]</a>.<P> This is a new paragraph!<P> <B>This is a new paragraph!</B><BR> <B><I>This is a new sentence without a paragraph break, in bold italics.</I></B><HR></BODY></HTML>"
  }
]
200Success
No content

Knowledge Deletion

delete

Enables batch deletion of knowledge articles previously ingested into Aisera.

Authorizations
Header parameters
x-app-tokenstringOptionalExample: {{Client ID / App Token}}
Bodyobject[]
idstringOptionalExample: 949896746
Responses
200Success
No content
delete
/knowledge-articles
DELETE /knowledge-articles HTTP/1.1
Host: <Name of your Aisera tenant>.api.aisera.cloud
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 61

[
  {
    "id": "949896746"
  },
  {
    "id": "21024079790"
  },
  {
    "id": "2102407979"
  }
]
200Success
No content

FAQs

  1. Can ingested knowledge articles be updated? Yes, the same API can be used to both create and update existing knowledge articles. Include the key-value pairs for the fields that need to be updated. Additionally, all the mandatory fields must be included.

  2. Can ingested knowledge articles be deleted? Yes, the knowledge articles can be deleted using the delete APIs. Additionally, the knowledge articles can be excluded from being used by the platform, without deleting them, by retiring in bulk from the data source details page.

  3. Is there a required format for the knowledge articles? Yes, the knowledge article payload must be stringified HTML.

  4. Are there any restrictions or limitations? Yes. The restrictions on the ingestion APIs are available here.

PreviousConversationsNextIncidents

Last updated

Was this helpful?