inferences_read

GET

/inferences/{id}

const url = 'https://api.canopyhq.dev/inferences/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/inferences/example \
  --header 'Authorization: Bearer <token>'

Authorizations

console_token

Parameters

Path Parameters

required

string

The option, by the name the tenant gave it.

Responses

200

The option.

application/json

One of:

object
object

The scripted model, with no provider credential.

object

compact_at

Compact before the next request after a completion reaches this prompt-token count.

integer format: int64

provider

required

string

Allowed values: simulated

retry

How often a transient provider failure is attempted, with doubling waits.

object

attempts

required

integer format: int32

backoff

required

string

OpenRouter’s chat completions: a model slug such as anthropic/claude-opus-5, and the API key.

object

compact_at

Compact before the next request after a completion reaches this prompt-token count.

integer format: int64

credential

required

A secret’s identifier within its owning tenant, never its value.

string

model

required

string

provider

required

string

Allowed values: openrouter

retry

How often a transient provider failure is attempted, with doubling waits.

object

attempts

required

integer format: int32

backoff

required

string

Example

{
  "provider": "simulated"
}

401

No console token, or one that did not verify.

404

The tenant owns no option by that name.