Skip to main content
POST
/
api
/
v1
/
secrets
New Secret
curl --request POST \
  --url https://api.intelligence.io.solutions/api/v1/secrets/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "secret_name": "<string>",
  "secret_value": "<string>",
  "tool_name": "<string>",
  "tool_arg": "<string>",
  "is_default_for_tool": true
}
'
{
  "secret_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "secret_name": "<string>",
  "display": "<string>",
  "tool_name": "<string>",
  "tool_arg": "<string>",
  "is_default_for_tool": true,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}
This endpoint allows you to securely store a secret, associate it with a specific tool and argument, and optionally configure it as a default value when the tool is used without explicit input.
The API supports multiple authentication mechanisms, but only one needs to be provided per request. You may authenticate using any of the following headers, a browser-issued JWT token, an Authorization header, or an x-api-key header (io.net API key).
Once a secret is created, the value provided in the secret_value parameter cannot be retrieved or viewed again through the API. Only metadata about the secret such as its identifier, associated tool, and configuration can be viewed.
The system imposes an overall implementation-specific limit on the total size of stored secrets. If a request attempts to store a secret, or a combination of secrets, that exceeds this limit, the API will return an HTTP 413 (Payload Too Large) error.

​
Request body parameters:

secret_name – A user-defined identifier for the secret. This value is used to reference and manage the secret in subsequent operations. secret_value – The confidential value associated with the secret. This value is securely stored and made available to the designated tool when access is authorized. tool_name – The name of the single tool that is granted access to this secret. This field accepts only one tool identifier, not an array or list. tool_arg – The specific argument of the tool that this secret applies to. is_default_for_tool – A boolean flag specifying whether this secret should be automatically applied when the associated tool does not receive a value for the argument. This field is optional when using secrets in workflow YAML configurations, but required when defining secrets for built-in agents.

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

​
token
string

JWT token

​
Authorization
string

io.net provided API Key

​
x-api-key
string

API key set by an SDK client

Body

application/json
​
secret_name
string
required
Required string length: 1 - 1024
​
secret_value
string
required
Required string length: 4 - 1024
​
tool_name
string | null
Required string length: 1 - 1024
​
tool_arg
string | null
Required string length: 1 - 1024
​
is_default_for_tool
boolean | null

Response

Successful Response

​
secret_id
string<uuid>
required
​
user_id
string<uuid>
required
​
secret_name
string
required
​
display
string | null
required
​
tool_name
string | null
required
​
tool_arg
string | null
required
​
is_default_for_tool
boolean
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required