Toolboxes
Retrieve a toolbox
Retrieves the specified toolbox and its current configuration.
Parametry cesty
name
string
vyžadováno
The name of the toolbox to retrieve.
Parametry dotazů
api-version
string
vyžadováno
The API version to use for this operation.
Odpovědi
The request has succeeded.
Text
id
string
vyžadováno
The unique identifier of the toolbox.
name
string
vyžadováno
The name of the toolbox.
versions
ToolboxVersions
vyžadováno
The versions associated with a toolbox.
latest
ToolboxVersionObject
vyžadováno
A specific version of a toolbox.
metadata
object | null
vyžadováno
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.
id
string
vyžadováno
The unique identifier of the toolbox version.
name
string
vyžadováno
The name of the toolbox.
version
string
vyžadováno
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
vyžadováno
The Unix timestamp (seconds) when the toolbox version was created.
tools
ToolboxTool[]
vyžadováno
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
vyžadováno
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.
enum
output_content_type
string | enum
How an invocations request/response body is parsed to locate text for content-safety moderation.
enum
response_mode
string | enum
vyžadováno
Author-declared response shape for the invocations protocol.
enum
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
vyžadováno
The version identifier that the toolbox currently points to. Defaults to the latest version. Can be changed via updateToolbox.
Žádost
GET /toolboxes/{name} HTTP/1.1Response
Status: 200
Content-Type: application/jsonStatus: 4XX
Content-Type: application/jsonStatus: 5XX
Content-Type: application/json