> For the complete documentation index, see [llms.txt](https://docs.algenta.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.algenta.ai/help/quick-reference.md).

# Quick reference

The fastest lookup in the docs: find your task, copy the call. Each row shows the same operation across the three surfaces. Full detail lives on the linked pages and in the [API explorer](/http-api/explorer.md).

## Reach the engine

| Surface                     | Use it for                         | Start here                                   |
| --------------------------- | ---------------------------------- | -------------------------------------------- |
| **HTTP API** (`/v1`)        | Any language, zero install         | [API overview](/http-api/overview.md)        |
| **Python / TypeScript SDK** | A typed client over the API        | [Python SDK](/sdks/python.md)                |
| **`algenta-core` Runtime**  | In-process local execution         | [Quickstart](/getting-started/quickstart.md) |
| **MCP server**              | AI agents (Cursor, Claude Desktop) | [MCP server](/sdks/mcp.md)                   |
| **`de` CLI**                | The terminal                       | [CLI reference](/sdks/cli.md)                |

## Common tasks

| Task                     | HTTP                                                      | `de` CLI                                        | Python SDK                     |
| ------------------------ | --------------------------------------------------------- | ----------------------------------------------- | ------------------------------ |
| Check the engine is up   | `GET /v1/health`                                          | `de health`                                     | —                              |
| Authenticate a request   | `Authorization: Bearer $ALGENTA_API_KEY`                  | `de config set-key $ALGENTA_API_KEY`            | `AlgentaClient(api_key=…)`     |
| Run a simulation         | `POST /v1/simulate`                                       | `de simulate run.json`                          | `client.simulate(...)`         |
| Get a recommendation     | `POST /v1/recommend`                                      | `de recommend run.json`                         | `client.recommend(...)`        |
| Query governed data      | `POST /v1/query`                                          | `de data query-batch …`                         | `client.query(...)`            |
| List / summarize data    | `GET /v1/data` · `GET /v1/data/{id}/summary`              | `de data list` · `de data summary $DATASET_ID`  | `client.list_data()`           |
| Connect a data source    | `POST /v1/connectors`                                     | `de connectors create …`                        | `client.create_connector(...)` |
| Log a decision + outcome | `POST /v1/decisions` · `PATCH /v1/decisions/{id}/outcome` | `de decisions log …` · `de decisions outcome …` | `client.log_decision(...)`     |
| Run an agent             | `POST /v1/agent/run`                                      | `de agent-runs create …`                        | `client.create_agent_run(...)` |
| Submit an async job      | `POST /v1/jobs` · `GET /v1/jobs/{id}/result`              | `de job submit …` · `de job result $JOB_ID`     | `client.submit_job(...)`       |
| Check usage & limits     | `GET /v1/usage` · `GET /v1/limits`                        | `de account usage` · `de account limits`        | `client.usage()`               |

## Env vars you reach for most

| Variable                  | What it does                                                                     |
| ------------------------- | -------------------------------------------------------------------------------- |
| `ALGENTA_API_KEY`         | Your bearer credential (`DE_API_KEY` is a legacy alias).                         |
| `ALGENTA_BASE_URL`        | The engine URL for self-hosted clients (absolute, e.g. `http://localhost:8000`). |
| `ALGENTA_DEPLOYMENT_MODE` | `saas` \| `self_hosted` \| `air_gapped` \| … — the privacy/egress profile.       |
| `ALGENTA_PRODUCT`         | The edition surface to expose (e.g. `codna`).                                    |
| `RUNTIME_FALLBACK_MODE`   | `deny` \| `allow` \| `auto` — whether the API may leave the Mojo pool.           |

## When something breaks

Two checks isolate most problems: `curl http://localhost:8000/v1/health` and `python3 scripts/license_status.py`. Then jump to [Troubleshooting](/help/troubleshooting.md). New to a term? See the [Glossary](/help/glossary.md).


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.algenta.ai/help/quick-reference.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.