Etherpad API

etherpad · Developer Tools

Developer Tools No Auth Free & Open developer_tools

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.

Authentication

No authentication requiredFree to use with no key needed.

Sample Requests

GET appends a chat message

appends a chat message

https://api.apis.guru/v2/specs/etherpad.local/1.2.15/appendChatMessage?text=example&time=example&padID=example&authorID=example

Hover any highlighted part to learn what it does

curl -X GET "https://api.apis.guru/v2/specs/etherpad.local/1.2.15/appendChatMessage?text=example&time=example&padID=example&authorID=example"

import requests
params = {
    "text": "example",
    "time": "example",
    "padID": "example",
    "authorID": "example"
}
response = requests.get(
    "https://api.apis.guru/v2/specs/etherpad.local/1.2.15/appendChatMessage",
    params=params,
)
print(response.json())

const url = new URL('https://api.apis.guru/v2/specs/etherpad.local/1.2.15/appendChatMessage');
url.searchParams.set('text', 'example');
url.searchParams.set('time', 'example');
url.searchParams.set('padID', 'example');
url.searchParams.set('authorID', 'example');

const response = await fetch(url); 
const data = await response.json();
console.log(data);

package main

import (
	"fmt"
	"io"
	"net/http"
	"net/url"
)

func main() {
	baseURL, _ := url.Parse("https://api.apis.guru/v2/specs/etherpad.local/1.2.15/appendChatMessage")
	q := baseURL.Query()
	q.Set("text", "example")
	q.Set("time", "example")
	q.Set("padID", "example")
	q.Set("authorID", "example")
	baseURL.RawQuery = q.Encode()
	targetURL := baseURL.String()
	req, _ := http.NewRequest("GET", targetURL, nil)

	client := &http.Client{}
	resp, _ := client.Do(req)
	defer resp.Body.Close()
	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}

require "net/http"
require "json"

uri = URI("https://api.apis.guru/v2/specs/etherpad.local/1.2.15/appendChatMessage")
uri.query = URI.encode_www_form({
  "text" => "example",
  "time" => "example",
  "padID" => "example",
  "authorID" => "example"
})

http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"

req = Net::HTTP::Get.new(uri)

res = http.request(req)
puts JSON.parse(res.body)

<?php
$url = "https://api.apis.guru/v2/specs/etherpad.local/1.2.15/appendChatMessage?" . http_build_query([
    "text" => "example",
    "time" => "example",
    "padID" => "example",
    "authorID" => "example"
]);
$opts = ["http" => [
    "method" => "GET",
]];
$ctx = stream_context_create($opts);
$res = file_get_contents($url, false, $ctx);
print_r(json_decode($res, true));

GET creates a new author

creates a new author

https://api.apis.guru/v2/specs/etherpad.local/1.2.15/createAuthor?name=test

Hover any highlighted part to learn what it does

curl -X GET "https://api.apis.guru/v2/specs/etherpad.local/1.2.15/createAuthor?name=test"

import requests
params = {
    "name": "test"
}
response = requests.get(
    "https://api.apis.guru/v2/specs/etherpad.local/1.2.15/createAuthor",
    params=params,
)
print(response.json())

const url = new URL('https://api.apis.guru/v2/specs/etherpad.local/1.2.15/createAuthor');
url.searchParams.set('name', 'test');

const response = await fetch(url); 
const data = await response.json();
console.log(data);

package main

import (
	"fmt"
	"io"
	"net/http"
	"net/url"
)

func main() {
	baseURL, _ := url.Parse("https://api.apis.guru/v2/specs/etherpad.local/1.2.15/createAuthor")
	q := baseURL.Query()
	q.Set("name", "test")
	baseURL.RawQuery = q.Encode()
	targetURL := baseURL.String()
	req, _ := http.NewRequest("GET", targetURL, nil)

	client := &http.Client{}
	resp, _ := client.Do(req)
	defer resp.Body.Close()
	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}

require "net/http"
require "json"

uri = URI("https://api.apis.guru/v2/specs/etherpad.local/1.2.15/createAuthor")
uri.query = URI.encode_www_form({
  "name" => "test"
})

http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"

req = Net::HTTP::Get.new(uri)

res = http.request(req)
puts JSON.parse(res.body)

<?php
$url = "https://api.apis.guru/v2/specs/etherpad.local/1.2.15/createAuthor?" . http_build_query([
    "name" => "test"
]);
$opts = ["http" => [
    "method" => "GET",
]];
$ctx = stream_context_create($opts);
$res = file_get_contents($url, false, $ctx);
print_r(json_decode($res, true));

GET this functions helps you to map your application author ids to Etherpad author ids

this functions helps you to map your application author ids to Etherpad author ids

https://api.apis.guru/v2/specs/etherpad.local/1.2.15/createAuthorIfNotExistsFor?name=test&authorMapper=example

Hover any highlighted part to learn what it does

curl -X GET "https://api.apis.guru/v2/specs/etherpad.local/1.2.15/createAuthorIfNotExistsFor?name=test&authorMapper=example"

import requests
params = {
    "name": "test",
    "authorMapper": "example"
}
response = requests.get(
    "https://api.apis.guru/v2/specs/etherpad.local/1.2.15/createAuthorIfNotExistsFor",
    params=params,
)
print(response.json())

const url = new URL('https://api.apis.guru/v2/specs/etherpad.local/1.2.15/createAuthorIfNotExistsFor');
url.searchParams.set('name', 'test');
url.searchParams.set('authorMapper', 'example');

const response = await fetch(url); 
const data = await response.json();
console.log(data);

package main

import (
	"fmt"
	"io"
	"net/http"
	"net/url"
)

func main() {
	baseURL, _ := url.Parse("https://api.apis.guru/v2/specs/etherpad.local/1.2.15/createAuthorIfNotExistsFor")
	q := baseURL.Query()
	q.Set("name", "test")
	q.Set("authorMapper", "example")
	baseURL.RawQuery = q.Encode()
	targetURL := baseURL.String()
	req, _ := http.NewRequest("GET", targetURL, nil)

	client := &http.Client{}
	resp, _ := client.Do(req)
	defer resp.Body.Close()
	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}

require "net/http"
require "json"

uri = URI("https://api.apis.guru/v2/specs/etherpad.local/1.2.15/createAuthorIfNotExistsFor")
uri.query = URI.encode_www_form({
  "name" => "test",
  "authorMapper" => "example"
})

http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"

req = Net::HTTP::Get.new(uri)

res = http.request(req)
puts JSON.parse(res.body)

<?php
$url = "https://api.apis.guru/v2/specs/etherpad.local/1.2.15/createAuthorIfNotExistsFor?" . http_build_query([
    "name" => "test",
    "authorMapper" => "example"
]);
$opts = ["http" => [
    "method" => "GET",
]];
$ctx = stream_context_create($opts);
$res = file_get_contents($url, false, $ctx);
print_r(json_decode($res, true));

Postman Setup Guide

Get Postman ↗

See official documentation for authentication and setup.

What can you build with Etherpad API?

Etherpad API is a Developer Tools API. Developers commonly use developer tools APIs for:

automating code review and quality checks
integrating CI/CD pipelines and build systems
managing feature flags and A/B tests
monitoring errors and application performance
generating and validating test data

No authentication required. This API is open — no signup or key needed. Ideal for quick prototypes and public-facing features. Etherpad API is free to use, making it a low-risk choice to experiment with.

New to APIs? Read our beginner's guide

Open documentation ↗