Tools

Operations for the Tools service collection.

Language	Last Update
Python	v1.6.5
PowerShell
Go
TypeScript
Rust
Ruby

Operation	Description
EntitiesToolsV1 `entities_tools_v1`	Retrieve tools entities for the provided id.
QueriesToolsV1 `queries_tools_v1`	Query tools based on the provided filters.

EntitiesToolsV1

Retrieve tools entities for the provided id.

Method GET

Route /agentic-studio/entities/tools/v1

Scope Charlotte AI Agent Definition: READ

PEP 8 entities_tools_v1

Parameters

ids query · string or list of strings

IDs of entities to retrieve.

parameters query · dictionary

Full query string parameters payload in JSON format. Not required when using other keywords.

Code Examples

from falconpy import Tools

falcon = Tools(client_id=CLIENT_ID,
               client_secret=CLIENT_SECRET
               )

id_list = 'ID1,ID2,ID3'  # Can also pass a list here: ['ID1', 'ID2', 'ID3']

response = falcon.entities_tools_v1(ids=id_list)
print(response)

from falconpy import Tools

falcon = Tools(client_id=CLIENT_ID,
               client_secret=CLIENT_SECRET
               )

id_list = 'ID1,ID2,ID3'  # Can also pass a list here: ['ID1', 'ID2', 'ID3']

response = falcon.EntitiesToolsV1(ids=id_list)
print(response)

from falconpy import APIHarnessV2

falcon = APIHarnessV2(client_id=CLIENT_ID,
                      client_secret=CLIENT_SECRET
                      )

id_list = 'ID1,ID2,ID3'  # Can also pass a list here: ['ID1', 'ID2', 'ID3']

response = falcon.command("EntitiesToolsV1",
                          ids=id_list)
print(response)

Responses

[
  {
    "category": "string",
    "description": "string",
    "extended_input_schema": "string",
    "id": "string",
    "input_schema": {},
    "is_deleted": false,
    "is_enabled": false,
    "meta": {},
    "name": "string",
    "output_schema": {},
    "tags": [],
    "title": "string",
    "type": "string"
  }
]

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

QueriesToolsV1

Query tools based on the provided filters.

Method GET

Route /agentic-studio/queries/tools/v1

Scope Charlotte AI Agent Definition: READ

PEP 8 queries_tools_v1

Parameters

offset query · integer

Starting index of overall result set from which to return ids.

limit query · integer

Number of IDs to return. Offset + limit should NOT be above 10K.

sort query · string

Possible order by fields:

Available values (4)

`id`	`name`	`description`
`category`

filter query · string

FQL query specifying the filter parameters.

parameters query · dictionary

Full query string parameters payload in JSON format. Not required when using other keywords.

Code Examples

from falconpy import Tools

falcon = Tools(client_id=CLIENT_ID,
               client_secret=CLIENT_SECRET
               )

response = falcon.queries_tools_v1(offset=integer,
                                   limit=integer,
                                   sort="string",
                                   filter="string")
print(response)

from falconpy import Tools

falcon = Tools(client_id=CLIENT_ID,
               client_secret=CLIENT_SECRET
               )

response = falcon.QueriesToolsV1(offset=integer,
                                 limit=integer,
                                 sort="string",
                                 filter="string")
print(response)

from falconpy import APIHarnessV2

falcon = APIHarnessV2(client_id=CLIENT_ID,
                      client_secret=CLIENT_SECRET
                      )

response = falcon.command("QueriesToolsV1",
                          offset=integer,
                          limit=integer,
                          sort="string",
                          filter="string")
print(response)

Responses

[
  "string"
]

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

Tools

Table of Contents

EntitiesToolsV1

Parameters

QueriesToolsV1

Parameters