Product Docs
  • What is Dataworkz?
  • Getting Started
    • What You Will Need
    • Advanced RAG Quickstart
      • Configure LLM's
        • AWS Bedrock
      • Connecting Your Data
        • Finding Your Data Storage: Collections
      • Ingesting Unstructured Data
      • Create Vector Embeddings
        • How to Build the Vector embeddings from Scratch
        • How do Modify Existing Chunking/Embedding Dataflows
      • Response History
    • Embed RAG into your App
    • Data Lake to Salesforce
  • Concepts
    • Datasets
    • No-code Transformations
    • Lineage
      • Features of Lineage:
      • Viewing a dataset's lineage:
    • Discovery
      • How to: Discovery
    • Dataflows
      • Single Dataflows:
      • Composite dataflows:
      • Benefits of Dataflows:
  • Guides
    • Working With Rag Applications
      • High Precision RAG
      • Advanced RAG - Access Control for your data corpus
      • Creating RAG Experiments with Dataworkz
      • Embedding Models
        • Privately Hosted Embedding Models
        • Amazon Bedrock Hosted Embedding Model
        • OpenAI Embedding Model
      • Unstructured Data Ingestion
        • File Ingestion
        • Html/Sharepoint Ingestion
    • 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
    • Working with CSV files
    • 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
    • IP safelist
    • Data Prep
      • Joins
        • Configuring a Join
      • Union
        • Configuring a Union
    • Job Monitoring
    • Authentication
    • User Management
  • API
    • Generate API Key in Dataworkz
  • Open Source License Types
Powered by GitBook
On this page
  1. API

Generate API Key in Dataworkz

PreviousAPINextOpen Source License Types

Last updated 8 months ago

Dataworkz provides an API key to invoke Dataworkz RAG Rest API. To invoke the REST API, pass "Authorization" header with the value as "SSWS ".

Generation API key

  • Login into Dataworkz ('YourInstanceName'.dataworkz.com).

  • On the landing page, click Manage API keys.

  • Enter the Unique API key name (All API keys displayed are of currently logged-in users).

  • Copy the successfully generated API key as it gets generated only once and cannot be regenerated or retrieved.

  • Dataworkz will show all the API keys generated by the user in the past and their status.

  • Users can revoke or disable an API key.

API Key generation section
API Key Status
Generate API Key
API Key successfully generated