Article Ingestion API Documentation

Introduction

You can send knowledge base articles for AI training to us via our APIs.

API Guide

Below is a curl command to call our API:

curl -X POST --location "https://api1.irisagent.com/v1/feedback" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Replace_me_business_id" \
    -d '{
            "articles": [
                {
                    "url": "https://example.com/article1",
                    "title": "How to use IrisAgent",
                    "body": "This is a sample article on how to use IrisAgent",
                    "timeOfCreation": "2024-07-16T13:56:42.575Z",
                    "timeLastPublished": "2024-07-16T13:56:42.575Z"
                 },
                 {
                     "url": "https://example.com/article2",
                     "title": "How to use IrisGPT",
                     "body": "This is a sample article on how to use IrisGPT",
                     "timeOfCreation": "2024-08-16T13:56:42.575Z",
                     "timeLastPublished": "2024-08-16T13:56:42.575Z"
                 }
            ]
        }'
          

The API inputs are as follows,

Field	Description
url	[Required] Unique URL of the article
title	[Required] Title of the article
body	[Required] The full body of the article either in markdown or HTML format
timeOfCreation	[Required] UTC timestamp of when the article was created, e.g. 2024-07-16T13:56:42.575Z
timeLastPublished	[Required] UTC timestamp of when the article was last modified, e.g. 2024-07-16T13:56:42.575Z
Replace_me_business_id	[Required] This is the ID provided by the IrisAgent team

A sample output of the API:

{
  "result": "success"
}