platforms/devplace/README.md
DevPlace Platform API: Documentation Map
Entry point for the DevPlace (devplace.net) machine interface: base URL, the four authentication methods, shared conventions, and an index of every REST, XML-RPC, websocket and gateway reference in this directory.
DevPlace is a server-rendered social network for developers with a machine interface in front of every feature. Anything the website does can be driven from a script: the same URLs answer with HTML for a browser and JSON for a client.
Base URL
https://devplace.netMachine-readable schema
- Swagger UI - auto-generated console for trying endpoints.
- OpenAPI JSON - the raw schema for code generation and tooling.
Where to start
- Authentication - pick one of the four ways to sign a request.
- Conventions and errors - content negotiation, pagination,
- The reference page for the surface you need, from the index below.
the action envelope, and the status codes every endpoint shares.
Index
| Document | Covers |
|---|---|
| DevPlace Authentication: API Keys, Sessions, Bearer and Basic | The four interchangeable ways to authenticate any DevPlace request - session cookie, X-API-KEY header, Bearer token and HTTP Basic - plus the signup, login, logout and password-reset endpoints that issue and clear the session. |
| DevPlace API Conventions, Content Negotiation and Error Envelope | Rules shared by every DevPlace endpoint: base URL, form vs JSON request bodies, HTML/JSON content negotiation, the action response envelope, cursor pagination, rate limits and the status-code and error-shape contract. |
| DevPlace XML-RPC API | The XML-RPC endpoint that mirrors the REST surface: method catalogue, the api_key struct convention for authenticated calls, fault codes, and drop-in Python and JavaScript clients for posting, voting, following and messaging. |
| DevPlace devRant-Compatible REST API | The devRant compatibility layer: base URL and response shape, integer id mapping, the token-triple authentication model, and the rants, comments, users and notifications endpoints, with ready-made client scripts. |
| DevPlace REST: Search and Type-Ahead Lookups | The JSON lookup endpoints behind mentions and the message composer: user search and content search, their single q parameter, result caps and response shapes. |
| DevPlace REST: Votes, Reactions, Bookmarks and Polls | Toggle-style engagement endpoints for posts, comments, gists, projects and quizzes: vote casting and removal, emoji reactions, bookmarks and poll answers, including the X-Requested-With header rule that returns JSON instead of a redirect. |
| DevPlace REST: Posts and Comments | Endpoints for the home page and feed plus the full create, read, edit and delete cycle for posts and comments, with their form fields, topic enum, attachment_uids handling, pagination cursors and JSON payload shapes. |
| DevPlace REST: Projects, Gists and News | Project, gist and news endpoints: browsing and detail reads, create/edit/delete, private and read-only flags, zip export and fork jobs with their polling endpoints, and the news listing and article reads. |
| DevPlace REST: Profiles and the Social Graph | Profile reads and updates, API-key regeneration, avatar and award rendering, per-user AI correction, modifier, Telegram and notification settings, and the follow, block and mute endpoints with their follower and following listings. |
| DevPlace REST: Direct Messaging | The direct-message endpoints: opening the inbox and a conversation, the read-marking side effect, sending a message with attachments, and the recipient lookup that feeds the composer. |
| DevPlace REST: Reporting and Moderation Queue | The polymorphic report endpoint, the machine-readable reason list, and the administrator moderation queue: its state machine, actions, seniority rule and acknowledgement contract with the published review window. |
| DevPlace REST: Notification Feed and Unread Counts | Reading the notification feed with cursor pagination, the unread-count endpoint that backs the navigation badges, and the mark-read actions, including per-type coverage and JSON payload shapes. |
| DevPlace REST: Attachment Uploads | Uploading files with multipart/form-data or by handing the server a public URL, and the full attachment lifecycle - list, get, rename, delete - plus how the returned uid is referenced from posts, comments, projects, gists, messages and issues. |
| DevPlace REST: Project Virtual Filesystem | The per-project file API: listing the tree, reading and writing text files, uploading binaries, mkdir, move and delete, with the relative POSIX path rules and the traversal rejections that guard them. |
| DevPlace REST: Container Manager | Administrator-only endpoints that run supervised container instances per project: desired-state mutations and the reconciler, lifecycle and exec calls, terminal and log websockets, schedules, and the per-user isolation and primary-administrator rules. |
| DevPlace REST: Dev Workspaces and Tunnels | Workspace lifecycle endpoints for the browser editor attached to a project, the editor-preferences reads and writes, and tunnel creation that publishes a container port on a public HTTPS hostname, with quota and idle-reaping behaviour. |
| DevPlace REST: SEO Diagnostics, DeepSearch and AI Usage Analyzer | Background-job endpoints for the three public developer tools: queueing a run, polling status, reading the report, and the progress websockets - all addressed by unguessable capability URLs. |
| DevPlace REST: Web Push Registration | Registering browser and APNs push subscriptions: discovering enabled providers via push.json, fetching the public VAPID key, posting a PushSubscription, and the client-side unsubscribe model with no server endpoint. |
| DevPlace REST: Issue Reports and Gitea Integration | Filing, listing and commenting on issue tickets that are mirrored to a Gitea repository: the AI rewrite job that normalises a report into a ticket, the job polling endpoint, and the notification path back to the reporter. |
| DevPlace OpenAI-Compatible Gateway | The OpenAI-compatible proxy at /openai/v1: chat completions and streaming, the generic molodetz model names, embeddings, vision augmentation that rewrites images to text, forced-model behaviour, and per-call usage and cost accounting. |
| DevPlace Background Services: Control API and Service Catalogue | The service manager control endpoints - start, stop, single run, clear logs, save configuration and the live status/metrics/log-tail read - plus the catalogue of every service with its name, interval and configuration groups. |
| DevPlace Admin API | Administrator endpoints for users, roles, media, audit log, analytics and statistics, AI quota rules and resets, news curation, settings, bot fleet inspection, Devii tasks, backups and schedules, and Code Farm era control. |
| DevPlace Code Farm Game API | The Code Farm endpoints: reading state and leaderboards, planting and harvesting, plots and upgrades, watering and raiding a neighbour, fertilizer, daily bonus, quests, perks, prestige, mastery, legacy and the infrastructure, defense and cosmetic sinks. |
| DevPlace Quizzes API | Quiz endpoints for creation, import and export, question authoring and reordering, publishing, and the attempt lifecycle - start, answer, finish, results - plus the leaderboard and scoreboard reads, with a scripted end-to-end walkthrough. |
| DevPlace Database API Service | The read-only data surface at /dbapi: generic per-table reads, the validated query() call, the natural-language-to-SQL designer, asynchronous execution over a websocket, the table deny list, and the primary-administrator authorization boundary. |
| DevPlace Pub/Sub Websocket Bus | The database-free publish/subscribe bus at /pubsub: the websocket protocol and frame types, dotted topics with trailing wildcards, the service-lock-owner rule behind close code 4013, and the ephemeral best-effort delivery guarantees. |
Protocol surfaces
- REST over HTTP - the primary surface. Form-encoded writes, JSON reads through
- XML-RPC - xmlrpcapi.md, a mirror of the REST actions for
- devRant-compatible REST - devrantcompatibleapi.md,
- OpenAI-compatible HTTP - openaigateway.md, chat completions,
- Websockets - pubsubservice.md for the topic bus, plus job
- Web Push - restwebpush.md for browser and APNs delivery.
content negotiation, cursor pagination.
RPC clients.
an integer-id compatibility layer for existing devRant clients.
streaming and embeddings.
progress streams in tools, containers and the database API.