Read a provider

GET

/providers/{id}

const url = 'https://api.canopyhq.dev/providers/example';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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://api.canopyhq.dev/providers/example \
  --header 'Authorization: Bearer <token>'

Authorizations

console_token

Parameters

Path Parameters

required

A provider’s name within its tenant.

string

The provider, by the name the tenant gave it.

Responses

200

The provider, without its secret.

application/json

A provider as the console reads it: never its secret.

object

base_url

string | null

required

A provider’s name within its tenant.

string

kind

required

Which kind of provider, without where it is or what it dials with.

string

Allowed values: simulated openrouter

Example

{
  "kind": "simulated"
}

401

No console token, or one that did not verify.

404

The tenant keeps no provider by that name.