Ory Python API Docs | dltHub

Build a Ory-to-database pipeline in Python using dlt with AI Workbench support for Claude Code, Cursor, and Codex.

Last updated:

Ory's REST API documentation is available at https://www.ory.com/docs/reference/api for WebAuthn login and registration, and at https://www.ory.com/docs/kratos/reference/api for identity management features. The REST API base URL is Self‑hosted: https://<your-host>:443 Ory Cloud (managed projects): https://{project_slug}.projects.oryapis.com and All administrative API endpoints require a Bearer token (Authorization: Bearer ); public endpoints use cookie‑based session authentication..

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 Ory data in under 10 minutes.


What data can I load from Ory?

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

ResourceEndpointMethodData selectorDescription
identityadmin/identitiesGETList identities (top‑level array)
identity_schemaadmin/schemas/{id}GETGet a specific identity schema (single object)
sessionadmin/sessions/{id}GETRetrieve a session (single object)
frontend_login_flowself-service/login/flowsGETGet login flow context (single object)
courier_messagesadmin/courier/messagesGETList courier messages (top‑level array)
oauth2_clientsadmin/clientsGETList OAuth2 clients (top‑level array)
oauth2_clientadmin/clients/{id}GETGet a specific OAuth2 client (single object)
well_known_jwk/.well-known/jwks.jsonGETkeysRetrieve JSON Web Key Set (array under "keys")
openid_connect_discovery/.well-known/openid-configurationGETOpenID Connect discovery document (object)
keto_relation_tuplesadmin/relation-tuplesGETrelation_tuplesList relation tuples (array under "relation_tuples")
health_alivehealth/aliveGETLiveness probe (status only)
health_readyhealth/readyGETReadiness probe (status only)

How do I authenticate with the Ory API?

Ory uses OAuth2 Bearer tokens for admin APIs (Authorization: Bearer ). Public/frontend flows use cookie‑based session authentication.

1. Get your credentials

  1. For Hydra (OAuth2): create an OAuth2 client using the admin API POST /admin/clients or via the dashboard to receive a client_id and client_secret.
  2. For Ory Cloud: open the project in the Ory Cloud console, navigate to "API credentials" or "Service accounts", and generate an admin token or client credentials.
  3. For self‑hosted deployments: set the ORY_ACCESS_TOKEN environment variable or follow the product's docs to provision a bearer token for admin endpoints.

2. Add them to .dlt/secrets.toml

[sources.ory_source] api_token = "your_admin_bearer_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:

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

1. Install the dlt AI Workbench:

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:

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 Ory 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:

python ory_pipeline.py

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

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

Inspect your pipeline and data:

dlt pipeline ory_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 identities and clients from the Ory API into DuckDB. It mirrors the endpoint and data selector configuration from the table above:

import dlt from dlt.sources.rest_api import RESTAPIConfig, rest_api_resources @dlt.source def ory_source(api_token=dlt.secrets.value): config: RESTAPIConfig = { "client": { "base_url": "Self‑hosted: https://<your-host>:443 Ory Cloud (managed projects): https://{project_slug}.projects.oryapis.com", "auth": { "type": "bearer", "token": api_token, }, }, "resources": [ {"name": "identities", "endpoint": {"path": "admin/identities"}}, {"name": "clients", "endpoint": {"path": "admin/clients"}} ], } yield from rest_api_resources(config) def get_data() -> None: pipeline = dlt.pipeline( pipeline_name="ory_pipeline", destination="duckdb", dataset_name="ory_data", ) load_info = pipeline.run(ory_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):

import dlt data = dlt.pipeline("ory_pipeline").dataset() sessions_df = data.identities.df() print(sessions_df.head())

SQL (DuckDB example):

SELECT * FROM ory_data.identities LIMIT 10;

In a marimo or Jupyter notebook:

import dlt data = dlt.pipeline("ory_pipeline").dataset() data.identities.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 Ory data to?

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

DestinationExample value
DuckDB (local, default)"duckdb"
PostgreSQL"postgres"
BigQuery"bigquery"
Snowflake"snowflake"
Redshift"redshift"
Databricks"databricks"
Filesystem (S3, GCS, Azure)"filesystem"

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.
dlt ai toolkit data-exploration install dlt ai toolkit dlthub-runtime install

Was this page helpful?

Community Hub

Need more dlt context for Ory?

Request dlt skills, commands, AGENT.md files, and AI-native context.