GET /v1/providers/config

GET

/v1/providers/config

const url = 'https://app.everruns.com/api/v1/providers/config';
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 https://app.everruns.com/api/v1/providers/config

Responses

200

Resource config for providers

application/json

Provider resource config: caller policies plus the credential schemas the UI renders per driver.

object

drivers

required

Per-driver credential schemas, ordered by driver id.

Array<object>

A driver’s declared credential schema, so the Settings UI can render discrete typed inputs (multi-field AWS keys, Entra OAuth fields) instead of one opaque password field.

object

credential_schema

required

The fields and instructions to render for this driver’s credential.

object

fields

required

Input fields to render.

Array<object>

A single form field.

object

default_value

Default value the UI pre-fills (e.g. an OAuth scope or AWS region). The stored credential omits unfilled optional fields, so drivers still apply their own defaults; this only seeds the form input.

string | null

field_type

required

Input type.

string

Allowed values: password text url

group

Mutually-exclusive group label this field belongs to. Fields sharing a label are one alternative credential method (e.g. “API key” vs “OAuth”); ungrouped fields are always part of the credential. None for the common single-method case.

string | null

help_text

Help text shown below the input.

string | null

label

required

Label shown next to the input.

string

name

required

Field name used as the key when submitting (e.g. “api_key”).

string

placeholder

Placeholder text inside the input.

string | null

required

required

Whether the field is required.

boolean

instructions_markdown

required

Markdown instructions shown above the form (how to get the key, etc.).

string

driver

required

Driver id (e.g. openai, bedrock, mai).

string

supports_oauth

required

Whether the driver declares an interactive “Connect with …” OAuth flow.

boolean

policies

required

Map of policy ID → whether the caller satisfies it.

object

key

additional properties

boolean

Example

{
  "drivers": [
    {
      "credential_schema": {
        "fields": [
          {
            "field_type": "password"
          }
        ]
      }
    }
  ]
}