Skip to Content
kosemdocs
ReferenceAPIProviders

Get provider type

Gets a provider type.

GET
/v1/providerTypes/{providerType}

Gets a provider type.

Authorization

bearer
headerAuthorizationBearer <token>

An access token, or an API key.

Path Parameters

providerType*string

The type's ID, such as openai.

Match^[a-z][a-z0-9-]{0,62}$

Response Body

OK

application/json
  1. response
available*boolean

Whether this kosem can add providers of this type: WORKLOAD_IDENTITY types need kosem's identity token issuer, which a deployment may not have.

configFields*array<>

The settings its providers take in their config.

connectedBy*string

How a provider of it authenticates: API_KEY, with an API key the provider's service accepts first; WORKLOAD_IDENTITY, by CreateProvider without a key, then UpdateProvider with its settings once the cloud trusts the provider's trust.

Value in"API_KEY""WORKLOAD_IDENTITY"
credentialUri*string

Where to create an API key for it; empty when it has no such page.

description*string

What the type is.

displayName*string

Name shown in user interfaces.

name*string

Resource name, such as providerTypes/openai.

Example Request
curl -X GET 'https://api.kosem.ai/v1/providerTypes/string'
Example Response
{
  "available": true,
  "configFields": [
    {
      "default": "string",
      "description": "string",
      "displayName": "string",
      "key": "string",
      "placeholder": "string",
      "required": true,
      "type": "TEXT"
    }
  ],
  "connectedBy": "API_KEY",
  "credentialUri": "string",
  "description": "string",
  "displayName": "string",
  "name": "string"
}