Incode Python API Docs | dltHub

REST APIs use HTTP methods for CRUD operations; they are stateless and rely on client-server communication; Incode's documentation provides specifics for their SDK usage. The REST API base URL is https://api-incode-id.incodesmile.com and All server REST requests require an API key (x-api-key) and a short‑lived JWT access token; some Omni endpoints also require X‑Incode‑Hardware‑Id header..

dlt is an open-source Python library that handles authentication, pagination, and schema evolution automatically. dlthub provides AI context files that enable code assistants to generate production-ready pipelines. Install with uv pip install "dlt[workspace]" and start loading Incode data in under 10 minutes.

---

What data can I load from Incode?

Here are some of the endpoints you can load from Incode:

---

How do I authenticate with the Incode API?

Obtain a server token by calling POST /v1/integration/authorize/server with x‑api‑key, integrationId and secret; use the returned token as a Bearer token (Authorization: Bearer ) together with the x‑api‑key header. Some Omni endpoints also require X‑Incode‑Hardware‑Id.

1. Get your credentials

1. Sign in to your Incode Developer/Workforce dashboard or request access from Incode support.
2. Create/register an integration and copy the provided API Key, Integration ID and Secret.
3. Call POST https://{server-url}/v1/integration/authorize/server with headers: x-api-key and Content-Type: application/json and body: {"integrationId":"<integration_id>","secret":""} to receive {"token":"..."}.
4. Use the returned token (valid ~15 minutes) as Authorization: Bearer together with x-api-key on subsequent API calls. Include X-Incode-Hardware-Id for endpoints that require it.

2. Add them to .dlt/secrets.toml

Copy
[sources.incode_source]
api_key = "your_x_api_key_here"
server_token = "your_short_lived_server_token_here"

dlt reads this automatically at runtime — never hardcode tokens in your pipeline script. For production environments, see setting up credentials with dlt for environment variable and vault-based options.

---

How do I set up and run the pipeline?

Set up a virtual environment and install dlt:

Copy
uv venv && source .venv/bin/activate
uv pip install "dlt[workspace]"

1. Install the dlt AI Workbench:

Copy
dlt ai init --agent <your-agent> # <agent>: claude | cursor | codex

This installs project rules, a secrets management skill, appropriate ignore files, and configures the dlt MCP server for your agent. Learn more →

2. Install the rest-api-pipeline toolkit:

Copy
dlt ai toolkit rest-api-pipeline install

This loads the skills and context about dlt the agent uses to build the pipeline iteratively, efficiently, and safely. The agent uses MCP tools to inspect credentials — it never needs to read your secrets.toml directly. Learn more →

3. Start LLM-assisted coding:

Use /find-source to load data from the Incode API into DuckDB.

The rest-api-pipeline toolkit takes over from here — it reads relevant API documentation, presents you with options for which endpoints to load, and follows a structured workflow to scaffold, debug, and validate the pipeline step by step.

4. Run the pipeline:

Copy
python incode_pipeline.py

If everything is configured correctly, you'll see output like this:

Copy
Pipeline incode_pipeline load step completed in 0.26 seconds
1 load package(s) were loaded to destination duckdb and into dataset incode_data
The duckdb destination used duckdb:/incode.duckdb location to store data
Load package 1749667187.541553 is LOADED and contains no failed jobs

Inspect your pipeline and data:

Copy
dlt pipeline incode_pipeline show

This opens the Pipeline Dashboard where you can verify pipeline state, load metrics, schema (tables, columns, types), and query the loaded data directly.

---

Python pipeline example

This example loads authorize_server and userinfo from the Incode API into DuckDB. It mirrors the endpoint and data selector configuration from the table above:

Copy
import dlt
from dlt.sources.rest_api import RESTAPIConfig, rest_api_resources

@dlt.source
def incode_source(server_token=dlt.secrets.value):
    config: RESTAPIConfig = {
        "client": {
            "base_url": "https://api-incode-id.incodesmile.com",
            "auth": {
                "type": "bearer",
                "token": server_token,
            },
        },
        "resources": [
            {"name": "authorize_server", "endpoint": {"path": "v1/integration/authorize/server", "data_selector": "token"}},
            {"name": "userinfo", "endpoint": {"path": "oauth2/userinfo"}}
        ],
    }
    yield from rest_api_resources(config)


def get_data() -> None:
    pipeline = dlt.pipeline(
        pipeline_name="incode_pipeline",
        destination="duckdb",
        dataset_name="incode_data",
    )
    load_info = pipeline.run(incode_source())
    print(load_info)

To add more endpoints, append entries from the resource table to the "resources" list using the same name, path, and data_selector pattern.

---

How do I query the loaded data?

Once the pipeline runs, dlt creates one table per resource. You can query with Python or SQL.

Python (pandas DataFrame):

Copy
import dlt

data = dlt.pipeline("incode_pipeline").dataset()
sessions_df = data.authorize_server.df()
print(sessions_df.head())

SQL (DuckDB example):

Copy
SELECT * FROM incode_data.authorize_server LIMIT 10;

In a marimo or Jupyter notebook:

Copy
import dlt

data = dlt.pipeline("incode_pipeline").dataset()
data.authorize_server.df().head()

See how to explore your data in marimo Notebooks and how to query your data in Python with dataset.

---

What destinations can I load Incode data to?

dlt supports loading into any of these destinations — only the destination parameter changes:

Change the destination in dlt.pipeline(destination="snowflake") and add credentials in .dlt/secrets.toml. See the full destinations list.

---

Next steps

Continue your data engineering journey with the other toolkits of the dltHub AI Workbench:

• data-exploration — Build custom notebooks, charts, and dashboards for deeper analysis with marimo notebooks.
• dlthub-runtime — Deploy, schedule, and monitor your pipeline in production.

Copy
dlt ai toolkit data-exploration install
dlt ai toolkit dlthub-runtime install

• How to deploy a pipeline
• How to explore your data in marimo Notebooks
• How to query your data in Python with dataset
• Join the dlt community on Slack