> For the complete documentation index, see [llms.txt](https://docs.burpgpt.app/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.burpgpt.app/how-to/use-supported-local-model-providers/with-openai-compatible-api.md).

# With an OpenAI-compatible API

Use `OpenAI-compatible API` for local, self-hosted, or third-party runtimes that expose a chat API compatible with the OpenAI schema.

To configure the provider:

1. Go to the `Provider settings` tab.
2. Select `OpenAI-compatible API` from the `Model provider` dropdown.
3. Enter the provider `Base URL`. This is usually the root API URL ending in `/v1`.
4. Enter an `API key` if your provider requires one. Leave it blank only if your endpoint does not require authentication.
5. In the `Model` field, enter the exact model identifier exposed by your provider.
6. Adjust the `Request parameters` JSON to match the parameters supported by your endpoint.
7. Click `Test request` to validate the settings before scanning traffic.

{% hint style="warning" %}
The extension does not validate provider-specific model names or parameter compatibility before sending the request. If the test request fails, check the provider response in Burp's `Logger` tab.
{% endhint %}


---

# 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.burpgpt.app/how-to/use-supported-local-model-providers/with-openai-compatible-api.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.