> ## Documentation Index
> Fetch the complete documentation index at: https://cadenya.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.
# Create a tool set secret
> Store a credential once. Reference it as ${NAME} in adapter headers, and it resolves at call time and never comes back.
A [tool set](/docs/api-reference/toolservice/create-a-new-tool-set) that talks to a real API needs a credential. You do not put it in the adapter. You store it as a secret, reference it by name, and Cadenya substitutes it when it makes the call.
```typescript TypeScript theme={null}
await client.toolSets.secrets.create(toolSetId, {
workspaceId,
metadata: { name: 'ECHO_TOKEN' },
spec: { value: process.env.ECHO_TOKEN! },
});
```
```go Go theme={null}
_, err := client.ToolSets.Secrets.New(ctx, toolSetID,
cadenya.ToolSetSecretNewParams{
WorkspaceID: cadenya.String(workspaceID),
Metadata: shared.CreateResourceMetadataParam{
Name: "ECHO_TOKEN",
},
Spec: cadenya.ToolSetSecretSpecParam{
Value: os.Getenv("ECHO_TOKEN"),
},
})
```
```ruby Ruby theme={null}
cadenya.tool_sets.secrets.create(
tool_set_id,
workspace_id: workspace_id,
metadata: {name: "ECHO_TOKEN"},
spec: {value: ENV.fetch("ECHO_TOKEN")}
)
```
```bash cURL theme={null}
curl -X POST "https://api.cadenya.com/v1/workspaces/${WORKSPACE_ID}/tool_sets/${TOOL_SET_ID}/secrets" \
-H "Authorization: Bearer ${CADENYA_API_KEY}" \
-H "Content-Type: application/json" \
-d '{ "metadata": { "name": "ECHO_TOKEN" }, "spec": { "value": "'"${ECHO_TOKEN}"'" } }'
```
## The value goes in and never comes out
`spec.value` is write-only. The create response redacts it, and so does every read:
```typescript theme={null}
const secret = await client.toolSets.secrets.create(toolSetId, {
workspaceId, metadata: { name: 'ECHO_TOKEN' }, spec: { value: 'super-secret' },
});
console.log(secret.spec.value); // '': redacted on the way out
const read = await client.toolSets.secrets.retrieve(toolSetId, secretId, { workspaceId });
console.log(read.spec.value); // '': and on every read after
```
There is no endpoint that returns a stored value. To change it, [update the secret](/docs/api-reference/toolservice/update-a-tool-set-secret) with a new one; you cannot read the old one back to confirm it.
Secret names are unique within a tool set. A second secret with the same name is a `409`.
## Reference it as `${NAME}` in the adapter
Adapter headers take `${SECRET_NAME}` placeholders. Cadenya resolves them at call time, so the plaintext lives only in the request Cadenya makes, never in your configuration and never in a response.
```typescript theme={null}
// 1. The adapter references a name, not a token.
const toolSet = await client.toolSets.create({
workspaceId,
metadata: { name: 'Orders API', externalId: 'orders' },
spec: {
adapter: {
type: 'http',
http: { baseUrl: 'https://api.example.com', headers: { Authorization: 'Bearer ${ORDERS_TOKEN}' } },
},
},
});
// 2. The value is stored separately.
await client.toolSets.secrets.create(toolSet.metadata.id, {
workspaceId, metadata: { name: 'ORDERS_TOKEN' }, spec: { value: process.env.ORDERS_TOKEN! },
});
```
Verified end to end against a live HTTP adapter: with the header set to `Bearer ${ECHO_TOKEN}` and the secret stored, the tool call reached the upstream server carrying the resolved value, the literal `${ECHO_TOKEN}` never appeared, and the tool call recorded its source:
```json theme={null}
"resolvedSecrets": [ { "key": "ECHO_TOKEN", "source": "RESOLVED_SECRET_SOURCE_TOOLSET" } ]
```
`resolvedSecrets` on a [tool call](/docs/api-reference/objectiveservice/get-an-objective-tool-call-by-id) gives each secret's `key` and the `source` scope it came from. It never carries the value.
## Which scope wins
The same name can exist in three places, resolved narrowest-first:
| Scope | Set on | Wins when |
| ------------------------------------------ | ----------------------------------------------------------------------- | ------------------------------------- |
| Objective | one [objective](/docs/api-reference/objectiveservice/create-a-new-objective) | always, over the other two |
| Tool set | this endpoint | over workspace |
| [Workspace](/docs/guides/store-and-use-secrets) | the workspace | only if nothing narrower has the name |
`RESOLVED_SECRET_SOURCE_OBJECTIVE` beats `_TOOLSET` beats `_WORKSPACE`. So a per-user token passed on a single objective overrides a shared service credential for that one run, which is the whole reason objective secrets exist. Store the durable credential here, at the tool set, and let the short-lived one override it per objective.
## Related
The full precedence story, workspace to objective.
Where `${SECRET_NAME}` goes in an adapter header.
Rotate a value you can never read back.
Objective secrets, which override this one per run.
## OpenAPI
````yaml post /v1/workspaces/{workspaceId}/tool_sets/{toolSetId}/secrets
openapi: 3.1.0
info:
title: Cadenya API
description: API for the Cadenya Agent Runtime platform.
version: '1.0'
servers:
- url: https://api.cadenya.com
description: Production server
security:
- bearerAuth: []
tags:
- name: AIProviderKeyService
- name: APIKeyService
description: |-
Issue, rotate, disable, and revoke a workspace's API keys. Every key
belongs to exactly one workspace; the system-managed global account key is
managed via GlobalAPIKeyService instead.
- name: AccountService
description: >-
Manage the authenticated account. Accounts are the top-level
organizational
unit and contain one or more workspaces.
- name: AgentScheduleService
description: >-
Manage recurring schedules attached to agents. Schedules trigger
objectives
on a cadence defined by AgentScheduleSpec.Schedule.
- name: AgentService
description: >-
Manage AI agents within a workspace. Agents define AI behavior and tool
access.
- name: AgentVariationService
description: >-
Manage variations of an agent and their tool, sub-agent, and memory layer
assignments.
- name: GlobalAPIKeyService
description: |-
Manage the account's system-provisioned global API key. The global key is
the only key that spans every workspace; it is created by the system and
cannot be deleted, so the surface is retrieve, rotate, and the
disable/enable kill switch.
- name: MemoryService
description: >-
Manage memory layers and their entries. Layers are named containers that
can
be composed into an objective's memory cascade; entries are the keyed values
within a layer. System-managed layers (e.g., episodic layers created by the
runtime) cannot be mutated through this API.
- name: ModelService
description: |-
Manage LLM models available to a workspace. Models represent provider and
family pairs (e.g., "anthropic/claude-sonnet-4.6"). Workspaces are seeded
with the supported models and you can enable or disable each one.
- name: ObjectiveEventStreamsService
- name: ObjectiveService
- name: ProfilesService
description: |-
Operations on profiles, the account-level principals (users, API keys,
system) that authenticate against the API.
- name: SearchService
- name: TenantService
description: >-
Read and erase tenants and the subjects under them. Tenants and subjects
are
created by assertion — on objective creation or widget session mint — never
directly, so this service has no create or update: it exists to enumerate what
assertions have produced, and to destroy it on request.
- name: ToolService
description: >-
Manage tool sets and the tools they contain. Tool sets group related
tools,
and tools define specific capabilities available to agents.
When a tool set is managed, only API key actors can modify its tools; human
(profile) actors cannot.
- name: UploadService
description: |-
Issue short-lived presigned URLs for direct client-to-object-storage
uploads. Created uploads can be referenced by id when creating or updating
resources that accept binary content (e.g., MemoryEntry).
- name: WidgetService
description: |-
Manage embeddable chat widgets. A widget binds an agent to a globally
unique hostname with a per-widget origin allowlist; browsers reach it with
session tokens minted via WidgetSessionService.
- name: WidgetSessionService
description: >-
Mint and manage widget sessions. Session creation is server-to-server
only:
the customer's backend authenticates its visitor, asserts tenant/subject
context, attaches any per-visitor secrets, and receives a short-lived
bearer token the browser uses against the widget host.
- name: WorkspaceAdminService
description: >-
Administer workspaces across the account: create and archive workspaces
and
manage their membership. These operations are account-scoped and require the
admin role (a token whose profile holds the WorkOS admin role); they live
under /v1/account/workspaces rather than the workspace-scoped /v1/workspaces
tree so an admin can manage any workspace in the account, including ones they
are not themselves a member of.
- name: WorkspaceSecretService
- name: WorkspaceService
description: |-
Manage workspaces within an account. Workspaces provide organizational
grouping and isolation for resources such as agents, tools, and API keys.
This is the workspace-scoped, end-user surface. Administrative operations
(create / archive workspaces, manage members) live in WorkspaceAdminService
under /v1/account/workspaces and require the admin role.
paths:
/v1/workspaces/{workspaceId}/tool_sets/{toolSetId}/secrets:
post:
tags:
- ToolService
- Tool Set Secrets
summary: Create a new tool set secret
description: Creates a new secret scoped to the tool set
operationId: ToolService_CreateToolSetSecret
parameters:
- name: workspaceId
in: path
description: The workspace that owns the tool set.
required: true
schema:
type: string
example: workspace_01HXKD2E5NQM3T9AYWCF133E3Q
- name: toolSetId
in: path
description: >-
The tool set that will own this secret. Accepts the canonical ts_…
form
or the external_id: form.
required: true
schema:
example: toolset_01HXKD2E5NQM3T9AYWCFNRMN74
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateToolSetSecretRequest'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ToolSetSecret'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
x-codeSamples:
- lang: JavaScript
source: >-
import Cadenya from '@cadenya/cadenya';
const client = new Cadenya({
apiKey: process.env['CADENYA_API_KEY'], // This is the default and can be omitted
});
const toolSetSecret = await
client.toolSets.secrets.create('toolset_01HXKD2E5NQM3T9AYWCFNRMN74',
{
workspaceId: 'workspace_01HXKD2E5NQM3T9AYWCF133E3Q',
metadata: { name: 'name' },
spec: {},
});
console.log(toolSetSecret.metadata);
- lang: Python
source: |-
import os
from cadenya import Cadenya
client = Cadenya(
api_key=os.environ.get("CADENYA_API_KEY"), # This is the default and can be omitted
)
tool_set_secret = client.tool_sets.secrets.create(
tool_set_id="toolset_01HXKD2E5NQM3T9AYWCFNRMN74",
workspace_id="workspace_01HXKD2E5NQM3T9AYWCF133E3Q",
metadata={
"name": "name"
},
spec={},
)
print(tool_set_secret.metadata)
- lang: Go
source: "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\t\"go.cadenya.com/cadenya-go\"\n\t\"go.cadenya.com/cadenya-go/option\"\n\t\"go.cadenya.com/cadenya-go/shared\"\n)\n\nfunc main() {\n\tclient := cadenya.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\ttoolSetSecret, err := client.ToolSets.Secrets.New(\n\t\tcontext.TODO(),\n\t\t\"toolset_01HXKD2E5NQM3T9AYWCFNRMN74\",\n\t\tcadenya.ToolSetSecretNewParams{\n\t\t\tWorkspaceID: cadenya.String(\"workspace_01HXKD2E5NQM3T9AYWCF133E3Q\"),\n\t\t\tMetadata: shared.CreateResourceMetadataParam{\n\t\t\t\tName: \"name\",\n\t\t\t},\n\t\t\tSpec: cadenya.ToolSetSecretSpecParam{},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", toolSetSecret.Metadata)\n}\n"
- lang: Ruby
source: |-
require "cadenya"
cadenya = Cadenya::Client.new(api_key: "My API Key")
tool_set_secret = cadenya.tool_sets.secrets.create(
"toolset_01HXKD2E5NQM3T9AYWCFNRMN74",
workspace_id: "workspace_01HXKD2E5NQM3T9AYWCF133E3Q",
metadata: {name: "name"},
spec: {}
)
puts(tool_set_secret)
- lang: CLI
source: |-
cadenya tool-sets:secrets create \
--api-key 'My API Key' \
--workspace-id workspace_01HXKD2E5NQM3T9AYWCF133E3Q \
--tool-set-id toolset_01HXKD2E5NQM3T9AYWCFNRMN74 \
--metadata '{name: name}' \
--spec '{}'
components:
schemas:
CreateToolSetSecretRequest:
required:
- metadata
- spec
type: object
properties:
workspaceId:
readOnly: true
example: workspace_01HXKD2E5NQM3T9AYWCF133E3Q
type: string
description: The workspace that owns the tool set.
toolSetId:
readOnly: true
example: toolset_01HXKD2E5NQM3T9AYWCFNRMN74
type: string
description: >-
The tool set that will own this secret. Accepts the canonical ts_…
form
or the external_id: form.
metadata:
$ref: '#/components/schemas/CreateResourceMetadata'
spec:
$ref: '#/components/schemas/ToolSetSecretSpec'
ToolSetSecret:
required:
- metadata
- spec
type: object
properties:
metadata:
$ref: '#/components/schemas/ResourceMetadata'
spec:
$ref: '#/components/schemas/ToolSetSecretSpec'
info:
readOnly: true
allOf:
- $ref: '#/components/schemas/ToolSetSecretInfo'
description: Tool set secret information
Status:
type: object
properties:
code:
type: integer
description: >-
The status code, which should be an enum value of
[google.rpc.Code][google.rpc.Code].
format: int32
message:
type: string
description: >-
A developer-facing error message, which should be in English. Any
user-facing error message should be localized and sent in the
[google.rpc.Status.details][google.rpc.Status.details] field, or
localized by the client.
details:
type: array
items:
$ref: '#/components/schemas/GoogleProtobufAny'
description: >-
A list of messages that carry the error details. There is a common
set of message types for APIs to use.
description: >-
The `Status` type defines a logical error model that is suitable for
different programming environments, including REST APIs and RPC APIs. It
is used by [gRPC](https://github.com/grpc). Each `Status` message
contains three pieces of data: error code, error message, and error
details. You can find out more about this error model and how to work
with it in the [API Design
Guide](https://cloud.google.com/apis/design/errors).
CreateResourceMetadata:
required:
- name
type: object
properties:
name:
type: string
description: >-
Human-readable name for the resource (e.g., "Customer Support
Agent", "Email Tool")
externalId:
type: string
description: >-
External ID for the resource (e.g., a workflow ID from an external
system)
labels:
type: object
additionalProperties:
type: string
description: |-
Key-value pairs for categorization and filtering. Values are 0-63
alphanumeric characters with "-", "_", or "." allowed between; keys
follow the same shape and additionally accept an optional DNS-subdomain
prefix (e.g. "cadenya.com/") of at most 253 characters.
Examples: {"environment": "production", "team": "platform", "version": "v2"}
description: |-
CreateResourceMetadata contains the user-provided fields for creating
a workspace-scoped resource. Read-only fields (id, account_id, workspace_id, profile_id,
created_at) are excluded since they are set by the server.
ToolSetSecretSpec:
type: object
properties:
value:
type: string
ResourceMetadata:
required:
- id
- accountId
- workspaceId
- name
- profileId
- createdAt
type: object
properties:
id:
readOnly: true
type: string
description: >-
Unique identifier for the resource (prefixed ULID, e.g.,
"agent_01HXK...")
accountId:
readOnly: true
example: account_01HXKD2E5NQM3T9AYWCFTJHJVF
type: string
description: >-
Account this resource belongs to for multi-tenant isolation
(prefixed ULID)
workspaceId:
readOnly: true
example: workspace_01HXKD2E5NQM3T9AYWCF133E3Q
type: string
description: >-
Workspace this resource belongs to for organizational grouping
(prefixed ULID)
name:
type: string
description: >-
Human-readable name for the resource (e.g., "Customer Support
Agent", "Email Tool")
Required for resources that users interact with directly
externalId:
type: string
description: >-
External ID for the resource (e.g., a workflow ID from an external
system)
labels:
type: object
additionalProperties:
type: string
description: |-
Key-value pairs for categorization and filtering. Values are 0-63
alphanumeric characters with "-", "_", or "." allowed between; keys
follow the same shape and additionally accept an optional DNS-subdomain
prefix (e.g. "cadenya.com/") of at most 253 characters.
Examples: {"environment": "production", "team": "platform", "version": "v2"}
profileId:
readOnly: true
example: profile_01HXKD2E5NQM3T9AYWCFS0AP08
type: string
description: ID of the actor (user or service account) that created this resource
createdAt:
readOnly: true
type: string
description: Timestamp when this resource was created
format: date-time
updatedAt:
readOnly: true
type: string
description: Timestamp when this resource was last updated
format: date-time
description: >-
Standard metadata for persistent, named resources (e.g., agents, tools,
prompts)
ToolSetSecretInfo:
type: object
properties:
lastUsedAt:
readOnly: true
type: string
format: date-time
createdBy:
$ref: '#/components/schemas/Profile'
GoogleProtobufAny:
type: object
properties:
'@type':
type: string
description: The type of the serialized message.
additionalProperties: true
description: >-
Contains an arbitrary serialized message along with a @type that
describes the type of the serialized message.
Profile:
required:
- metadata
- spec
type: object
properties:
metadata:
$ref: '#/components/schemas/AccountResourceMetadata'
spec:
$ref: '#/components/schemas/ProfileSpec'
description: |-
A profile identifies a user or non-human principal (such as an API key)
at the account level. Profiles are account-scoped and can be granted access
to multiple workspaces.
AccountResourceMetadata:
required:
- id
- accountId
- name
- profileId
type: object
properties:
id:
readOnly: true
type: string
description: >-
Unique identifier for the resource (prefixed ULID, e.g.,
"apikey_01HXK...")
accountId:
readOnly: true
example: account_01HXKD2E5NQM3T9AYWCFTJHJVF
type: string
description: >-
Account this resource belongs to for multi-tenant isolation
(prefixed ULID)
name:
type: string
description: >-
Human-readable name for the resource (e.g., "Customer Support
Agent", "Email Tool")
Required for resources that users interact with directly
externalId:
type: string
description: >-
External ID for the resource (e.g., a workflow ID from an external
system)
labels:
type: object
additionalProperties:
type: string
description: |-
Key-value pairs for categorization and filtering. Values are 0-63
alphanumeric characters with "-", "_", or "." allowed between; keys
follow the same shape and additionally accept an optional DNS-subdomain
prefix (e.g. "cadenya.com/") of at most 253 characters.
Examples: {"environment": "production", "team": "platform", "version": "v2"}
profileId:
readOnly: true
example: profile_01HXKD2E5NQM3T9AYWCFS0AP08
type: string
createdAt:
readOnly: true
type: string
format: date-time
description: >-
AccountResourceMetadata is used to represent a resource that is
associated to an account but not to a workspace.
ProfileSpec:
required:
- type
type: object
properties:
email:
type: string
description: >-
Email address of the profile. Required and unique within an account
for
user profiles.
name:
type: string
description: Display name (e.g., "Bobby Tables").
type:
enum:
- PROFILE_TYPE_UNSPECIFIED
- PROFILE_TYPE_USER
- PROFILE_TYPE_API_KEY
- PROFILE_TYPE_SYSTEM
type: string
description: >-
Whether this profile represents a human user, an API key, or a
system
principal.
format: enum
description: Configuration for a profile.
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
````