API Reference

Authentication

All requests to the AgentForest API must be authenticated using your unique Platform API Key. You can find and manage your API key in your Account Settings.

Include your API key in the Authorization header of your requests:

Authorization: Bearer YOUR_PLATFORM_API_KEY

Agent Execution API

Trigger your deployed agent workers via a POST request to their unique endpoint.

Endpoint Structure

POST /api/v1/run/{projectId}/{agentSlug}

• {projectId}: The ID of the project containing the agent worker.
• {agentSlug}: The unique slug you assigned to the agent worker when exposing it as an API.

Request Body

The request body should be a JSON object containing an inputs field, which itself is an object of key-value pairs corresponding to the inputs defined in your agent worker's configuration schema.

{
  "inputs": {
    "your_input_key_1": "value1",
    "your_input_key_2": 123
  }
}

Example cURL

curl -X POST \
  https://your-app-domain.agentforest.one/api/v1/run/YOUR_PROJECT_ID/YOUR_AGENT_SLUG \
  -H "Authorization: Bearer YOUR_PLATFORM_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "inputs": {
      "query": "What is the weather like in London?"
    }
  }'

Find specific endpoint URLs and input schemas for your exposed agents in the "API Endpoints" section of your project dashboard. (Go to Dashboard)

Platform Management API (Coming Soon)

We are working on a comprehensive Management API that will allow you to programmatically manage your projects, agent workers, configurations, and more. Stay tuned for updates!