Faqbot Python API Docs | dltHub

Faqbot is a REST API platform for submitting questions and retrieving automated or human‑curated answers (Q&A / FAQ management). The REST API base URL is https://api.example.com/ and all requests require a Bearer token for 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 Faqbot data in under 10 minutes.

---

What data can I load from Faqbot?

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

---

How do I authenticate with the Faqbot API?

The API uses HTTP Bearer authentication: include Authorization: Bearer <API_KEY> in request headers. Optionally include organization/project headers if supported by the provider.

1. Get your credentials

1. Sign in to your Faqbot (or bot) provider dashboard.
2. Open the Bot/Integration or API Keys section (may be labeled “API token”, “Integration > REST API” or similar).
3. Create or copy the API token.
4. Store the token securely (environment variable or secrets manager) and use it as the Bearer token in requests.

2. Add them to .dlt/secrets.toml

Copy
[sources.faqbot_source]
api_key = "your_api_key_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 Faqbot 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 faqbot_pipeline.py

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

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

Inspect your pipeline and data:

Copy
dlt pipeline faqbot_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 questions and responses from the Faqbot 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 faqbot_source(api_key=dlt.secrets.value):
    config: RESTAPIConfig = {
        "client": {
            "base_url": "https://api.example.com/",
            "auth": {
                "type": "bearer",
                "token": api_key,
            },
        },
        "resources": [
            {"name": "questions", "endpoint": {"path": "questions"}},
            {"name": "responses", "endpoint": {"path": "responses"}}
        ],
    }
    yield from rest_api_resources(config)


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

SQL (DuckDB example):

Copy
SELECT * FROM faqbot_data.questions LIMIT 10;

In a marimo or Jupyter notebook:

Copy
import dlt

data = dlt.pipeline("faqbot_pipeline").dataset()
data.questions.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 Faqbot 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.

---

Troubleshooting

Authentication failures

If you receive 401 Unauthorized: verify the Authorization header is set to Authorization: Bearer <API_KEY>, check the key is active and not expired, and ensure you are using the correct environment (test vs production) API key.

Rate limiting (429 Too Many Requests)

Faqbot list endpoints are rate limited (reported example: 1000 requests/hour). On 429 responses, implement exponential backoff and respect the Retry-After header when provided.

Pagination

List endpoints support pagination. If responses include pagination tokens/links use them to request subsequent pages. Confirm the provider’s specific pagination parameters (page, per_page, cursor) in the dashboard docs.

Ensure that the API key is valid to avoid 401 Unauthorized errors. Also, verify endpoint paths and parameters to avoid 404 Not Found errors.

---

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