BUILD / START

Quickstart

Install the published package, connect a running model, and send a first Responses API request.

Source documentation
Read as MarkdownView source

Install vLLM Agentic API, connect it to a running vLLM server, and send your first Responses API request. These commands use the 0.9.0 release on PyPI.

Before you start

Check the upstream's model ID before making a request:

curl -sS http://127.0.0.1:8000/v1/models

Use the exact id returned for your model in the request below.

Install the gateway

python -m pip install agentic-api==0.9.0
python -m agentic_api --version
python -m agentic_api doctor --mode remote

The doctor command checks the packaged gateway for this mode. It does not start vLLM.

Start the gateway

In one terminal, run:

python -m agentic_api serve --vllm-base-url http://127.0.0.1:8000

The gateway listens on port 9000 by default. Leave this terminal running for the next step. Pass the upstream's base URL, without /v1.

Send a Responses API request

In another terminal, replace MODEL_ID with the ID returned by the upstream and run:

curl -sS http://127.0.0.1:9000/v1/responses \
  -H 'Content-Type: application/json' \
  -d '{"model":"MODEL_ID","input":"Say hello in one sentence."}'

The JSON response contains an output array. To continue a stored response, see the Responses API reference.

Next steps