API Reference

Overview

The Fetchply API lets you programmatically manage agents, send messages, retrieve conversations and leads, manage knowledge sources, and subscribe to webhook events.

Authentication

All API requests require a Bearer token in the Authorization header:

curl -X GET https://fetchply.com/api/v1/agents \
  -H "Authorization: Bearer fp_your_api_key"

const response = await fetch('https://fetchply.com/api/v1/agents', {
  headers: {
    'Authorization': 'Bearer fp_your_api_key',
  },
});
const data = await response.json();

import requests

response = requests.get(
    'https://fetchply.com/api/v1/agents',
    headers={'Authorization': 'Bearer fp_your_api_key'}
)
data = response.json()

API keys use the fp_ prefix. Keep your keys secret — never expose them in client-side code.

Base URL

https://fetchply.com/api/v1

Rate Limits

API requests are rate-limited to 60 requests per 60 seconds per API key.

When you exceed the limit, you'll receive a 429 Too Many Requests response with a Retry-After header indicating how many seconds to wait.

Response Format

All responses follow a consistent JSON format:

{
  "success": true,
  "data": { ... }
}

{
  "success": false,
  "error": "Human-readable error message"
}

Error Codes

Endpoints

Agents

Messages

Conversations

Leads

Knowledge

Webhooks

Quick Start

curl https://fetchply.com/api/v1/agents \
  -H "Authorization: Bearer fp_your_api_key"

curl -X POST https://fetchply.com/api/v1/agents/YOUR_AGENT_ID/messages \
  -H "Authorization: Bearer fp_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{"message": "What is your return policy?"}'

Related Documentation