Skip to main content
GET
/
api
/
v1
/
agent
/
{agentId}
/
input-parameters
Get input parameters for an agent
curl --request GET \
  --url https://api.example.com/api/v1/agent/{agentId}/input-parameters \
  --header 'Authorization: Bearer <token>'
[
  {
    "name": "<string>",
    "defaultValue": "<string>",
    "isEncrypted": true
  }
]

Authorizations

​
Authorization
string
header
required

API Key authorization header. Example: "Authorization: ApiKey {your-api-key}"

​
Authorization
string
header
required

OAuth 2.0 Bearer token. Example: "Authorization: Bearer {access-token}"

Path Parameters

​
agentId
integer<int32>
required

The ID of the agent

Response

Returns the list of input parameters

​
name
string | null

The parameter name to use when starting a run via the inputParameters field.

​
defaultValue
string | null

The default value for this parameter, or null if the parameter is encrypted. Encrypted parameter values are never exposed through the API.

​
isEncrypted
boolean

True if this parameter is stored encrypted at rest. When starting a run, callers can send plain text values for encrypted parameters and the server will encrypt them automatically.