Configure a provider

PATCH

/v1/providers/{name}

curl --request PATCH \
  --url http://127.0.0.1:8000/v1/providers/openai \
  --header 'Content-Type: application/json' \
  --data '{ "base_url": "http://127.0.0.1:11434/v1", "configuration": {}, "api_key": "example", "api_key_env": "OPENAI_API_KEY" }'

• Default local ParseHawk API

Update a provider endpoint, non-secret settings, or securely stored API key.

Parameters

Path Parameters

name

required

ProviderName

Stable provider name.

string

Allowed values: openai microsoft_foundry openai_compatible_api

Stable provider name.

Request Body^required

Media typeapplication/json

ConfigureProviderRequest

Write-only provider configuration. The API never returns the API key.

object

base_url

Any of:

string

string

null

null

configuration

Any of:

object

object

key

additional properties

any

null

null

api_key

Any of:

string

string

null

null

api_key_env

Any of:

string

string

null

null

Responses

200

Successful Response

Media typeapplication/json

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

string

null

null

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"
}

422

The request or domain input failed validation.

Media typeapplication/json

ApiErrorResponse

Error returned by request validation or a ParseHawk domain service.

object

detail

required

Any of:

string

string

Array<object>

Array<object>

object

key

additional properties

any

Example^generated

{
  "detail": [
    {}
  ]
}

500

Unexpected server error.

Media typeapplication/json

ApiErrorResponse

Error returned by request validation or a ParseHawk domain service.

object

detail

required

Any of:

string

string

Array<object>

Array<object>

object

key

additional properties

any

Example^generated

{
  "detail": [
    {}
  ]
}