Skip to content

Tutorials Overview

Use TULIP directly through its OpenAI-compatible API, or connect it to an existing application or agent.

The API tutorials include runnable Bash and Python examples. Integration tutorials focus on configuring TULIP in external tools.

TU Delft Network Access Required

TULIP is only reachable from the TU Delft network. Off campus, connect via eduVPN before using the API.

Direct API

These tutorials contain runnable Bash and Python examples:

Before running the examples

  1. Clone and enter the repository:

    git clone https://gitlab.ewi.tudelft.nl/tulip/reference-tests.git
cd reference-tests

  2. Create your environment file:

    cp .env.example .env

  3. Set your API key in .env.

Dependency Setup

  • If you run examples with pixi run ..., Python dependencies are managed from this repository's pixi.toml.
  • Bash examples may still require system tools like jq.
  • If you do not use Pixi, install dependencies from pyproject.toml manually.

Integrations

These tutorials explain how to configure TULIP as the model provider for external applications and agent tools. They do not require the example repository unless stated otherwise.