Requirement Yogi Python API Docs | dltHub

Requirement Yogi is a requirement management platform that provides REST APIs for integrating with Jira and Confluence data. The REST API base URL is https://confluence.requirementyogi.com and all requests require custom headers for base URL and API key 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 add "dlt[hub]" and start loading Requirement Yogi data in under 10 minutes.

---

What data can I load from Requirement Yogi?

Here are some of the endpoints you can load from Requirement Yogi:

---

How do I authenticate with the Requirement Yogi API?

Authentication requires two custom headers: 'X-Base-Url' to specify the Atlassian site URL and 'X-Api-Key' to provide your generated personal access token.

1. Get your credentials

To obtain credentials for the Requirement Yogi REST API: 1. Navigate to the Requirement Yogi web application dashboard (https://app.requirementyogi.com for the EU region or https://app.us.requirementyogi.com for the US region). 2. Log in to your Requirement Yogi account. 3. Click your profile icon in the top navigation bar. 4. Navigate to Settings. 5. In the left sidebar, select Personal access tokens. 6. Click Generate new token, provide a name and expiration, and click Generate. Copy the token immediately, as it cannot be retrieved again. Ensure your Atlassian account is linked under Settings > Linked accounts to provide necessary permissions for API access.

2. Add them to .dlt/secrets.toml

Copy
[sources.requirement_yogi_source]
api_key = "your_personal_access_token_here"
base_url = "https://your-atlassian-site.atlassian.net/wiki"

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 init
uv add "dlt[hub]"

1. Install the dlt AI harness:

Copy
uv run dlthub 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
uv run dlthub ai toolkit install rest-api-pipeline

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 Requirement Yogi 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
uv run python requirement_yogi_pipeline.py

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

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

Inspect your pipeline and data:

Copy
uv run dlthub 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 /rest/search and /rest/reqs/1/requirement2/{spaceKey} from the Requirement Yogi 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 requirement_yogi_source(api_key=dlt.secrets.value):
    config: RESTAPIConfig = {
        "client": {
            "base_url": "https://confluence.requirementyogi.com",
            "auth": {"type": "api_key", "api_key": api_key, "name": "X-Api-Key", "location": "header"},
        },
        "resources": [
            {"name": "requirements", "endpoint": {"path": "rest/reqs/1/requirement2/{spaceKey}"}},
            {"name": "baselines", "endpoint": {"path": "rest/reqs/1/baseline/{spaceKey}"}}
        ],
    }
    yield from rest_api_resources(config)


def get_data() -> None:
    pipeline = dlt.pipeline(
        pipeline_name="requirement_yogi_pipeline",
        destination="duckdb",
        dataset_name="requirement_yogi_data",
    )
    load_info = pipeline.run(requirement_yogi_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("requirement_yogi_pipeline").dataset()
sessions_df = data.requirements.df()
print(sessions_df.head())

SQL (DuckDB example):

Copy
SELECT * FROM requirement_yogi_data.requirements LIMIT 10;

In a marimo or Jupyter notebook:

Copy
import dlt

data = dlt.pipeline("requirement_yogi_pipeline").dataset()
data.requirements.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 Requirement Yogi 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 harness:

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

Copy
uv run dlthub ai toolkit install data-exploration
uv run dlthub ai toolkit install dlthub-platform

• 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