agent_interaction

Chat

Chat with an agent. Accepts AgentInteraction Schema as input. Chat is created allways in contend of the past interactions. A complete chat history is returned orderd by order Chat Messages can have one of 4 types : USER, ASSISTANT, FUNCTION or SYSTEM. The Function type has allayws a empty message. And can be read by using the history endpoint or reading the steps of the response.

post/agent/{agent_id}/chat

Request

  • Base URL: https://api.overfit.de (the document declares no server; this is the origin it was published from)
  • URL: https://api.overfit.de/agent/{agent_id}/chat
  • Auth: one of:
    • OpenID Connect (https://auth.okns.de/realms/overfit-products/.well-known/openid-configuration)
    • API key in header X-API-Key

Path parameters

agent_idstring required

Request body

Example request

{
  "interaction_data": {
    "interaction_type": "CHAT",
    "message": "Tell me more about the history of the screwdriver."
  }
}

Response

Successful Response

idstring required
time_createdstring date-time required
namestring required
descriptionstring nullable
publicboolean
agent_type'DEFAULT' | 'PLAN' | 'PRIMED' required
generative_modelstring
temperaturenumber
substring uuid required
responsestring required

Example response

{
  "agent_type": "DEFAULT",
  "description": "This agent specializes in screwdrivers.",
  "generative_model": "gpt-3.5-turbo",
  "id": "agt_1EbVewEDVUf0oyAxzsi6LW",
  "name": "Screwdriver Agent",
  "public": false,
  "sub": "ecd8dfc1-1d93-42be-b77c-0d4331886e6c",
  "temperature": 0.7,
  "time_created": "2023-01-01T00:00:00",
  "tools": []
}

Changes

No recorded changes to this operation across all 1 revision of this API.