Etherpad API API

Overview

Etherpad is a real-time collaborative editor scalable to thousands of simultaneous real time users. It provides full data export capabilities, and runs on your server, under your control.

Etherpad API is a development API from etherpad.local. Requests are authenticated with an API key. It is served over HTTPS. Its OpenAPI description documents 96 endpoints.

At a glance

Authentication

API key

HTTPS

Yes

CORS

Unknown

Category

Development

Base URL

http://etherpad.local

Version

1.2.15

Endpoints

96

OpenAPI

Specification ↗

Spec updated

2021-01-07

Make a first request

Replace the placeholders; the documentation says exactly where credentials go.

curl -X GET "http://etherpad.local/appendChatMessage" \
  -H "Accept: application/json" \
  -H "X-API-Key: YOUR_API_KEY"

const response = await fetch("http://etherpad.local/appendChatMessage", {
  method: "GET",
  headers: {
    "Accept": "application/json",
    "X-API-Key": "YOUR_API_KEY",
  },
});
const data = await response.json();
console.log(data);

import requests

response = requests.request(
    "GET",
    "http://etherpad.local/appendChatMessage",
    headers={
    "Accept": "application/json",
    "X-API-Key": "YOUR_API_KEY",
    },
    timeout=30,
)
print(response.json())

Endpoints

Questions