Skip to main content

Purpose

The Admin API provides programmatic access to manage tools and providers in HandsAI. These endpoints allow you to:
  • Manage Tools: Create, update, retrieve, and delete API tool definitions
  • Manage Providers: Configure external API providers with authentication settings
  • Validate Health: Check tool endpoint availability
  • View Analytics: Track execution metrics and logs for monitoring and debugging
The Admin API is designed for transactional, one-by-one operations through the UI or external integrations.
For bulk operations, use the Import/Export API which handles batch processing of tools and providers.

Base Paths

  • Tools: /admin/tools/api
  • Providers: /admin/providers
  • Analytics: /admin/analytics

Authentication

All Admin API endpoints require authentication. Include your credentials in the request headers:
curl -X GET "http://localhost:8080/admin/tools/api" \
  -H "Authorization: Bearer YOUR_TOKEN"
Authentication implementation details depend on your HandsAI deployment configuration.

CRUD Operations Overview

Tools Management

OperationMethodEndpoint
List all toolsGET/admin/tools/api
Get tool by IDGET/admin/tools/api/{id}
Create toolPOST/admin/tools/api
Update toolPUT/admin/tools/api/{id}
Delete toolDELETE/admin/tools/api/{id}
Validate healthPOST/admin/tools/api/{id}/validate
Create batchPOST/admin/tools/api/batch

Providers Management

OperationMethodEndpoint
List all providersGET/admin/providers
Get provider by IDGET/admin/providers/{id}
Create providerPOST/admin/providers
Update providerPUT/admin/providers/{id}
Delete providerDELETE/admin/providers/{id}

Analytics & Monitoring

OperationMethodEndpoint
Get summary metricsGET/admin/analytics/summary
Get execution logsGET/admin/analytics/logs

Next Steps

Tool Management

Manage API tool definitions and configurations

Provider Management

Configure external API providers and authentication

Analytics & Logs

View execution metrics and troubleshoot issues

Build docs developers (and LLMs) love