Back to Home

API Reference

Integrate AI automation into your applications with our powerful REST API. Build custom solutions and automate complex workflows programmatically.

Quick Start

1. Get Your API Key

Generate your API key from the dashboard to authenticate your requests.

hla_test_sk_1234567890abcdef
Get API Key

2. Make Your First Request

Use your API key to authenticate requests to our endpoints.

curl -X GET "https://api.humanloop.com.au/v1/agents" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

Base URL

https://api.humanloop.com.au/v1

Authentication

Authorization: Bearer YOUR_API_KEY

API Endpoints

GET/api/v1/agents

Retrieve all AI agents in your account

Response

{
  "status": 200,
  "data": [
    {
      "id": "agent_123",
      "name": "Customer Support Agent",
      "type": "conversational",
      "status": "active",
      "created_at": "2024-12-01T10:00:00Z"
    }
  ]
}
POST/api/v1/agents

Create a new AI agent

Request Body

{
  "name": "Lead Qualification Agent",
  "type": "automation",
  "config": {
    "model": "gpt-4",
    "temperature": 0.7
  }
}

Response

{
  "status": 201,
  "data": {
    "id": "agent_124",
    "name": "Lead Qualification Agent",
    "status": "created"
  }
}
GET/api/v1/workflows

List all automation workflows

Response

{
  "status": 200,
  "data": [
    {
      "id": "workflow_456",
      "name": "Email Nurture Campaign",
      "status": "running",
      "triggers": 2,
      "actions": 5
    }
  ]
}
POST/api/v1/workflows/trigger

Manually trigger a workflow execution

Request Body

{
  "workflow_id": "workflow_456",
  "data": {
    "email": "customer@example.com",
    "source": "website"
  }
}

Response

{
  "status": 200,
  "data": {
    "execution_id": "exec_789",
    "status": "queued"
  }
}

Official SDKs

JavaScript

Full-featured SDK for Node.js and browser environments

npm install @humanloop-au/sdk
DocsGitHub

Python

Comprehensive Python library with async support

pip install humanloop-au
DocsGitHub

PHP

Easy-to-use PHP library for web applications

composer require humanloop-au/php-sdk
DocsGitHub

Go

High-performance Go module for concurrent applications

go get github.com/humanloop-au/go-sdk
DocsGitHub

Rate Limits & Usage

Basic Plan

1,000
requests/hour

Professional Plan

10,000
requests/hour

Enterprise Plan

Unlimited
custom limits

Need Help with the API?

Our developer support team is here to help you integrate our API and build amazing automation solutions.

Contact Developer SupportBrowse Documentation