Product Docs
  • What is Dataworkz?
  • Getting Started
    • What You Will Need (Prerequisites)
    • Create with Default Settings: RAG Quickstart
    • Custom Settings: RAG Quickstart
    • Data Transformation Quickstart
    • Create an Agent: Quickstart
  • Concepts
    • RAG Applications
      • Overview
      • Ingestion
      • Embedding Models
      • Vectorization
      • Retrieve
    • AI Agents
      • Introduction
      • Overview
      • Tools
        • Implementation
      • Type
      • Tools Repository
      • Tool Execution Framework
      • Agents
      • Scenarios
      • Agent Builder
    • Data Studio
      • No-code Transformations
      • Datasets
      • Dataflows
        • Single Dataflows:
        • Composite dataflows:
        • Benefits of Dataflows:
      • Discovery
        • How to: Discovery
      • Lineage
        • Features of Lineage:
        • Viewing a dataset's lineage:
      • Catalog
      • Monitoring
      • Statistics
  • Guides
    • RAG Applications
      • Configure LLM's
        • AWS Bedrock
      • Embedding Models
        • Privately Hosted Embedding Models
        • Amazon Bedrock Hosted Embedding Model
        • OpenAI Embedding Model
      • Connecting Your Data
        • Finding Your Data Storage: Collections
      • Unstructured Data Ingestion
        • Ingesting Unstructured Data
        • Unstructured File Ingestion
        • Html/Sharepoint Ingestion
      • Create Vector Embeddings
        • How to Build the Vector embeddings from Scratch
        • How do Modify Existing Chunking/Embedding Dataflows
      • Response History
      • Creating RAG Experiments with Dataworkz
      • Advanced RAG - Access Control for your data corpus
    • AI Agents
      • Concepts
      • Tools
        • Dataset
        • AI App
        • Rest API
        • LLM Tool
        • Relational DB
        • MongoDB
        • Snowflake
      • Agent Builder
      • Agents
      • Guidelines
    • Data Studio
      • Transformation Functions
        • Column Transformations
          • String Operations
            • Format Operations
            • String Calculation Operations
            • Remove Stop Words Operation
            • Fuzzy Match Operation
            • Masking Operations
            • 1-way Hash Operation
            • Copy Operation
            • Unnest Operation
            • Convert Operation
            • Vlookup Operation
          • Numeric Operations
            • Tiles Operation
            • Numeric Calculation Operations
            • Custom Calculation Operation
            • Numeric Encode Operation
            • Mask Operation
            • 1-way Hash Operation
            • Copy Operation
            • Convert Operation
            • VLookup Operation
          • Boolean Operations
            • Mask Operation
            • 1-way Hash Operation
            • Copy Operation
          • Date Operations
            • Date Format Operations
            • Date Calculation Operations
            • Mask Operation
            • 1-way Hash Operation
            • Copy Operation
            • Encode Operation
            • Convert Operation
          • Datetime/Timestamp Operations
            • Datetime Format Operations
            • Datetime Calculation Operations
            • Mask Operation
            • 1-way Hash Operation
            • Copy Operation
            • Encode Operation
            • Page 1
        • Dataset Transformations
          • Utility Functions
            • Area Under the Curve
            • Page Rank Utility Function
            • Transpose Utility Function
            • Semantic Search Template Utility Function
            • New Header Utility Function
            • Transform to JSON Utility Function
            • Text Utility Function
            • UI Utility Function
          • Window Functions
          • Case Statement
            • Editor Query
            • UI Query
          • Filter
            • Editor Query
            • UI Query
      • Data Prep
        • Joins
          • Configuring a Join
        • Union
          • Configuring a Union
      • Working with CSV files
      • Job Monitoring
    • Utility Features
      • IP safelist
      • Connect to data source(s)
        • Cloud Data Platforms
          • AWS S3
          • BigQuery
          • Google Cloud Storage
          • Azure
          • Snowflake
          • Redshift
          • Databricks
        • Databases
          • MySQL
          • Microsoft SQL Server
          • Oracle
          • MariaDB
          • Postgres
          • DB2
          • MongoDB
          • Couchbase
          • Aerospike
          • Pinecone
        • SaaS Applications
          • Google Ads
          • Google Analytics
          • Marketo
          • Zoom
          • JIRA
          • Salesforce
          • Zendesk
          • Hubspot
          • Outreach
          • Fullstory
          • Pendo
          • Box
          • Google Sheets
          • Slack
          • OneDrive / Sharepoint
          • ServiceNow
          • Stripe
      • Authentication
      • User Management
    • How To
      • Data Lake to Salesforce
      • Embed RAG into your App
  • API
    • Generate API Key in Dataworkz
    • RAG Apps API
    • Agents API
  • Open Source License Types
Powered by GitBook
On this page
  • When to Use:
  • Pre-requisite:
  • Set up:
  • Testing
  1. Guides
  2. AI Agents
  3. Tools

Rest API

PreviousAI AppNextLLM Tool

Last updated 1 month ago

The REST API Tool enables the Dataworkz Agent to access any system that has a REST API. These could be internal or external systems - with or without authentication. The REST API Tool provides a generic interface to configure an HTTPS REST call.

When to Use:

Many systems such as SaaS applications, and other internal microservices provide access to their functionality via REST API. These systems and API can be made available to the Agent by creating REST API Tools.

Pre-requisite:

Details of the REST API you want to invoke - any authentication requirements (api-keys, tokens, etc), the http method to use, any headers to pass, request payload, query parameters, etc.

Set up:

To create a REST API Tool, select Create Tool from the Tools Repository and pick Rest API from the options provided.

You will get the REST API Tool Editor -

As with all tools provide a meaningful name and description that will help the agent understand the purpose of this tool so that the agent can use it correctly.

Configuration

In the configuration section, you provide the details to connect to the REST API you want to expose as a tool. Most of the parts of the configuration can be parameterized. To parameterize them you can use the form ${parameter-name} e.g. ${customerId}.

URL: You need to specify the url of the REST API - including any parameters. e.g. https://acme.com/api/v1/system/${systemId}/products

Method: Pick the HTTP Method

Body: Provide a template to use as the body if required. Parameters can be used in the body template

Header: Specify headers - Hit enter after each header: value combination. E.g. Content-type: application/json. Parameters can be used.

JSON Path: If the result needs to be extracted from a part of a JSON response then a JSON Path can be specified here. Currently it does not support parameterization.

Parameters

Any parameters included in the URL, Body, Headers, etc will be shown as Parameters. Parameters can be input parameters - which means they have to provided during invocation or they can be configuration and provided in this screen. Configuration parameters can be used for things like api-tokens or versions for better management.

Output

The output of the REST API Call should be described here.

Testing

As with all tools, the tool can be tested by providing values for the input parameters. The json path is applied and the result is available in the key "result"

Pick Rest API from the options