API

Dataworkz API Documentation for RAG Apps and Agents.

Dataworkz provides 2 API groups

  • RAG Apps API - Use the Dataworkz API to perform Q&A, semantic search and chat with RAG Applications

  • Agents - Use the Dataworkz API to invoke Agents

To generate an API key for interacting with these APIs, please follow the steps outlined in the "API key generation" section.

Concepts

LLMProviderId

This is the identifier of the LLM Configuration provided inside Dataworkz. Dataworkz allows multiple LLMs to be configured and used for appropriate use-cases.

API Key

All API calls require an API Key. Please follow these steps to generate an API Key.

Multiple API Keys can be created to facilitate organization and for rotating them. API Keys can be managed within the Dataworkz product.

The API Key has to be provided in the Authorizationheader in the format SSWS <your api key>

Last updated