Agents API

Dataworkz Agents API

Dataworkz Agents are powerful systems that bring together data from multiple systems via tools and leveraging a declarative mechanism to build Agents, can be used as a powerful Agentic RAG system. The API allows you to integrate Agents into any system.

Note: All API calls require an API Token. Please follow these steps to generate an API Key. The API Key has to be provided in the Authorizationheader in the format SSWS <your api key>

Concepts

Dataworkz Agents provide a stateless API that consumes the conversation history so far and responds to the user's question/text appropriately. Agents need to be built and saved in Dataworkz using the AgentBuilder. You can get the agentId from the Agent card in the product UI.

API

Get a list of all agents in this account

get

Get a list of all agents in this account - id, name, description

Authorizations

Header parameters

AuthorizationanyOptional

For Dataworkz API Token use the format 'SSWS ' and for OAuth2 generated JWT token use 'Bearer '

Responses

200

successful operation

application/json

Responsestring

get

HTTPcURLJavaScriptPython

GET /api/qna/v1/agents HTTP/1.1
Host: ragapps.dataworkz.com
Authorization: YOUR_API_KEY
Accept: */*

200

successful operation

[
  {
    "createdByName": "[e-mail]",
    "agentId": "47e8366d-5db8-45ae-8457-9259a46bbdad",
    "createdDate": "2025-02-17 04:45:32.593",
    "name": "Customer Support Agent",
    "description": "The agent acts as a customer support representative for users to ask questions and get help.",
    "scenariosCount": "5"
  }
]

Get the agent's response to user text

post

For the given agent specified by the agentId, get the agent's response for the user's text and the conversation history

Authorizations

Path parameters

agentIdstringRequired

Id of the Agent in the system

Example: 3756809c-4032-4e48-b3f0-2a6d30a03a54

Query parameters

userTextstringRequired

The last text from the user. Must be url encoded.

Example: What is the status of the order?

llmProviderIdstringRequired

Id of the LLM to use for the agent. This must be one of the LLMs configured in this account. Currently, gpt-4 and llama3-70B models are supported. Id can be copied from the LLM Configuration page.

Example: 3756809c-4032-4e48-b3f0-2a6d30a03a54

propertiesstringOptional

Any additional properties to be passed to influence execution

Header parameters

AuthorizationanyOptional

For Dataworkz API Token use the format 'SSWS ' and for OAuth2 generated JWT token use 'Bearer '

Body

objectOptional

Responses

200

successful operation

application/json

Responseobject

post

HTTPcURLJavaScriptPython

POST /api/qna/v1/agents/{agentId}/response HTTP/1.1
Host: ragapps.dataworkz.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 231

{
  "conversationHistory": [
    {
      "by": "USER",
      "text": "Hi"
    },
    {
      "by": "AI",
      "text": "Hi! How can I assist you today?"
    },
    {
      "by": "USER",
      "text": "I would like status for order 33"
    },
    {
      "by": "AI",
      "text": "Order 33 is delayed. Would you like more details?"
    }
  ]
}

200

successful operation

{
    "status": "OK",
    "data": {
        "systemId": "5ccea050-aff5-4e37-8572-d2e486987843",
        "question": "Hi",
        "systemName": "TestAgent",
        "answer": "Hello! How can I assist you today?",
        "scenario": "Greet",
        "type": "agent",
        "questionUuid": "e9e6d058-79ff-4165-a409-d0e9a38b4802",
        "status": "COMPLETED",
    }
}