Agents

Create an agent and define, model and its parameters.

Retrieve agents authored by the user.

GEThttps://www.openindex.ai/api/agents

Response

200

A list of agents

Body

application/json

okboolean

agentsarray of Agent (object)

Request

JavaScriptCurl

const response = await fetch('https://www.openindex.ai/api/agents', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "ok": false,
  "agents": [
    {
      "id": "text",
      "slug": "text",
      "name": "text",
      "description": "text",
      "image": "text",
      "privacy": "text",
      "namespace": "text",
      "prompt": "text",
      "isAutonomous": false,
      "welcome": "text",
      "model": "gpt-3.5-turbo",
      "params": {
        "temperature": 0,
        "topP": 0,
        "frequencePenalty": 0,
        "presencePenalty": 0
      },
      "tools": [
        {
          "id": "text",
          "checked": false
        }
      ],
      "userId": "text",
      "status": "text",
      "collections": [
        "text"
      ]
    }
  ]
}

Create or update an agent

POSThttps://www.openindex.ai/api/agents

Body

application/json

idstring

namestring

descriptionstring

imagestring

privacyPrivacy (enum)

publicprivateteam

isAutonomousboolean

promptstring

welcomestring

modelModelName (enum)

Name of the LLM model to use.

gpt-3.5-turbogpt-3.5-turbo-16kgpt-4palm-2llama-2-13b-chatllama-2-70b-chatcodellama-13b-instructcodellama-13b-pythonmistral-7bllava-13bfuyu-8b

paramsModelParameters (object)

Model parameters

toolsarray of Tool (object)

collectionsarray of string

Response

200400403500

The result of the agent creation or update.

Body

application/json

okboolean

agentIdstring

Request

JavaScriptCurl

const response = await fetch('https://www.openindex.ai/api/agents', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "ok": false,
  "agentId": "text"
}

Please see the list of supported models for the model parameter above.