FruxonDocs
IntegrationsTools

Tests a tool execution with the provided parameters.

Runs a tool in test mode to validate its configuration and inputs before using it in agent workflows.

POST
/v1/tenants/{tenant}/integrations/{integration}/tools:test
AuthorizationBearer <token>

JWT Authorization header using the Bearer scheme. Enter 'Bearer' [space] and then your token.

In: header

Path Parameters

tenant*string

The tenant identifier

integration*string

The integration identifier

The tool test configuration and input parameters.

descriptor?
parametersMetadata?|null
parameters?|null
configMetadata?

Represents the metadata for configuration of an integration.

config?

A concrete, usable configuration of an integration — the connection parameters plus auth credentials a tool runs against. An agent revision references these by id from its tool steps.

[key: string]?never

Response Body

curl -X POST "https://api.fruxon.com/v1/tenants/string/integrations/string/tools:test" \  -H "Content-Type: application/json" \  -d '{}'
{
  "response": "string"
}
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": null,
  "property2": null
}
Empty
Empty
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": null,
  "property2": null
}
Empty