Toolboxes

Retrieve a toolbox

GET /toolboxes/{name}

Retrieves the specified toolbox and its current configuration.

Paramètres de chemin d’accès

name string obligatoire

The name of the toolbox to retrieve.

Paramètres de la requête

api-version string obligatoire

The API version to use for this operation.

Réponses

The request has succeeded.

Corps

Content-Type: application/json

id string obligatoire

The unique identifier of the toolbox.

name string obligatoire

The name of the toolbox.

updated_at integer obligatoire

versions ToolboxVersions obligatoire

The versions associated with a toolbox.

latest ToolboxVersionObject obligatoire

A specific version of a toolbox.

metadata object | null obligatoire

Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters.

[key: string] string

id string obligatoire

The unique identifier of the toolbox version.

name string obligatoire

The name of the toolbox.

version string obligatoire

The version identifier of the toolbox. Toolbox versions are immutable and every update creates a new version.

description string

A human-readable description of the toolbox.

created_at integer obligatoire

The Unix timestamp (seconds) when the toolbox version was created.

tools ToolboxTool[] obligatoire

The list of tools contained in this toolbox version.

skills ToolboxSkill[]

The list of skill sources included in this toolbox version.

policies ToolboxPolicies

Policy configuration for a toolbox, including content safety and other governance settings.

rai_config RaiConfig

Configuration for Responsible AI (RAI) content filtering and safety features.

rai_policy_name string obligatoire

The name of the RAI policy to apply.

invocations_moderation RaiInvocationModeration

Declares where request/response text lives so content-safety guardrails can extract it.

input_content_type string | enum

How an invocations request/response body is parsed to locate text for content-safety moderation.

Un des éléments suivants :

string

enum

jsontext

output_content_type string | enum

How an invocations request/response body is parsed to locate text for content-safety moderation.

Un des éléments suivants :

string

enum

jsontext

response_mode string | enum obligatoire

Author-declared response shape for the invocations protocol.

Un des éléments suivants :

string

enum

non_streamingstreamingboth

input_paths string[]

Path(s) to user text in the REQUEST body. Required when input_content_type is json.

output_paths string[]

Path(s) to agent text in a NON-STREAMING response body. Required when response_mode is non_streaming/both and output_content_type is json.

stream_selectors RaiSseTextSelector[]

One SSE event->field selector per event type carrying text. Required when response_mode is streaming/both and output_content_type is json.

default_version string obligatoire

The version identifier that the toolbox currently points to. Defaults to the latest version. Can be changed via updateToolbox.

Requête

GET /toolboxes/{name} HTTP/1.1

Response

Status: 200
Content-Type: application/json

Status: 4XX
Content-Type: application/json

Status: 5XX
Content-Type: application/json