Skip to main content
GET
/
agent-tasks
/
tool-output-schema
/
{graphNodeId}
Get Tool Output Schema
curl --request GET \
  --url https://api.beamstudio.ai/agent-tasks/tool-output-schema/{graphNodeId} \
  --header 'Authorization: Bearer <token>' \
  --header 'current-workspace-id: <current-workspace-id>'
[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "paramName": "email_id",
    "agentToolConfigurationId": "123e4567-e89b-12d3-a456-426614174000",
    "dataType": "string",
    "isArray": false,
    "typeOptions": {
      "enumValues": [
        "a",
        "b",
        "c"
      ]
    },
    "createdAt": "2024-01-15T10:30:00Z",
    "updatedAt": "2024-01-20T15:45:00Z",
    "position": 1,
    "paramDescription": "The unique identifier of the sent email message",
    "parentId": "123e4567-e89b-12d3-a456-426614174001",
    "paramPath": "response.data.email_id",
    "outputExample": "msg_abc123xyz"
  }
]

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
current-workspace-id
string
required

Path Parameters

​
graphNodeId
string
required

The unique identifier of the graph node to retrieve tool output schema for

Example:

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

Response

200 - application/json

Tool output schema retrieved successfully

​
id
string
required

The unique identifier for this output parameter configuration

Example:

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

​
paramName
string | null
required

The name of the output parameter as defined in the tool response schema

Example:

"email_id"

​
agentToolConfigurationId
string
required

The unique identifier of the agent tool configuration this output parameter belongs to

Example:

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

​
dataType
enum<string> | null
required

The data type of this output parameter (e.g., string, number, boolean, object, array)

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

"string"

​
isArray
boolean
default:false
required

Indicates whether this output parameter is an array of values rather than a single value

Example:

false

​
typeOptions
object
required

Additional type-specific configuration options for this output parameter (e.g., validation rules, formatting options)

Example:
{ "enumValues": ["a", "b", "c"] }
​
createdAt
string<date-time>
required

Timestamp when this output parameter configuration was created

Example:

"2024-01-15T10:30:00Z"

​
updatedAt
string<date-time>
required

Timestamp when this output parameter configuration was last updated

Example:

"2024-01-20T15:45:00Z"

​
position
number | null

The position or order of this parameter in the tool output structure

Example:

1

​
paramDescription
string | null

A human-readable description of what this output parameter represents and how it should be used

Example:

"The unique identifier of the sent email message"

​
parentId
string | null

The unique identifier of the parent parameter if this is a nested output parameter (for object or array types)

Example:

"123e4567-e89b-12d3-a456-426614174001"

​
paramPath
string | null

The dot-notation path to this parameter in the tool output structure (e.g., "response.data.email_id")

Example:

"response.data.email_id"

​
outputExample
string | null

An example value for this output parameter to illustrate the expected format and content

Example:

"msg_abc123xyz"