Get a tool set secret

JavaScript

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.retrieve(
  'toolset_01HXKD2E5NQM3T9AYWCFNRMN74',
  'toolsecret_01HXKD2E5NQM3T9AYWCF8PWC4R',
  { workspaceId: 'workspace_01HXKD2E5NQM3T9AYWCF133E3Q' },
);

console.log(toolSetSecret.metadata);

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.retrieve(
    tool_set_id="toolset_01HXKD2E5NQM3T9AYWCFNRMN74",
    id="toolsecret_01HXKD2E5NQM3T9AYWCF8PWC4R",
    workspace_id="workspace_01HXKD2E5NQM3T9AYWCF133E3Q",
)
print(tool_set_secret.metadata)

package main

import (
	"context"
	"fmt"
	"go.cadenya.com/cadenya-go"
	"go.cadenya.com/cadenya-go/option"
)

func main() {
	client := cadenya.NewClient(
		option.WithAPIKey("My API Key"),
	)
	toolSetSecret, err := client.ToolSets.Secrets.Get(
		context.TODO(),
		"toolset_01HXKD2E5NQM3T9AYWCFNRMN74",
		"toolsecret_01HXKD2E5NQM3T9AYWCF8PWC4R",
		cadenya.ToolSetSecretGetParams{
			WorkspaceID: cadenya.String("workspace_01HXKD2E5NQM3T9AYWCF133E3Q"),
		},
	)
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", toolSetSecret.Metadata)
}

require "cadenya"

cadenya = Cadenya::Client.new(api_key: "My API Key")

tool_set_secret = cadenya.tool_sets.secrets.retrieve(
  "toolset_01HXKD2E5NQM3T9AYWCFNRMN74",
  "toolsecret_01HXKD2E5NQM3T9AYWCF8PWC4R",
  workspace_id: "workspace_01HXKD2E5NQM3T9AYWCF133E3Q"
)

puts(tool_set_secret)

cadenya tool-sets:secrets retrieve \
  --api-key 'My API Key' \
  --workspace-id workspace_01HXKD2E5NQM3T9AYWCF133E3Q \
  --tool-set-id toolset_01HXKD2E5NQM3T9AYWCFNRMN74 \
  --id toolsecret_01HXKD2E5NQM3T9AYWCF8PWC4R

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.cadenya.com/v1/workspaces/{workspaceId}/tool_sets/{toolSetId}/secrets/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "metadata": {
    "id": "<string>",
    "accountId": "account_01HXKD2E5NQM3T9AYWCFTJHJVF",
    "workspaceId": "workspace_01HXKD2E5NQM3T9AYWCF133E3Q",
    "name": "<string>",
    "profileId": "profile_01HXKD2E5NQM3T9AYWCFS0AP08",
    "createdAt": "2023-11-07T05:31:56Z",
    "externalId": "<string>",
    "labels": {},
    "updatedAt": "2023-11-07T05:31:56Z"
  },
  "spec": {
    "value": "<string>"
  },
  "info": {
    "lastUsedAt": "2023-11-07T05:31:56Z",
    "createdBy": {
      "metadata": {
        "id": "<string>",
        "accountId": "account_01HXKD2E5NQM3T9AYWCFTJHJVF",
        "name": "<string>",
        "profileId": "profile_01HXKD2E5NQM3T9AYWCFS0AP08",
        "externalId": "<string>",
        "labels": {},
        "createdAt": "2023-11-07T05:31:56Z"
      },
      "spec": {
        "email": "<string>",
        "name": "<string>"
      }
    }
  }
}

{
  "code": 123,
  "message": "<string>",
  "details": [
    {
      "@type": "<string>"
    }
  ]
}

GET

workspaces

{workspaceId}

tool_sets

{toolSetId}

secrets

{id}

JavaScript

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.retrieve(
  'toolset_01HXKD2E5NQM3T9AYWCFNRMN74',
  'toolsecret_01HXKD2E5NQM3T9AYWCF8PWC4R',
  { workspaceId: 'workspace_01HXKD2E5NQM3T9AYWCF133E3Q' },
);

console.log(toolSetSecret.metadata);

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.retrieve(
    tool_set_id="toolset_01HXKD2E5NQM3T9AYWCFNRMN74",
    id="toolsecret_01HXKD2E5NQM3T9AYWCF8PWC4R",
    workspace_id="workspace_01HXKD2E5NQM3T9AYWCF133E3Q",
)
print(tool_set_secret.metadata)

package main

import (
	"context"
	"fmt"
	"go.cadenya.com/cadenya-go"
	"go.cadenya.com/cadenya-go/option"
)

func main() {
	client := cadenya.NewClient(
		option.WithAPIKey("My API Key"),
	)
	toolSetSecret, err := client.ToolSets.Secrets.Get(
		context.TODO(),
		"toolset_01HXKD2E5NQM3T9AYWCFNRMN74",
		"toolsecret_01HXKD2E5NQM3T9AYWCF8PWC4R",
		cadenya.ToolSetSecretGetParams{
			WorkspaceID: cadenya.String("workspace_01HXKD2E5NQM3T9AYWCF133E3Q"),
		},
	)
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", toolSetSecret.Metadata)
}

