NylorunDocsBeta
Runtime APIAgentsSecrets

Get an Agent's secret

GET
/v1/agents/{agentId}/secrets/{name}

Its name, type and binding. Never its value.

Authorization

headerAuthorizationBearer <token>

An application key of the Tenant (PUT /v1/tenant/keys/{keyId}), or Studio's key, derived from the admin key. With Nylorun-Subject and Nylorun-Scopes, it acts for that person, narrowed to those scopes. Never accepted from a browser (Origin).

Path Parameters

agentId*string

The Agent id, percent-encoded: users%2Falice%2Ftriage for users/alice/triage

name*string

The secret's name: the variable for environment_secret and environment_variable, a label for bearer and headers

Header Parameters

Nylorun-Protocol*string

The protocol version, 18

Nylorun-Subject?string

The person an application key acts for

Nylorun-Scopes?string

The subject's space-separated scopes; required with a subject

Response Body

The secret

application/json
  1. response
name*string
type*string
Value in"bearer""headers""workload""environment_secret""environment_variable"
binding*
headerNames?array<string>
via?string
toolPrefix?string
identity?
createdAt*string
rotatedAt?string
import { createClient } from "@nylorun/agents";const client = await createClient();const secret = await client.agents.secrets.get("users/alice/assistant", "linear");
{  "name": "string",  "type": "bearer",  "binding": {    "url": "string",    "allowedHosts": [      "string"    ],    "inject": {      "header": "string",      "format": "string"    }  },  "headerNames": [    "string"  ],  "via": "string",  "toolPrefix": "string",  "identity": {    "header": "string"  },  "createdAt": "string",  "rotatedAt": "string"}