List providers

GET

/v1/providers

const url = 'http://127.0.0.1:8000/v1/providers';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url http://127.0.0.1:8000/v1/providers

List all fixed provider slots and their non-secret configuration.

Responses

200

Successful Response

application/json

Response Listproviders

Array<object>

ProviderResponse

Non-secret configuration for one model provider.

object

name

required

ProviderName

Stable provider name.

string

Allowed values: openai microsoft_foundry openai_compatible_api

base_url

required

Any of:

string
null

string

configuration

required

Configuration

Provider-specific non-secret settings.

object

key

additional properties

any

has_api_key

required

Has Api Key

Whether ParseHawk has a stored API key for the provider.

boolean

created_at

required

Created At

UTC creation time.

string format: date-time

updated_at

required

Updated At

UTC last-update time.

string format: date-time

Example

[
  {
    "name": "openai"
  }
]

500

Unexpected server error.

application/json

ApiErrorResponse

Error returned by request validation or a ParseHawk domain service.

object

detail

required

Any of:

string
Array<object>

string

Example^generated

{
  "detail": [
    {}
  ]
}

List providers

Responses

200

Example

500

Examplegenerated

Example^generated