SDK QuickStart

This short guide shows you how to set up the SDK, run a basic query, and get your first useful results.

For a step-by-step walkthrough that uses real example data to solve a practical scenario, see the QuickStart API/SDK Guide.

1. Install

Install the DataLinks SDK if you haven’t already.

2. Configure

Ensure the required environment variables are set:

Variable	Required	Description
`DL_HOST`	Yes	Base URL of the DataLinks API (e.g. `https://api.datalinks.com`)
`DL_API_KEY`	Yes	Your DataLinks API key (JWT token)
`DL_NAMESPACE`	Yes	Target namespace for ingest and query operations
`OBJECT_NAME`	No	Object name scoping for ingest/query URLs; defaults to empty

If you use the Ingest Proxy (IngestProxyAPI) for auto-modelled pipelines, set these instead:

Variable	Required	Description
`DL_INGEST_PROXY`	Yes	Base URL of the ingest proxy (e.g. `https://your-proxy.vercel.app`)
`DL_API_KEY`	Yes	Your DataLinks API key (shared with the main API)
`DL_USERNAME`	Yes	Your DataLinks username
`DL_NAMESPACE`	Yes	Target namespace

Alternatively, you can use a .env file in the root of your project.

3. Ingest and query

from datalinks.api import DataLinksAPI, DLConfig

# Initialize configuration
config = DLConfig.from_env()

# Instantiate API client
client = DataLinksAPI(config=config)

# Sample rows
rows = [
    {"brand": "Gilette", "category": "Razor", "product": "Heated Razor"},
    {"brand": "Oral-B",  "category": "Electric Toothbrush", "product": "iO Series 10"},
]

# Ingest pre-structured rows directly (no pipeline required)
result = client.ingest(data=rows)

# Query data
data = client.query_data(include_metadata=False)
print(data)

CLI Usage

The SDK also provides a built-in CLI that can be extended:

datalinks-client [-h] --verbose <input-folder>

Getting Started

Library

1. Install

2. Configure

3. Ingest and query

CLI Usage

​1. Install

​2. Configure

​3. Ingest and query

​CLI Usage

1. Install

2. Configure

3. Ingest and query

CLI Usage