API reference - Bridgeline API

This reference is generated from the same OpenAPI 3.1 document the API is built from, so it can’t drift from what the API does. If you’d like the document itself for your own tooling, ask your Bridgeline contact.

Base URL

https://portal.bridgelinepf.com/api

Every path starts with /v1. During the beta the API is served from the portal’s domain.

Headers

Header	Direction	Purpose
`Authorization: Bearer <key>`	Request	Required on every call. See authentication
`Content-Type: application/json`	Request	On every request with a body
`Idempotency-Key`	Request	Optional on writes; makes retries safe. See idempotency
`Bridgeline-Version`	Both	Pins an API version; every response echoes the version used. See versioning
`Request-Id`	Response	Our id for the request. Quote it when you contact us
`RateLimit-Limit`, `RateLimit-Remaining`, `RateLimit-Reset`	Response	Where you stand against your limits. See rate limits
`Retry-After`	Response	Seconds to wait, on `429`, `503` and `409 IDEMPOTENCY_REQUEST_IN_PROGRESS`
`Idempotent-Replayed: true`	Response	This is a stored response to an earlier request with the same key

Endpoints

Endpoint	Scope
`POST /v1/quotes`	`quotes:write`	Create a quote
`GET /v1/quotes/{id}`	`quotes:read`	Retrieve a quote
`POST /v1/quotes/{id}/hosted-link`	`quotes:write`	Get a new hosted link
`GET /v1/coverage-types`	None	List coverage types
`GET /v1/whoami`	None	Check an API key
`POST /v1/test_helpers/quotes/{id}/interest`	`quotes:write`	Simulate your client’s interest (test keys only)

Trying requests

Every endpoint page shows the request in cURL, Node and Python, with example responses. Run them from your own machine with your key in an environment variable. There’s no in-browser playground for now. Keep every key, live or test, in your secret store, not in a web page.

In the reference vs the guides

The reference lists every field and its type. For what the fields mean together, read the guides: quote in one call, the interactive quote and choosing an option.