require "cadenya"

cadenya = Cadenya::Client.new(api_key: "My API Key")

tool_set_secret = cadenya.tool_sets.secrets.retrieve(
  "toolset_01HXKD2E5NQM3T9AYWCFNRMN74",
  "toolsecret_01HXKD2E5NQM3T9AYWCF8PWC4R",
  workspace_id: "workspace_01HXKD2E5NQM3T9AYWCF133E3Q"
)

puts(tool_set_secret)

cadenya tool-sets:secrets retrieve \
  --api-key 'My API Key' \
  --workspace-id workspace_01HXKD2E5NQM3T9AYWCF133E3Q \
  --tool-set-id toolset_01HXKD2E5NQM3T9AYWCFNRMN74 \
  --id toolsecret_01HXKD2E5NQM3T9AYWCF8PWC4R

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.cadenya.com/v1/workspaces/{workspaceId}/tool_sets/{toolSetId}/secrets/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "metadata": {
    "id": "<string>",
    "accountId": "account_01HXKD2E5NQM3T9AYWCFTJHJVF",
    "workspaceId": "workspace_01HXKD2E5NQM3T9AYWCF133E3Q",
    "name": "<string>",
    "profileId": "profile_01HXKD2E5NQM3T9AYWCFS0AP08",
    "createdAt": "2023-11-07T05:31:56Z",
    "externalId": "<string>",
    "labels": {},
    "updatedAt": "2023-11-07T05:31:56Z"
  },
  "spec": {
    "value": "<string>"
  },
  "info": {
    "lastUsedAt": "2023-11-07T05:31:56Z",
    "createdBy": {
      "metadata": {
        "id": "<string>",
        "accountId": "account_01HXKD2E5NQM3T9AYWCFTJHJVF",
        "name": "<string>",
        "profileId": "profile_01HXKD2E5NQM3T9AYWCFS0AP08",
        "externalId": "<string>",
        "labels": {},
        "createdAt": "2023-11-07T05:31:56Z"
      },
      "spec": {
        "email": "<string>",
        "name": "<string>"
      }
    }
  }
}

{
  "code": 123,
  "message": "<string>",
  "details": [
    {
      "@type": "<string>"
    }
  ]
}

Read one tool set secret, a secret scoped to a single tool set. You get its name and usage, never its value.

const secret = await client.toolSets.secrets.retrieve(toolSetId, secretId, { workspaceId });

console.log(secret.metadata.name);  // 'ORDERS_TOKEN'
console.log(secret.spec.value);     // '': write-only, always redacted

secret, err := client.ToolSets.Secrets.Get(ctx, toolSetID, secretID,
	cadenya.ToolSetSecretGetParams{WorkspaceID: cadenya.String(workspaceID)})
if err != nil {
	panic(err.Error())
}

fmt.Println(secret.Metadata.Name) // ORDERS_TOKEN
fmt.Println(secret.Spec.Value)    // "": write-only, always redacted

secret = cadenya.tool_sets.secrets.retrieve(secret_id, tool_set_id: tool_set_id, workspace_id: workspace_id)

puts(secret.metadata.name)  # ORDERS_TOKEN
puts(secret.spec.value)     # "": write-only, always redacted

curl "https://api.cadenya.com/v1/workspaces/${WORKSPACE_ID}/tool_sets/${TOOL_SET_ID}/secrets/${SECRET_ID}" \
  -H "Authorization: Bearer ${CADENYA_API_KEY}"

The toolsecret_... shape and the redacted value work exactly like a workspace secret; the difference is reach.

Scoped to one tool set, and it wins over workspace

A tool set secret is visible only to the tools in its own tool set, and it sits in the middle of the three-scope precedence: an objective secret beats it, and it beats a workspace secret of the same name. So a ${ORDERS_TOKEN} that this tool set should resolve differently from the rest of the workspace goes here. Confirm which scope a call used through resolvedSecrets on the tool call, where the source reads RESOLVED_SECRET_SOURCE_TOOLSET. Like the name, the external ID is normalized (hyphens and spaces to underscores), so externalId: "orders-tok" resolves as external_id:orders_tok.

Create a tool set secret

Add one, scoped to the tool set.

List tool set secrets

Every secret on this tool set.

Store and use secrets

The three scopes and how ${NAME} resolves.

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

workspaceId

string

required

The workspace that owns the tool set.

Example:

"workspace_01HXKD2E5NQM3T9AYWCF133E3Q"

toolSetId

string

required

The tool set the secret belongs to. Accepts the canonical ts_… form or the external_id: form.

Example:

"toolset_01HXKD2E5NQM3T9AYWCFNRMN74"

string

required

The secret to retrieve.

Example:

"toolsecret_01HXKD2E5NQM3T9AYWCF8PWC4R"

Response

metadata

object

required

Standard metadata for persistent, named resources (e.g., agents, tools, prompts)

Show child attributes

spec

object

required

Show child attributes

info

object

Tool set secret information

Show child attributes

​Scoped to one tool set, and it wins over workspace

​Related

Create a tool set secret

List tool set secrets

Store and use secrets

Authorizations

Path Parameters

Response

Scoped to one tool set, and it wins over workspace

Related