mirror of https://github.com/LemmyNet/lemmy-docs.git synced 2024-11-01 18:19:53 +00:00

* Moving API docs to typedocs. Fixes #93

* Fix client dev.

* Refer to API docs multiple times

* Forgot to remove http_api.md file.

* Fix an image issue.

2021-08-23 10:51:27 -04:00

1.6 KiB

Raw Blame History

Lemmy HTTP API Extras

This contains extras not in the API docs.

Curl Examples
HTTP API exclusive features
- RSS/Atom feeds
- Images

Curl Examples

GET example

curl "http://localhost:8536/api/v2/community/list?sort=Hot"`

POST example

curl -i -H \
"Content-Type: application/json" \
-X POST \
-d '{
  "comment_id": 374,
  "score": 1,
  "auth": eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6MiwiaXNzIjoidGVzdC5sZW1teS5tbCJ9.P77RX_kpz1a_geY5eCp29sl_5mAm-k27Cwnk8JcIZJk
}' \
http://localhost:8536/api/v2/comment/like

HTTP API exclusive features

These features cannot be accessed from the WebSocket API:

RSS/Atom feeds
Images

RSS/Atom feeds

All - /feeds/all.xml?sort=Hot
Community - /feeds/c/community-name.xml?sort=Hot
User - /feeds/u/user-name.xml?sort=Hot

Images

Lemmy forwards image requests to a locally running Pictrs.

GET /pictrs/image/{filename}?format={webp, jpg, ...}&thumbnail={96}

Format and thumbnail are optional.

Create (request)

Uploaded content must be valid multipart/form-data with an image array located within the images[] key.

POST /pictrs/image

Create (response)

{
  "files": [
    {
      "delete_token": "{token}",
      "file": "{file}.jpg"
    }
  ],
  "msg": "ok"
}

Delete

GET /pictrs/image/delete/{delete_token}/{file}

1.6 KiB Raw Blame History