|
<div class="docs-content" data-render>
|
|
# DevPlace Documentation
|
|
|
|
Welcome to the DevPlace developer documentation. DevPlace is a server-rendered
|
|
social network for developers, with a clean HTTP surface that you can automate.
|
|
Anything you can do in the browser you can also do from a script.
|
|
|
|
> Tip: use the **search box** in the sidebar, or the [docs search](/docs/search.html)
|
|
> page, to find anything across these pages instantly.
|
|
|
|
## Getting started
|
|
|
|
- [Search the docs](/docs/search.html) - full-text search across every page (also in the sidebar).
|
|
- [Authentication](/docs/authentication.html) - sign in with a session cookie, an
|
|
API key, a Bearer token, or HTTP Basic credentials.
|
|
- [Conventions & Errors](/docs/conventions.html) - base URL, request bodies, the
|
|
AJAX header rule, pagination, identifiers, and status codes.
|
|
- [Devii Assistant](/docs/devii.html) - automate any of this by chatting; Devii writes
|
|
clients and bots and operates your account.
|
|
|
|
## API reference
|
|
|
|
Every reference page lists its endpoints with copy-paste cURL, JavaScript, and Python
|
|
examples and an interactive panel that runs the call with your own API key pre-filled.
|
|
Code samples are syntax-highlighted with line numbers and a one-click copy button.
|
|
|
|
- [Search & Lookups](/docs/lookups.html) - user and recipient lookups.
|
|
- [Votes, Reactions, Bookmarks & Polls](/docs/social-actions.html) - engagement actions.
|
|
- [Posts, Comments, Projects, Gists & News](/docs/content.html) - the core content types.
|
|
- [Profiles & Social Graph](/docs/profiles.html) - profiles, follows, leaderboard, avatars.
|
|
- [Messaging](/docs/messaging.html) - direct messages.
|
|
- [Notifications](/docs/notifications.html) - the notification feed and unread counts.
|
|
- [Uploads](/docs/uploads.html) - attachment storage.
|
|
- [Web Push](/docs/push.html) - browser push notifications.
|
|
- [Bug Reports](/docs/bugs.html) - the public bug board.
|
|
{% if is_admin(user) %}
|
|
- [OpenAI Gateway](/docs/gateway.html) - the OpenAI-compatible proxy.
|
|
- [Background Services](/docs/services.html) - manage and configure background services.
|
|
- [Admin API](/docs/admin.html) - user, news, and settings administration.
|
|
{% endif %}
|
|
|
|
## Download
|
|
|
|
Grab the entire documentation as a single file:
|
|
|
|
- [Single-page HTML](/docs/download.html) - one self-contained, offline-ready file with styling and syntax highlighting.
|
|
- [Markdown](/docs/download.md) - the complete docs as one Markdown document.
|
|
|
|
## Machine-readable schema
|
|
|
|
An OpenAPI schema and two interactive explorers are generated automatically from the
|
|
backend:
|
|
|
|
- [Swagger UI](/swagger) - try endpoints from an auto-generated console.
|
|
- [ReDoc](/redoc) - a clean, readable reference rendering.
|
|
- [OpenAPI JSON](/openapi.json) - the raw schema for codegen and tooling.
|
|
|
|
## Base URL
|
|
|
|
Every example in these docs uses your current host:
|
|
|
|
```
|
|
{{ base }}
|
|
```
|
|
</div>
|