Version: v5.0

Platform API Tools

AI agents can avail of a range of tools in the Platform API. These tools wrap platform API read calls so that the agents can use them.

The tools available are:

IafItemSvc

The following API tools are available for the IafItemSvc:

Schema and SchemaDefinition
- DownloadMetaSchemaTool
- GetSchemaDefinitionsTool
NamedUserItem
- GetNamedUserItemsTool
- GetNamedUserItemTool
- GetNamedUserItemVersionsTool
- GetNamedUserItemVersionTool
- GetAllNamedUserItemsTool
- GetItemPermissionsTool
- GetRelatedInItemTool
RelatedItem
- GetRelatedItemsTool
- GetRelatedItemTool
- GetRelatedItemUpdateLogsTool
- GetRelatedReadingItemsTool
- SearchRelatedItemsTool
Reading
- AggregateReadingsTool
Script
- GetScriptContentUrlByCriteriaTool
- GetScriptContentUrlTool
Telemetry
- GetTelemetryConfigsTool
- GetTelemetryConfigTool
- GetTelemetryProcessingErrorsTool
Relations
- GetInverseRelationsTool
- GetRelationsTool
Other
- GetIndexesTool
- GetUpdateLogsTool

The following API tools are available for the IafPassSvc:

Permission profile
- GetAllPermissionProfilesTool
User
- GetCurrentUserTool
- GetUserByIdTool
- GetUserGroupsTool
- GetUserGroupTool
- GetUsersInGroupTool
Permission
- GetPermissionByIdTool
- GetPermissionProfilesTool
- GetPermissionsTool
Workspace
- GetWorkspacesTool
- GetWorkspaceTool

The following API tools are available for the IafFileSvc:

File
- GetAllFilesInTreeTool
- GetFileInfoWithUploadMetaTool
- GetFilePermissionsTool
- GetFilePreviewUrlTool
- GetFilesTool
- GetFileTool
- GetFileUrlTool
File Version
- GetFileVersionPreviewUrlTool
- GetFileVersionsTool
- GetFileVersionTool
- GetFileVersionUrlTool