Skip to main content
GET
Get Tool Output Schema

Authorizations

x-api-key
string
header
required

Headers

current-workspace-id
string
required

Path Parameters

graphNodeId
string
required

Response

200 - application/json

Tool output schema retrieved successfully

id
string
required

Unique identifier for the output parameter.

Example:

"param-123e4567-e89b-12d3-a456-426614174000"

agentToolConfigurationId
string
required

UUID of the parent tool configuration.

Example:

"config-123e4567-e89b-12d3-a456-426614174000"

isArray
boolean
default:false
required

Whether this parameter returns an array of values.

Example:

false

createdAt
string<date-time>
required

Timestamp when the parameter was created.

updatedAt
string<date-time>
required

Timestamp when the parameter was last updated.

paramName
string

Name of the output parameter.

Example:

"customerData"

position
number

Position/order of the parameter in the output list.

Example:

1

paramDescription
string

Human-readable description of what this output parameter represents.

Example:

"The customer data retrieved from the database."

parentId
string

UUID of the parent parameter for nested structures.

paramPath
string

JSON path to this parameter in the output structure.

Example:

"response.data.customer"

outputExample
string

Example value demonstrating the expected output format.

Example:

"{\"name\": \"John Doe\", \"email\": \"john@example.com\"}"

dataType
enum<string> | null

Data type of the output parameter.

Available options:
string,
number,
boolean,
object,
enum
Example:

"string"

typeOptions
object | null

Additional type-specific configuration options.