Skip to main content
Unlisted page
This page is unlisted. Search engines will not index it, and only users having a direct link can access it.
Version: 2025-08-07

Rag Request

header Parameters
required
orgid (string) or orgid (null) (orgid)

orgid

required
authkey (string) or authkey (null) (authkey)

authkey

simple (boolean) or simple (null) (simple)
Default: false

Boolean whether the topics RikAI2 should be skipped (true) or not (false | None)

Request Body schema: application/json
required
required
Question (string) or Array of Question (strings) (Question)

The question for the model to answer.

required
object (Settings)
required
object (VKGInput)
Base64 (string) or Array of Base64 (strings) or Base64 (null) (Base64)

The base64 encoding of a file to be used in the API request. (Base64 or InputURL are required)

Inputurl (string) or Array of Inputurl (strings) or Inputurl (null) (Inputurl)

The url of a file to be used in the API request. (Base64 or InputURL are required)

Searchprompt (string) or Searchprompt (null) (Searchprompt)

The prompt to RikAI2 that should create a comma separated list of topics to be used to search the VKG specified in vkg.vkgId

Numclosest (integer) or Numclosest (null) (Numclosest)
Default: 5

The number of nodes to be included for every topics search in the VKG specified in vkg.vkgId

Numtopics (integer) or Numtopics (null) (Numtopics)
Default: 20

The maximum number of topics for searching in the VKG specified in vkg.vkgId

Webhook (string) or Webhook (null) (Webhook)

Responses

Request samples

Content type
application/json
{
  • "base64": "string",
  • "inputUrl": "string",
  • "question": "string",
  • "settings": {
    },
  • "vkg": {
    },
  • "searchPrompt": "string",
  • "numClosest": 5,
  • "numTopics": 20,
  • "webhook": "string"
}

Response samples

Content type
application/json
{
  • "apiVersion": "string",
  • "baseModel": "string",
  • "code": 0,
  • "data": [
    ],
  • "documentId": "string",
  • "endTime": 0,
  • "id": "string",
  • "metadata": { },
  • "model": "string",
  • "organization": "string",
  • "pages": 0,
  • "provider": "string",
  • "questions": 0,
  • "settings": { },
  • "startTime": 0,
  • "status": "string",
  • "statusId": "string",
  • "topics": [
    ],
  • "nodes": [
    ],
  • "searchPrompt": "string",
  • "requestPrompt": "string"
}