Auto-generated from the live docs registry. Give this file to an agent to learn the API.
Molodetz is an independent institute for the study and practice of software engineering. This documentation describes how the site works, how to use the API and how admin keeps the whole thing running.
Read Writing on the roll for the content, and API and authentication for integrations.
Posts are markdown and live in SQLite. Only administrators write. A post has a title, a topic (roll or standard), a status (draft or published) and an optional placeholder marker.
The server renders GFM: tables, strikethrough, hard line breaks. HTML in the text is escaped. Links may only be http, https, mailto and tel. Write emoji as :shortcode:, for example :fire:.
A bare image URL becomes an image, @name becomes a link to the profile.
The first notes were carried over from the earlier Molodetz page and carry the Placeholder label. The institute replaces them with finished essays. Untick the box while editing once a note is complete.
A slug is the title plus the last twelve characters of the uid. Editing does not change the slug. If a title is ever rewritten in the database, the old slug still resolves through its uid tail and redirects with 301 to the canonical one.
The form at /join stores a join request: name, contact, an optional link to your work and a message. Administrators get a notification and see the request under Admin, Join requests.
There is no automatic access. retoor reads every request himself and answers the strong ones.
Molodetz has no ads, no cross-app tracking, no payments and no social login.
Every route has four faces: HTML, JSON, documentation and (where selected) an assistant tool. Ask for JSON with Accept: application/json.
Resolution order:
session cookie (64 hex characters) after logging in at /auth/login.X-API-KEY header with your API key.Authorization: Bearer <key>.Authorization: Basic with name or email and password.There is no JWT and no OAuth.
curl -H 'Accept: application/json' https://molodetz.nl/roll
Errors have the shape {"error": {"status": 404, "message": "..."}}. Validation errors return 422 with {"error": "validation", "fields": [...], "messages": [...]}.
Membership starts from a join request plus an admin-issued invite. Admins call POST /admin/joins/{uid}/invite (returns claim_url and expires_at in data) and POST /admin/joins/{uid}/invite/revoke. The public claim is GET and POST /invite/{token} with username, email, password, password_confirm and terms. Claim links are single use and every dead link answers 404 with the same message.
GET /admin/gallery reports live flyer and meme counts plus catalogued source files missing from disk. POST /admin/gallery/resync re-reads the sources and retires removed entries. See Galleries and content for how publishing works.
The Dutch paths from before (/rol, /standaard, /mensen, /binnen, /voorwaarden) answer with a 301 to their English replacement. Query strings are kept.
The flyers and the memes are curated galleries. Every work is a source file plus a catalogue entry with its caption. Nothing is uploaded through the site: new works arrive with a deploy, and the database reconciles at boot.
Flyers live at /flyers. New flyers are 1080 by 1350 (portrait). The first flyer in the catalogue is the featured one on the home page.
Memes live at /memes. New memes are 1080 by 1080 (square). Some older memes are 1280 by 720 (landscape) from the previous generation; they stay as they are.
An administrator can also press Resync under Admin, Gallery after a deploy. Resync re-reads the sources, refreshes thumbnails whose content changed, reports missing source files and retires removed entries. It never invents catalogue entries.
Public pages are cached for seconds to minutes (landing, settings, sitemap each have their own short TTL), so a fresh deploy can take a moment to show everywhere. The exact TTLs are operator detail; see the operator runbook under Admin.
Old Dutch paths (/rol, /mensen, and friends) redirect with 301 to their English replacements; see API and authentication.
Skills are small agent packages published on this site. Each skill is one
directory with a SKILL.md file plus optional scripts, references, and
assets, following the open Agent Skills standard from agentskills.io.
Every skill carries a short and a long description, both from the same
specification so every skill reads the same way.
Short: the frontmatter description in SKILL.md. One to 1024 characters
stating what the skill does and when to use it, with trigger keywords.
Agents load every installed short description at startup, and the skills
list shows exactly this text per skill.
Long: the markdown body after the frontmatter. Rendered on the skill page
below the facts table. It starts with one H1 title, then the fixed
sections What it does, When to use, Instructions, Examples, References.
Keep it concise and under 500 lines; move detail into references/ files
and deterministic work into scripts/.
The name is 1 to 64 characters of lowercase letters, digits, and
hyphens, with no leading, trailing, or consecutive hyphens, and it must
match the skill directory name. Optional fields are license,
compatibility (1 to 500 characters, only when the skill needs a
specific environment), metadata (a string map, used here for author and
version), and the experimental allowed-tools.
Admins author skills at /admin/skills: New skill writes a fresh
SKILL.md, Edit rewrites an existing one. Every save validates in the
official way: strict specification checks first, then
muse skills validate on the written directory. A save lands only when
both pass; a failed create removes its directory and a failed update
restores the previous file. Draft from prompt asks the configured model
to propose both descriptions, which the admin reviews before saving.
The skill page lists the full file tree with per-file downloads and one
ZIP holding the whole package. Build artifacts and hidden files are
excluded from both. The skills index and every skill page are indexed
and listed in the sitemap.
Public read routes: the roll, the standard, posts, galleries and people.
GET /Home · auth public (guest) · negotiable
Latest posts and the featured flyer.
curl -X GET -H 'Accept: application/json' 'https://example.com/'
{
"flyer_count": 4,
"meme_count": 22,
"posts": []
}GET /rollThe roll · auth public (guest) · negotiable
Published notes in the roll topic, newest first, cursor paginated.
| Name | Type | Location | Required | Example |
|---|---|---|---|---|
before | string | query | no | None |
curl -X GET -H 'Accept: application/json' 'https://example.com/roll'
{
"next_cursor": null,
"posts": [],
"title": "Roll",
"topic": "roll"
}GET /standardThe standard · auth public (guest) · negotiable
Published posts in the standard topic.
curl -X GET -H 'Accept: application/json' 'https://example.com/standard'
{
"posts": [],
"title": "Standard",
"topic": "standard"
}GET /posts/{slug}Post · auth public (guest) · negotiable
A published post by slug or uid. Old slugs redirect with 301 to the canonical slug.
| Name | Type | Location | Required | Example |
|---|---|---|---|---|
slug | string | path | yes | on-finishing |
curl -X GET -H 'Accept: application/json' 'https://example.com/posts/on-finishing'
{
"path": {
"slug": "on-finishing"
}
}{
"author": {
"username": "retoor"
},
"post": {
"title": "On finishing.",
"topic": "roll"
}
}GET /flyersFlyers · auth public (guest) · negotiable
Flyer gallery.
curl -X GET -H 'Accept: application/json' 'https://example.com/flyers'
{
"items": [],
"kind": "flyer",
"title": "Flyers"
}GET /memesMemes · auth public (guest) · negotiable
Meme gallery.
curl -X GET -H 'Accept: application/json' 'https://example.com/memes'
{
"items": [],
"kind": "meme",
"title": "Memes"
}GET /peoplePeople · auth public (guest) · negotiable
People on the roll.
curl -X GET -H 'Accept: application/json' 'https://example.com/people'
{
"people": [
{
"post_count": 5,
"username": "retoor"
}
]
}GET /people/{username}Person · auth public (guest) · negotiable
Profile with posts.
| Name | Type | Location | Required | Example |
|---|---|---|---|---|
username | string | path | yes | retoor |
curl -X GET -H 'Accept: application/json' 'https://example.com/people/retoor'
{
"path": {
"username": "retoor"
}
}{
"person": {
"username": "retoor"
},
"posts": []
}GET /robots.txtrobots.txt · auth public (guest) · none
curl -X GET -H 'Accept: application/json' 'https://example.com/robots.txt'
null
GET /sitemap.xmlSitemap · auth public (guest) · none
curl -X GET -H 'Accept: application/json' 'https://example.com/sitemap.xml'
null
GET /avatar/svg/{seed}Avatar · auth public (guest) · none
Deterministic SVG avatar.
curl -X GET -H 'Accept: application/json' 'https://example.com/avatar/svg/{seed}'null
GET /healthHealth · auth public (guest) · json
Liveness and version.
curl -X GET -H 'Accept: application/json' 'https://example.com/health'
{
"status": "ok",
"version": "1.0.0"
}GET /presence/rosterPresence · auth public (guest) · json
Online set (uids).
curl -X GET -H 'Accept: application/json' 'https://example.com/presence/roster'
{
"online": [],
"tracked": 0
}Apply to contribute. Stored for administrators, never public.
GET /joinJoin form · auth public (guest) · negotiable
curl -X GET -H 'Accept: application/json' 'https://example.com/join'
{
"submitted": false
}POST /joinApply to join · auth public (guest) · negotiable
Stores a join request: name, contact and an optional repo link.
| Name | Type | Location | Required | Example |
|---|---|---|---|---|
name | string | body | yes | Ada |
contact | string | body | yes | ada@example.com |
repo_url | string | body | no | https://git.example.com/ada |
message | string | body | no | I write about finishing things. |
curl -X POST -H 'Accept: application/json' -H 'Content-Type: application/json' -d '{"name": "Probe", "contact": "probe@example.com"}' 'https://example.com/join'{
"contact": "probe@example.com",
"name": "Probe"
}{
"data": {
"uid": "0190..."
},
"ok": true,
"redirect": "/join?ok=1"
}GET /invite/{token}Invite claim form · auth public (guest) · negotiable
Shows the claim form for a live invite; unknown, used and expired links answer 404 with the same message.
| Name | Type | Location | Required | Example |
|---|---|---|---|---|
token | string | path | yes | unknown-token |
curl -X GET -H 'Accept: application/json' 'https://example.com/invite/unknown-token'
{
"path": {
"token": "unknown-token"
}
}{
"email": "ada@example.com",
"email_locked": true,
"username": "ada",
"valid": true
}POST /invite/{token}Claim invite · auth public (guest) · negotiable
Creates the Member account, logs in and marks the join request accepted. Single use.
| Name | Type | Location | Required | Example |
|---|---|---|---|---|
token | string | path | yes | unknown-token |
username | string | body | yes | ada |
email | string | body | yes | ada@example.com |
password | string | body | yes | correct horse battery staple |
password_confirm | string | body | yes | correct horse battery staple |
terms | boolean | body | yes | True |
curl -X POST -H 'Accept: application/json' -H 'Content-Type: application/json' -d '{"username": "Probe", "email": "probe@example.com", "password": "probe-pass-1", "password_confirm": "probe-pass-1", "terms": true}' 'https://example.com/invite/unknown-token'{
"email": "probe@example.com",
"password": "probe-pass-1",
"password_confirm": "probe-pass-1",
"terms": true,
"username": "Probe"
}{
"data": {
"username": "ada"
},
"ok": true,
"redirect": "/"
}Session login, API key, notifications. No JWT, no OAuth.
GET /auth/loginLogin page · auth public (guest) · negotiable
curl -X GET -H 'Accept: application/json' 'https://example.com/auth/login'
{
"errors": [],
"next": "/admin"
}POST /auth/loginLog in · auth public (guest) · negotiable
Sets an httponly session cookie (7 days, 30 with remember me).
| Name | Type | Location | Required | Example |
|---|---|---|---|---|
username | string | body | yes | {{username}} |
password | password | body | yes | None |
remember | boolean | body | no | None |
curl -X POST -H 'Accept: application/json' -H 'Content-Type: application/json' -d '{"username": "retoor"}' 'https://example.com/auth/login'{
"body": {
"username": "retoor"
}
}{
"data": null,
"ok": true,
"redirect": "/admin"
}POST /auth/logoutLog out · auth public (guest) · negotiable
curl -X POST -H 'Accept: application/json' 'https://example.com/auth/logout'
{
"data": null,
"ok": true,
"redirect": "/"
}GET /profile/api-keyView API key · auth member (Member) · negotiable
curl -X GET -H 'Accept: application/json' -H 'X-API-KEY: YOUR_API_KEY' 'https://example.com/profile/api-key'
{
"api_key": "YOUR_API_KEY"
}POST /profile/api-key/regenerateRenew API key · auth member (Member) · negotiable
curl -X POST -H 'Accept: application/json' -H 'X-API-KEY: YOUR_API_KEY' 'https://example.com/profile/api-key/regenerate'
{
"data": {
"api_key": "..."
},
"ok": true,
"redirect": "/profile/api-key"
}POST /profile/avatar/regenerateRenew avatar · auth member (Member) · negotiable
curl -X POST -H 'Accept: application/json' -H 'X-API-KEY: YOUR_API_KEY' 'https://example.com/profile/avatar/regenerate'
{
"ok": true
}GET /profile/keysList SSH keys · auth member (Member) · negotiable
curl -X GET -H 'Accept: application/json' -H 'X-API-KEY: YOUR_API_KEY' 'https://example.com/profile/keys'
{
"keys": []
}POST /profile/keysAdd SSH key · auth member (Member) · negotiable
Registers one OpenSSH public key for git over SSH.
| Name | Type | Location | Required | Example |
|---|---|---|---|---|
name | string | body | yes | laptop |
key | string | body | yes | ssh-ed25519 AAAA... |
curl -X POST -H 'Accept: application/json' -H 'X-API-KEY: YOUR_API_KEY' -H 'Content-Type: application/json' -d '{}' 'https://example.com/profile/keys'{}{
"data": {
"fingerprint": "SHA256:...",
"uid": "..."
},
"ok": true,
"redirect": "/profile/keys"
}POST /profile/keys/{uid}/deleteDelete SSH key · auth member (Member) · negotiable
Deletes one of your SSH keys.
| Name | Type | Location | Required | Example |
|---|---|---|---|---|
uid | string | path | yes | ... |
curl -X POST -H 'Accept: application/json' -H 'X-API-KEY: YOUR_API_KEY' 'https://example.com/profile/keys/.../delete'
{
"path": {
"uid": "..."
}
}{
"data": {
"uid": "..."
},
"ok": true,
"redirect": "/profile/keys"
}GET /notificationsNotifications · auth member (Member) · negotiable
curl -X GET -H 'Accept: application/json' -H 'X-API-KEY: YOUR_API_KEY' 'https://example.com/notifications'
{
"notifications": [],
"unread": 0
}POST /notifications/readMark all read · auth member (Member) · negotiable
curl -X POST -H 'Accept: application/json' -H 'X-API-KEY: YOUR_API_KEY' 'https://example.com/notifications/read'
{
"ok": true,
"redirect": "/notifications"
}GET /termsTerms · auth public (guest) · negotiable
curl -X GET -H 'Accept: application/json' 'https://example.com/terms'
{
"title": "Terms"
}POST /terms/acceptAccept terms · auth member (Member) · negotiable
curl -X POST -H 'Accept: application/json' -H 'X-API-KEY: YOUR_API_KEY' 'https://example.com/terms/accept'
{
"ok": true,
"redirect": "/"
}GET /privacyPrivacy · auth public (guest) · negotiable
curl -X GET -H 'Accept: application/json' 'https://example.com/privacy'
{
"title": "Privacy"
}Three search modes over the rsearch backend: instant search, graded deepsearch, streamed deepresearch.
GET /searchSearch page · auth public (guest) · negotiable
Fast multi-provider web search on submit.
curl -X GET -H 'Accept: application/json' 'https://example.com/search'
{
"mode": "search"
}GET /deepsearchDeepsearch page · auth public (guest) · negotiable
Iterative research with graded sources and a written answer.
curl -X GET -H 'Accept: application/json' 'https://example.com/deepsearch'
{
"mode": "deepsearch"
}GET /deepresearchDeepresearch page · auth public (guest) · negotiable
Live-streamed deep research with thinking trace and growing answer.
curl -X GET -H 'Accept: application/json' 'https://example.com/deepresearch'
{
"mode": "deepresearch"
}GET /search/apiSearch API · auth public (guest) · negotiable
Proxies rsearch search. Query plus count, content, and cache flags. Answers results plus a telemetry envelope.
| Name | Type | Location | Required | Example |
|---|---|---|---|---|
q | string | query | yes | python asyncio |
count | string | query | no | None |
content | string | query | no | None |
cache | string | query | no | None |
curl -X GET -H 'Accept: application/json' 'https://example.com/search/api?q=python+asyncio'
{
"query": {
"q": "python asyncio"
}
}{
"results": [],
"telemetry": {}
}GET /deepsearch/apiDeepsearch API · auth public (guest) · negotiable
Proxies rsearch deep research. Answers graded sources, markdown, rounds, plus a telemetry envelope. Runs fresh work unless cache=true replays a stored answer.
| Name | Type | Location | Required | Example |
|---|---|---|---|---|
q | string | query | yes | sodium battery state of the art |
count | string | query | no | None |
cache | string | query | no | None |
curl -X GET -H 'Accept: application/json' 'https://example.com/deepsearch/api?q=sodium+battery+state+of+the+art'
{
"query": {
"q": "sodium battery state of the art"
}
}{
"deep": {},
"telemetry": {}
}GET /deepsearch/streamDeepsearch stream · auth public (guest) · negotiable
Server-sent stream: telemetry keep-alive while rsearch runs, then the result plus done, or error. The Deepsearch page always asks for cache=false.
| Name | Type | Location | Required | Example |
|---|---|---|---|---|
q | string | query | yes | sodium battery state of the art |
count | string | query | no | None |
cache | string | query | no | None |
curl -X GET -H 'Accept: application/json' 'https://example.com/deepsearch/stream?q=sodium+battery+state+of+the+art'
{
"query": {
"q": "sodium battery state of the art"
}
}{
"event": "result"
}GET /deepresearch/streamDeepresearch stream · auth public (guest) · negotiable
Server-sent stream: think, answer, sources, usage, telemetry, cost, then done or error.
| Name | Type | Location | Required | Example |
|---|---|---|---|---|
q | string | query | yes | quantum computing breakthroughs |
curl -X GET -H 'Accept: application/json' 'https://example.com/deepresearch/stream?q=quantum+computing+breakthroughs'
{
"query": {
"q": "quantum computing breakthroughs"
}
}{
"event": "think"
}Research driven by a generated script: start a job, follow the live script and progress stream, and read the cited report.
GET /scriptedsearchScripted search page · auth public (guest) · negotiable
Question form, live script view, progress, report and recent runs.
curl -X GET -H 'Accept: application/json' 'https://example.com/scriptedsearch'
{
"jobs": [],
"mode": "scriptedsearch"
}GET /scriptedsearch/jobsList scripted searches · auth member (Member) · negotiable
The signed-in member's jobs, newest first.
curl -X GET -H 'Accept: application/json' -H 'X-API-KEY: YOUR_API_KEY' 'https://example.com/scriptedsearch/jobs'
{
"jobs": []
}POST /scriptedsearch/jobsStart scripted search · auth member (Member) · negotiable
Starts a background job for the question. One running job per member.
| Name | Type | Location | Required | Example |
|---|---|---|---|---|
query | string | body | yes | Which EU member states joined after 2004? List them with their capitals. |
curl -X POST -H 'Accept: application/json' -H 'X-API-KEY: YOUR_API_KEY' -H 'Content-Type: application/json' -d '{"query": ""}' 'https://example.com/scriptedsearch/jobs'{
"query": ""
}{
"status": "running",
"uid": ""
}GET /scriptedsearch/jobs/{uid}Scripted search job · auth member (Member) · negotiable
Status and, when finished, the parsed report, sources and script.
curl -X GET -H 'Accept: application/json' -H 'X-API-KEY: YOUR_API_KEY' 'https://example.com/scriptedsearch/jobs/{uid}'{
"result": {},
"status": "done"
}POST /scriptedsearch/jobs/{uid}/cancelCancel scripted search · auth member (Member) · negotiable
Stops a running job; its events stay readable.
curl -X POST -H 'Accept: application/json' -H 'X-API-KEY: YOUR_API_KEY' -H 'Content-Type: application/json' -d '{}' 'https://example.com/scriptedsearch/jobs/{uid}/cancel'{}{
"status": "cancelled"
}DELETE /scriptedsearch/jobs/{uid}Delete scripted search · auth member (Member) · negotiable
Deletes a finished job with its events.
curl -X DELETE -H 'Accept: application/json' -H 'X-API-KEY: YOUR_API_KEY' 'https://example.com/scriptedsearch/jobs/{uid}'{
"ok": true
}GET /scriptedsearch/jobs/{uid}/streamScripted search stream · auth member (Member) · negotiable
Server-sent events with ids for resume: budget, stage, requirements, script, exec, cost, site, results, step, warning, round, telemetry, result, error, done.
curl -X GET -H 'Accept: application/json' -H 'X-API-KEY: YOUR_API_KEY' 'https://example.com/scriptedsearch/jobs/{uid}/stream'{
"event": "script"
}GET /scriptedsearch/jobs/{uid}/report.mdReport download · auth member (Member) · none
Markdown report of a finished job.
curl -X GET -H 'Accept: application/json' -H 'X-API-KEY: YOUR_API_KEY' 'https://example.com/scriptedsearch/jobs/{uid}/report.md'{}GET /scriptedsearch/jobs/{uid}/script.rrsScript download · auth member (Member) · none
Research script of a finished job.
curl -X GET -H 'Accept: application/json' -H 'X-API-KEY: YOUR_API_KEY' 'https://example.com/scriptedsearch/jobs/{uid}/script.rrs'{}Asynchronous research jobs: attach documents, start a multi-step agent run, follow its event stream, and read the cited report.
GET /researchResearch workspace page · auth member (Member) · negotiable
Workspace with document tray, live run trace, report, charts and recent jobs.
curl -X GET -H 'Accept: application/json' -H 'X-API-KEY: YOUR_API_KEY' 'https://example.com/research'
{
"jobs": [],
"mode": "research"
}GET /research/jobsList research jobs · auth member (Member) · negotiable
The signed-in member's started jobs, newest first.
curl -X GET -H 'Accept: application/json' -H 'X-API-KEY: YOUR_API_KEY' 'https://example.com/research/jobs'
{
"jobs": []
}POST /research/jobsNew research job · auth member (Member) · negotiable
Creates a draft job that accepts documents until it starts.
curl -X POST -H 'Accept: application/json' -H 'X-API-KEY: YOUR_API_KEY' -H 'Content-Type: application/json' -d '{}' 'https://example.com/research/jobs'{}{
"status": "draft",
"uid": ""
}GET /research/jobs/{uid}Research job · auth member (Member) · negotiable
Status, attached documents, and the final result when finished.
curl -X GET -H 'Accept: application/json' -H 'X-API-KEY: YOUR_API_KEY' 'https://example.com/research/jobs/{uid}'{
"result": {},
"status": "done"
}POST /research/jobs/{uid}/documentsAttach document · auth member (Member) · negotiable
Multipart upload in field file. Accepts PDF, DOCX, TXT, MD, CSV, TSV, JSON, HTML, and ZIP archives of those.
| Name | Type | Location | Required | Example |
|---|---|---|---|---|
file | file | body | yes | None |
curl -X POST -H 'Accept: application/json' -H 'X-API-KEY: YOUR_API_KEY' -H 'Content-Type: application/json' -d '{}' 'https://example.com/research/jobs/{uid}/documents'{}{
"added": [],
"rejected": []
}DELETE /research/jobs/{uid}/documents/{document_uid}Remove document · auth member (Member) · negotiable
Removes one document from a draft job.
curl -X DELETE -H 'Accept: application/json' -H 'X-API-KEY: YOUR_API_KEY' 'https://example.com/research/jobs/{uid}/documents/{document_uid}'{
"ok": true
}POST /research/jobs/{uid}/startStart research job · auth member (Member) · negotiable
Starts the agent on a draft job. Output preferences such as tone, format, tables and charts are read from the question.
| Name | Type | Location | Required | Example |
|---|---|---|---|---|
query | string | body | yes | Market analysis of European heat pump makers with a positioning matrix |
curl -X POST -H 'Accept: application/json' -H 'X-API-KEY: YOUR_API_KEY' -H 'Content-Type: application/json' -d '{"query": "probe"}' 'https://example.com/research/jobs/{uid}/start'{
"query": "probe"
}{
"status": "running"
}POST /research/jobs/{uid}/cancelCancel research job · auth member (Member) · negotiable
Stops a running job; gathered events stay readable.
curl -X POST -H 'Accept: application/json' -H 'X-API-KEY: YOUR_API_KEY' -H 'Content-Type: application/json' -d '{}' 'https://example.com/research/jobs/{uid}/cancel'{}{
"status": "cancelled"
}DELETE /research/jobs/{uid}Delete research job · auth member (Member) · negotiable
Deletes a finished or draft job with its documents and events.
curl -X DELETE -H 'Accept: application/json' -H 'X-API-KEY: YOUR_API_KEY' 'https://example.com/research/jobs/{uid}'{
"ok": true
}GET /research/jobs/{uid}/streamResearch job stream · auth member (Member) · negotiable
Server-sent events with ids for resume: status, plan, step, progress, review, warning, usage, telemetry, result, error, done.
curl -X GET -H 'Accept: application/json' -H 'X-API-KEY: YOUR_API_KEY' 'https://example.com/research/jobs/{uid}/stream'{
"event": "step"
}Agent skills: short descriptions on the list, full instructions plus file tree on each page.
GET /skillsSkills · auth public (guest) · negotiable
Every skill with its short description.
curl -X GET -H 'Accept: application/json' 'https://example.com/skills'
{
"skills": [
{
"name": "deepresearch"
}
]
}GET /skills/{name}Skill · auth public (guest) · negotiable
Long description, facts, file tree, and downloads.
| Name | Type | Location | Required | Example |
|---|---|---|---|---|
name | string | path | yes | deepresearch |
curl -X GET -H 'Accept: application/json' 'https://example.com/skills/deepresearch'
{
"path": {
"name": "deepresearch"
}
}{
"files": [],
"skill": {
"name": "deepresearch"
}
}GET /skills/{name}/download/zipDownload skill · auth public (guest) · negotiable
Whole package as ZIP, members prefixed with the skill name.
| Name | Type | Location | Required | Example |
|---|---|---|---|---|
name | string | path | yes | deepresearch |
curl -X GET -H 'Accept: application/json' 'https://example.com/skills/deepresearch/download/zip'
{
"path": {
"name": "deepresearch"
}
}{
"download": "deepresearch.zip"
}GET /skills/{name}/files/{path}Download skill file · auth public (guest) · negotiable
One packaged file. Images inline, everything else as attachment. Build artifacts and hidden files 404.
| Name | Type | Location | Required | Example |
|---|---|---|---|---|
name | string | path | yes | deepresearch |
path | string | path | yes | SKILL.md |
curl -X GET -H 'Accept: application/json' 'https://example.com/skills/deepresearch/files/SKILL.md'
{
"path": {
"name": "deepresearch",
"path": "SKILL.md"
}
}{
"download": "SKILL.md"
}Git hosting with visibility, roles, secrets, code search, and smart HTTP.
GET /reposRepository list · auth public (guest) · negotiable
Accessible plus public repositories, newest first. Guests see public repositories only.
curl -X GET -H 'Accept: application/json' 'https://example.com/repos'
{
"repos": []
}GET /repos/newNew repository form · auth member (Member) · negotiable
Create form for name, visibility, and short description.
curl -X GET -H 'Accept: application/json' -H 'X-API-KEY: YOUR_API_KEY' 'https://example.com/repos/new'
{
"repos": []
}POST /reposRepository creation · auth member (Member) · negotiable
Creates a repository. Names allow letters, digits, dot, _ and -, no leading dot.
| Name | Type | Location | Required | Example |
|---|---|---|---|---|
name | string | body | yes | garden |
visibility | string | body | no | secret |
description | string | body | no | Tools for tending the garden. |
curl -X POST -H 'Accept: application/json' -H 'X-API-KEY: YOUR_API_KEY' -H 'Content-Type: application/json' -d '{}' 'https://example.com/repos'{}{
"data": {
"name": "garden",
"uid": "..."
},
"ok": true,
"redirect": "/repos/garden"
}GET /repos/{name}Repository page · auth public (guest) · negotiable
Files, rendered README, and clone URL. Public and hidden are readable by link, only public is listed, secret 404s for strangers.
| Name | Type | Location | Required | Example |
|---|---|---|---|---|
name | string | path | yes | garden |
curl -X GET -H 'Accept: application/json' 'https://example.com/repos/garden'
{
"path": {
"name": "garden"
}
}{
"files": [],
"repo": {
"name": "garden"
}
}GET /repos/{name}/treeRoot listing · auth public (guest) · negotiable
Top-level entries of the default branch, same shape as the directory listing.
| Name | Type | Location | Required | Example |
|---|---|---|---|---|
name | string | path | yes | garden |
curl -X GET -H 'Accept: application/json' 'https://example.com/repos/garden/tree'
{
"path": {
"name": "garden"
}
}{
"files": [],
"path": "",
"repo": {
"name": "garden"
}
}GET /repos/{name}/tree/{path}Directory listing · auth public (guest) · negotiable
Entries of one directory at the default branch with type, size, and whether the file opens in the site, depends on the browser, or is download only. Files redirect to the blob view.
| Name | Type | Location | Required | Example |
|---|---|---|---|---|
name | string | path | yes | garden |
path | string | path | no | src |
curl -X GET -H 'Accept: application/json' 'https://example.com/repos/garden/tree/src'
{
"path": {
"name": "garden",
"path": "src"
}
}{
"files": [
{
"kind": "code",
"label": "Python",
"name": "main.py",
"path": "src/main.py",
"support": "full",
"url_path": "src/main.py",
"viewable": true
}
],
"path": "src",
"repo": {
"name": "garden"
}
}GET /repos/{name}/blob/{path}File view · auth public (guest) · negotiable
Numbered, highlighted source, rendered Markdown, inline images, video, audio, and PDF. Binary types show a download action. Directories redirect to the tree view.
| Name | Type | Location | Required | Example |
|---|---|---|---|---|
name | string | path | yes | garden |
path | string | path | yes | src/main.py |
curl -X GET -H 'Accept: application/json' 'https://example.com/repos/garden/blob/src/main.py'
{
"path": {
"name": "garden",
"path": "src/main.py"
}
}{
"file": {
"kind": "code",
"language": "python"
},
"line_count": 1,
"path": "src/main.py",
"raw_url": "/repos/garden/raw/src/main.py",
"text": "print(1)\n"
}GET /repos/{name}/raw/{path}Raw file · auth public (guest) · none
File bytes with the media type for images, video, audio, and PDF, text/plain for source, and attachment for binaries. Supports byte ranges and resolves Git LFS objects. Add download=1 to force an attachment.
| Name | Type | Location | Required | Example |
|---|---|---|---|---|
name | string | path | yes | garden |
path | string | path | yes | docs/screenshot.png |
download | string | query | no | 1 |
curl -X GET -H 'Accept: application/json' 'https://example.com/repos/garden/raw/docs/screenshot.png?download=1'
{
"path": {
"name": "garden",
"path": "docs/screenshot.png"
},
"query": {
"download": "1"
}
}null
GET /repos/{name}/settingsRepository settings · auth member (Member) · negotiable
Visibility, default branch, short description and pull request settings. Needs repository.write.
| Name | Type | Location | Required | Example |
|---|---|---|---|---|
name | string | path | yes | garden |
curl -X GET -H 'Accept: application/json' -H 'X-API-KEY: YOUR_API_KEY' 'https://example.com/repos/garden/settings'
{
"path": {
"name": "garden"
}
}{
"repo": {
"name": "garden"
}
}POST /repos/{name}/settingsSave settings · auth member (Member) · negotiable
Stores visibility, default branch, and short description. Needs repository.write.
| Name | Type | Location | Required | Example |
|---|---|---|---|---|
name | string | path | yes | garden |
visibility | string | body | no | secret |
default_branch | string | body | no | main |
description | string | body | no | Tools for tending the garden. |
curl -X POST -H 'Accept: application/json' -H 'X-API-KEY: YOUR_API_KEY' -H 'Content-Type: application/json' -d '{}' 'https://example.com/repos/garden/settings'{}{
"data": {
"uid": "..."
},
"ok": true,
"redirect": "/repos/garden/settings"
}POST /repos/{name}/deleteRepository removal · auth member (Member) · negotiable
Soft delete. Needs repository.delete.
| Name | Type | Location | Required | Example |
|---|---|---|---|---|
name | string | path | yes | garden |
curl -X POST -H 'Accept: application/json' -H 'X-API-KEY: YOUR_API_KEY' 'https://example.com/repos/garden/delete'
{
"path": {
"name": "garden"
}
}null
GET /repos/{name}/membersRepository members · auth member (Member) · negotiable
Grant table plus invite form. Needs repository.access.read.
| Name | Type | Location | Required | Example |
|---|---|---|---|---|
name | string | path | yes | garden |
curl -X GET -H 'Accept: application/json' -H 'X-API-KEY: YOUR_API_KEY' 'https://example.com/repos/garden/members'
{
"path": {
"name": "garden"
}
}{
"members": []
}POST /repos/{name}/membersGrant access · auth member (Member) · negotiable
Grants a role or raw perms mask to a user uid or username. Needs repository.access.read or repository.access.write plus every bit granted.
| Name | Type | Location | Required | Example |
|---|---|---|---|---|
name | string | path | yes | garden |
user | string | body | yes | lezer |
role | string | body | no | reader |
perms | integer | body | no | 1 |
curl -X POST -H 'Accept: application/json' -H 'X-API-KEY: YOUR_API_KEY' -H 'Content-Type: application/json' -d '{}' 'https://example.com/repos/garden/members'{}{
"data": {
"perms": 1,
"user_uid": "..."
},
"ok": true,
"redirect": "/repos/garden/members"
}POST /repos/{name}/members/{user_uid}/revokeRevoke access · auth member (Member) · negotiable
Removes a member grant. Needs repository.access.write. Last owner self-revoke is blocked.
| Name | Type | Location | Required | Example |
|---|---|---|---|---|
name | string | path | yes | garden |
user_uid | string | path | yes | ... |
curl -X POST -H 'Accept: application/json' -H 'X-API-KEY: YOUR_API_KEY' 'https://example.com/repos/garden/members/.../revoke'
{
"path": {
"name": "garden",
"user_uid": "..."
}
}null
GET /repos/{name}/secretsRepository secrets · auth member (Member) · negotiable
Names and metadata only, values are never rendered. Needs repository.secrets.read.
| Name | Type | Location | Required | Example |
|---|---|---|---|---|
name | string | path | yes | garden |
curl -X GET -H 'Accept: application/json' -H 'X-API-KEY: YOUR_API_KEY' 'https://example.com/repos/garden/secrets'
{
"path": {
"name": "garden"
}
}{
"secrets": []
}POST /repos/{name}/secretsStore secret · auth member (Member) · negotiable
Seals a value under the per-repo key. Needs repository.secrets.write.
| Name | Type | Location | Required | Example |
|---|---|---|---|---|
name | string | path | yes | garden |
name | string | body | yes | DEPLOY_TOKEN |
value | password | body | yes | secret-value |
curl -X POST -H 'Accept: application/json' -H 'X-API-KEY: YOUR_API_KEY' -H 'Content-Type: application/json' -d '{}' 'https://example.com/repos/garden/secrets'{}{
"data": {
"name": "DEPLOY_TOKEN"
},
"ok": true,
"redirect": "/repos/garden/secrets"
}POST /repos/{name}/secrets/{secret_uid}/deleteDelete secret · auth member (Member) · negotiable
Deletes one sealed secret. Needs repository.secrets.delete.
| Name | Type | Location | Required | Example |
|---|---|---|---|---|
name | string | path | yes | garden |
secret_uid | string | path | yes | ... |
curl -X POST -H 'Accept: application/json' -H 'X-API-KEY: YOUR_API_KEY' 'https://example.com/repos/garden/secrets/.../delete'
{
"path": {
"name": "garden",
"secret_uid": "..."
}
}null
POST /repos/{name}/secrets/rotateRotate secrets · auth member (Member) · negotiable
Issues a new per-repo key and re-seals every secret. Needs repository.secrets.write.
| Name | Type | Location | Required | Example |
|---|---|---|---|---|
name | string | path | yes | garden |
curl -X POST -H 'Accept: application/json' -H 'X-API-KEY: YOUR_API_KEY' 'https://example.com/repos/garden/secrets/rotate'
{
"path": {
"name": "garden"
}
}null
GET /git/{name}/info/refsGit discovery · auth public (guest) · none
Smart HTTP advertisement. Upload-pack is public for public repos, receive-pack needs auth plus repository.write or push-to-create.
| Name | Type | Location | Required | Example |
|---|---|---|---|---|
name | string | path | yes | garden |
service | string | query | yes | git-upload-pack |
curl -X GET -H 'Accept: application/json' 'https://example.com/git/garden/info/refs?service=git-upload-pack'
{
"path": {
"name": "garden"
},
"query": {
"service": "git-upload-pack"
}
}null
POST /git/{name}/git-upload-packGit fetch · auth public (guest) · none
Smart HTTP fetch and clone body exchange.
| Name | Type | Location | Required | Example |
|---|---|---|---|---|
name | string | path | yes | garden |
curl -X POST -H 'Accept: application/json' 'https://example.com/git/garden/git-upload-pack'
{
"path": {
"name": "garden"
}
}null
POST /git/{name}/git-receive-packGit push · auth member (Member) · none
Smart HTTP push. Oversize pushes are rejected with 413 before unpack.
| Name | Type | Location | Required | Example |
|---|---|---|---|---|
name | string | path | yes | garden |
curl -X POST -H 'Accept: application/json' -H 'X-API-KEY: YOUR_API_KEY' 'https://example.com/git/garden/git-receive-pack'
{
"path": {
"name": "garden"
}
}null
GET /repos/{name}/info/refsGit discovery alias · auth public (guest) · none
Same smart HTTP advertisement as /git/{name}/info/refs, served on the page URL so git clients clone from /repos directly.
| Name | Type | Location | Required | Example |
|---|---|---|---|---|
name | string | path | yes | garden |
service | string | query | yes | git-upload-pack |
curl -X GET -H 'Accept: application/json' 'https://example.com/repos/garden/info/refs?service=git-upload-pack'
{
"path": {
"name": "garden"
},
"query": {
"service": "git-upload-pack"
}
}null
POST /repos/{name}/git-upload-packGit fetch alias · auth public (guest) · none
Same smart HTTP fetch exchange as /git/{name}/git-upload-pack, served on the page URL.
| Name | Type | Location | Required | Example |
|---|---|---|---|---|
name | string | path | yes | garden |
curl -X POST -H 'Accept: application/json' 'https://example.com/repos/garden/git-upload-pack'
{
"path": {
"name": "garden"
}
}null
POST /repos/{name}/git-receive-packGit push alias · auth member (Member) · none
Same smart HTTP push as /git/{name}/git-receive-pack, served on the page URL.
| Name | Type | Location | Required | Example |
|---|---|---|---|---|
name | string | path | yes | garden |
curl -X POST -H 'Accept: application/json' -H 'X-API-KEY: YOUR_API_KEY' 'https://example.com/repos/garden/git-receive-pack'
{
"path": {
"name": "garden"
}
}null
POST /git/{name}/info/lfs/objects/batchLFS batch · auth public (guest) · negotiable
Batch upload or download negotiation. Upload needs repository.write, download needs repository.read.
| Name | Type | Location | Required | Example |
|---|---|---|---|---|
name | string | path | yes | garden |
operation | string | body | yes | download |
objects | string | body | yes | [{'oid': '0000000000000000000000000000000000000000000000000000000000000000', 'size': 5}] |
curl -X POST -H 'Accept: application/json' -H 'Content-Type: application/json' -d '{}' 'https://example.com/git/garden/info/lfs/objects/batch'{}{
"hash_algo": "sha256",
"objects": [
{
"oid": "0000000000000000000000000000000000000000000000000000000000000000",
"size": 5
}
],
"transfer": "basic"
}GET /git/{name}/info/lfs/objects/{oid}LFS object download · auth public (guest) · none
Streams one content-addressed object as application/octet-stream. Needs repository.read.
| Name | Type | Location | Required | Example |
|---|---|---|---|---|
name | string | path | yes | garden |
oid | string | path | yes | 0000000000000000000000000000000000000000000000000000000000000000 |
curl -X GET -H 'Accept: application/json' 'https://example.com/git/garden/info/lfs/objects/0000000000000000000000000000000000000000000000000000000000000000'
{
"path": {
"name": "garden",
"oid": "0000000000000000000000000000000000000000000000000000000000000000"
}
}{
"encoding": "raw bytes",
"oid": "0000000000000000000000000000000000000000000000000000000000000000",
"size": 5
}PUT /git/{name}/info/lfs/objects/{oid}LFS object upload · auth member (Member) · none
Stores one object after verifying its sha256. Re-upload overwrites. Needs repository.write.
| Name | Type | Location | Required | Example |
|---|---|---|---|---|
name | string | path | yes | garden |
oid | string | path | yes | 0000000000000000000000000000000000000000000000000000000000000000 |
curl -X PUT -H 'Accept: application/json' -H 'X-API-KEY: YOUR_API_KEY' 'https://example.com/git/garden/info/lfs/objects/0000000000000000000000000000000000000000000000000000000000000000'
{
"path": {
"name": "garden",
"oid": "0000000000000000000000000000000000000000000000000000000000000000"
}
}{
"oid": "0000000000000000000000000000000000000000000000000000000000000000"
}GET /git/{name}/info/lfs/locksLFS lock list · auth member (Member) · negotiable
Lists file locks with cursor paging. Limit clamps to 1-100. Needs repository.read.
| Name | Type | Location | Required | Example |
|---|---|---|---|---|
name | string | path | yes | garden |
limit | integer | query | no | 100 |
cursor | string | query | no |
curl -X GET -H 'Accept: application/json' -H 'X-API-KEY: YOUR_API_KEY' 'https://example.com/git/garden/info/lfs/locks?limit=100&cursor='
{
"path": {
"name": "garden"
},
"query": {
"cursor": "",
"limit": 100
}
}{
"locks": [
{
"id": "...",
"locked_at": "2026-01-01T00:00:00+00:00",
"owner": {
"name": "lezer"
},
"path": "assets/sprite.bin"
}
]
}POST /git/{name}/info/lfs/locksLFS lock creation · auth member (Member) · negotiable
Locks one repo-relative path. Conflict returns 409 with the existing lock. Needs repository.write.
| Name | Type | Location | Required | Example |
|---|---|---|---|---|
name | string | path | yes | garden |
path | string | body | yes | assets/sprite.bin |
curl -X POST -H 'Accept: application/json' -H 'X-API-KEY: YOUR_API_KEY' -H 'Content-Type: application/json' -d '{}' 'https://example.com/git/garden/info/lfs/locks'{}{
"lock": {
"id": "...",
"locked_at": "2026-01-01T00:00:00+00:00",
"owner": {
"name": "lezer"
},
"path": "assets/sprite.bin"
}
}DELETE /git/{name}/info/lfs/locks/{id}LFS unlock · auth member (Member) · negotiable
Deletes one lock. Non-owners pass force true. Needs repository.write.
| Name | Type | Location | Required | Example |
|---|---|---|---|---|
name | string | path | yes | garden |
id | string | path | yes | ... |
force | boolean | body | no | False |
curl -X DELETE -H 'Accept: application/json' -H 'X-API-KEY: YOUR_API_KEY' -H 'Content-Type: application/json' -d '{"force": false}' 'https://example.com/git/garden/info/lfs/locks/...'{
"body": {
"force": false
},
"path": {
"id": "...",
"name": "garden"
}
}{
"lock": {
"id": "...",
"locked_at": "2026-01-01T00:00:00+00:00",
"owner": {
"name": "lezer"
},
"path": "assets/sprite.bin"
}
}POST /git/{name}/info/lfs/locks/verifyLFS lock verification · auth member (Member) · negotiable
Lists only the caller-owned locks with cursor paging. Needs repository.read.
| Name | Type | Location | Required | Example |
|---|---|---|---|---|
name | string | path | yes | garden |
limit | integer | query | no | 100 |
cursor | string | query | no |
curl -X POST -H 'Accept: application/json' -H 'X-API-KEY: YOUR_API_KEY' 'https://example.com/git/garden/info/lfs/locks/verify?limit=100&cursor='
{
"path": {
"name": "garden"
},
"query": {
"cursor": "",
"limit": 100
}
}{
"locks": [
{
"id": "...",
"locked_at": "2026-01-01T00:00:00+00:00",
"owner": {
"name": "lezer"
},
"path": "assets/sprite.bin"
}
]
}POST /repos/{name}/info/lfs/objects/batchLFS batch on page URL · auth public (guest) · negotiable
Same batch negotiation as /git/{name}/info/lfs/objects/batch, served on the page URL for repos clones.
| Name | Type | Location | Required | Example |
|---|---|---|---|---|
name | string | path | yes | garden |
operation | string | body | yes | download |
objects | string | body | yes | [{'oid': '0000000000000000000000000000000000000000000000000000000000000000', 'size': 5}] |
curl -X POST -H 'Accept: application/json' -H 'Content-Type: application/json' -d '{}' 'https://example.com/repos/garden/info/lfs/objects/batch'{}{
"hash_algo": "sha256",
"objects": [
{
"oid": "0000000000000000000000000000000000000000000000000000000000000000",
"size": 5
}
],
"transfer": "basic"
}GET /repos/{name}/info/lfs/objects/{oid}LFS object download on page URL · auth public (guest) · none
Same object stream as /git/{name}/info/lfs/objects/{oid}, served on the page URL. Needs repository.read.
| Name | Type | Location | Required | Example |
|---|---|---|---|---|
name | string | path | yes | garden |
oid | string | path | yes | 0000000000000000000000000000000000000000000000000000000000000000 |
curl -X GET -H 'Accept: application/json' 'https://example.com/repos/garden/info/lfs/objects/0000000000000000000000000000000000000000000000000000000000000000'
{
"path": {
"name": "garden",
"oid": "0000000000000000000000000000000000000000000000000000000000000000"
}
}{
"encoding": "raw bytes",
"oid": "0000000000000000000000000000000000000000000000000000000000000000",
"size": 5
}PUT /repos/{name}/info/lfs/objects/{oid}LFS object upload on page URL · auth member (Member) · none
Same object store as /git/{name}/info/lfs/objects/{oid}, served on the page URL. Needs repository.write.
| Name | Type | Location | Required | Example |
|---|---|---|---|---|
name | string | path | yes | garden |
oid | string | path | yes | 0000000000000000000000000000000000000000000000000000000000000000 |
curl -X PUT -H 'Accept: application/json' -H 'X-API-KEY: YOUR_API_KEY' 'https://example.com/repos/garden/info/lfs/objects/0000000000000000000000000000000000000000000000000000000000000000'
{
"path": {
"name": "garden",
"oid": "0000000000000000000000000000000000000000000000000000000000000000"
}
}{
"oid": "0000000000000000000000000000000000000000000000000000000000000000"
}GET /repos/{name}/info/lfs/locksLFS lock list on page URL · auth member (Member) · negotiable
Same lock list as /git/{name}/info/lfs/locks, served on the page URL. Needs repository.read.
| Name | Type | Location | Required | Example |
|---|---|---|---|---|
name | string | path | yes | garden |
limit | integer | query | no | 100 |
cursor | string | query | no |
curl -X GET -H 'Accept: application/json' -H 'X-API-KEY: YOUR_API_KEY' 'https://example.com/repos/garden/info/lfs/locks?limit=100&cursor='
{
"path": {
"name": "garden"
},
"query": {
"cursor": "",
"limit": 100
}
}{
"locks": [
{
"id": "...",
"locked_at": "2026-01-01T00:00:00+00:00",
"owner": {
"name": "lezer"
},
"path": "assets/sprite.bin"
}
]
}POST /repos/{name}/info/lfs/locksLFS lock creation on page URL · auth member (Member) · negotiable
Same lock creation as /git/{name}/info/lfs/locks, served on the page URL. Needs repository.write.
| Name | Type | Location | Required | Example |
|---|---|---|---|---|
name | string | path | yes | garden |
path | string | body | yes | assets/sprite.bin |
curl -X POST -H 'Accept: application/json' -H 'X-API-KEY: YOUR_API_KEY' -H 'Content-Type: application/json' -d '{}' 'https://example.com/repos/garden/info/lfs/locks'{}{
"lock": {
"id": "...",
"locked_at": "2026-01-01T00:00:00+00:00",
"owner": {
"name": "lezer"
},
"path": "assets/sprite.bin"
}
}DELETE /repos/{name}/info/lfs/locks/{id}LFS unlock on page URL · auth member (Member) · negotiable
Same unlock as /git/{name}/info/lfs/locks/{id}, served on the page URL. Needs repository.write.
| Name | Type | Location | Required | Example |
|---|---|---|---|---|
name | string | path | yes | garden |
id | string | path | yes | ... |
force | boolean | body | no | False |
curl -X DELETE -H 'Accept: application/json' -H 'X-API-KEY: YOUR_API_KEY' -H 'Content-Type: application/json' -d '{"force": false}' 'https://example.com/repos/garden/info/lfs/locks/...'{
"body": {
"force": false
},
"path": {
"id": "...",
"name": "garden"
}
}{
"lock": {
"id": "...",
"locked_at": "2026-01-01T00:00:00+00:00",
"owner": {
"name": "lezer"
},
"path": "assets/sprite.bin"
}
}POST /repos/{name}/info/lfs/locks/verifyLFS lock verification on page URL · auth member (Member) · negotiable
Same verification as /git/{name}/info/lfs/locks/verify, served on the page URL. Needs repository.read.
| Name | Type | Location | Required | Example |
|---|---|---|---|---|
name | string | path | yes | garden |
limit | integer | query | no | 100 |
cursor | string | query | no |
curl -X POST -H 'Accept: application/json' -H 'X-API-KEY: YOUR_API_KEY' 'https://example.com/repos/garden/info/lfs/locks/verify?limit=100&cursor='
{
"path": {
"name": "garden"
},
"query": {
"cursor": "",
"limit": 100
}
}{
"locks": [
{
"id": "...",
"locked_at": "2026-01-01T00:00:00+00:00",
"owner": {
"name": "lezer"
},
"path": "assets/sprite.bin"
}
]
}POST /{owner}/{repo}.git/info/lfs/objects/batchLFS batch alias · auth public (guest) · negotiable
GitHub-compatible batch alias. The owner segment is ignored, repos resolve by flat name.
| Name | Type | Location | Required | Example |
|---|---|---|---|---|
owner | string | path | yes | someone |
repo | string | path | yes | garden |
operation | string | body | yes | download |
objects | string | body | yes | [{'oid': '0000000000000000000000000000000000000000000000000000000000000000', 'size': 5}] |
curl -X POST -H 'Accept: application/json' -H 'Content-Type: application/json' -d '{}' 'https://example.com/someone/garden.git/info/lfs/objects/batch'{}{
"hash_algo": "sha256",
"objects": [
{
"oid": "0000000000000000000000000000000000000000000000000000000000000000",
"size": 5
}
],
"transfer": "basic"
}GET /{owner}/{repo}.git/info/lfs/objects/{oid}LFS object download alias · auth public (guest) · none
GitHub-compatible object download alias. The owner segment is ignored.
| Name | Type | Location | Required | Example |
|---|---|---|---|---|
owner | string | path | yes | someone |
repo | string | path | yes | garden |
oid | string | path | yes | 0000000000000000000000000000000000000000000000000000000000000000 |
curl -X GET -H 'Accept: application/json' 'https://example.com/someone/garden.git/info/lfs/objects/0000000000000000000000000000000000000000000000000000000000000000'
{
"path": {
"oid": "0000000000000000000000000000000000000000000000000000000000000000",
"owner": "someone",
"repo": "garden"
}
}{
"encoding": "raw bytes",
"oid": "0000000000000000000000000000000000000000000000000000000000000000",
"size": 5
}PUT /{owner}/{repo}.git/info/lfs/objects/{oid}LFS object upload alias · auth member (Member) · none
GitHub-compatible object upload alias. The owner segment is ignored. Needs repository.write.
| Name | Type | Location | Required | Example |
|---|---|---|---|---|
owner | string | path | yes | someone |
repo | string | path | yes | garden |
oid | string | path | yes | 0000000000000000000000000000000000000000000000000000000000000000 |
curl -X PUT -H 'Accept: application/json' -H 'X-API-KEY: YOUR_API_KEY' 'https://example.com/someone/garden.git/info/lfs/objects/0000000000000000000000000000000000000000000000000000000000000000'
{
"path": {
"oid": "0000000000000000000000000000000000000000000000000000000000000000",
"owner": "someone",
"repo": "garden"
}
}{
"oid": "0000000000000000000000000000000000000000000000000000000000000000"
}GET /{owner}/{repo}.git/info/lfs/locksLFS lock list alias · auth member (Member) · negotiable
GitHub-compatible lock list alias. The owner segment is ignored. Needs repository.read.
| Name | Type | Location | Required | Example |
|---|---|---|---|---|
owner | string | path | yes | someone |
repo | string | path | yes | garden |
limit | integer | query | no | 100 |
cursor | string | query | no |
curl -X GET -H 'Accept: application/json' -H 'X-API-KEY: YOUR_API_KEY' 'https://example.com/someone/garden.git/info/lfs/locks?limit=100&cursor='
{
"path": {
"owner": "someone",
"repo": "garden"
},
"query": {
"cursor": "",
"limit": 100
}
}{
"locks": [
{
"id": "...",
"locked_at": "2026-01-01T00:00:00+00:00",
"owner": {
"name": "lezer"
},
"path": "assets/sprite.bin"
}
]
}POST /{owner}/{repo}.git/info/lfs/locksLFS lock creation alias · auth member (Member) · negotiable
GitHub-compatible lock creation alias. The owner segment is ignored. Needs repository.write.
| Name | Type | Location | Required | Example |
|---|---|---|---|---|
owner | string | path | yes | someone |
repo | string | path | yes | garden |
path | string | body | yes | assets/sprite.bin |
curl -X POST -H 'Accept: application/json' -H 'X-API-KEY: YOUR_API_KEY' -H 'Content-Type: application/json' -d '{}' 'https://example.com/someone/garden.git/info/lfs/locks'{}{
"lock": {
"id": "...",
"locked_at": "2026-01-01T00:00:00+00:00",
"owner": {
"name": "lezer"
},
"path": "assets/sprite.bin"
}
}DELETE /{owner}/{repo}.git/info/lfs/locks/{id}LFS unlock alias · auth member (Member) · negotiable
GitHub-compatible unlock alias. The owner segment is ignored. Needs repository.write.
| Name | Type | Location | Required | Example |
|---|---|---|---|---|
owner | string | path | yes | someone |
repo | string | path | yes | garden |
id | string | path | yes | ... |
force | boolean | body | no | False |
curl -X DELETE -H 'Accept: application/json' -H 'X-API-KEY: YOUR_API_KEY' -H 'Content-Type: application/json' -d '{"force": false}' 'https://example.com/someone/garden.git/info/lfs/locks/...'{
"body": {
"force": false
},
"path": {
"id": "...",
"owner": "someone",
"repo": "garden"
}
}{
"lock": {
"id": "...",
"locked_at": "2026-01-01T00:00:00+00:00",
"owner": {
"name": "lezer"
},
"path": "assets/sprite.bin"
}
}POST /{owner}/{repo}.git/info/lfs/locks/verifyLFS lock verification alias · auth member (Member) · negotiable
GitHub-compatible lock verification alias. The owner segment is ignored. Needs repository.read.
| Name | Type | Location | Required | Example |
|---|---|---|---|---|
owner | string | path | yes | someone |
repo | string | path | yes | garden |
limit | integer | query | no | 100 |
cursor | string | query | no |
curl -X POST -H 'Accept: application/json' -H 'X-API-KEY: YOUR_API_KEY' 'https://example.com/someone/garden.git/info/lfs/locks/verify?limit=100&cursor='
{
"path": {
"owner": "someone",
"repo": "garden"
},
"query": {
"cursor": "",
"limit": 100
}
}{
"locks": [
{
"id": "...",
"locked_at": "2026-01-01T00:00:00+00:00",
"owner": {
"name": "lezer"
},
"path": "assets/sprite.bin"
}
]
}GET /repos/searchGlobal code search · auth member (Member) · negotiable
Search page across every readable repository.
| Name | Type | Location | Required | Example |
|---|---|---|---|---|
q | string | query | no | migrate |
curl -X GET -H 'Accept: application/json' -H 'X-API-KEY: YOUR_API_KEY' 'https://example.com/repos/search?q=migrate'
{
"query": {
"q": "migrate"
}
}{
"query": "",
"scope": "repos-global"
}GET /repos/{name}/searchRepository code search · auth member (Member) · negotiable
Search page scoped to one repository. Needs repository.read.
| Name | Type | Location | Required | Example |
|---|---|---|---|---|
name | string | path | yes | garden |
q | string | query | no | migrate |
curl -X GET -H 'Accept: application/json' -H 'X-API-KEY: YOUR_API_KEY' 'https://example.com/repos/garden/search?q=migrate'
{
"path": {
"name": "garden"
},
"query": {
"q": "migrate"
}
}{
"query": "",
"scope": "repos-one"
}GET /repos/search/apiGlobal code search JSON · auth member (Member) · negotiable
JSON hits plus telemetry. Query q is capped at 500 chars, count clamps to 1-100.
| Name | Type | Location | Required | Example |
|---|---|---|---|---|
q | string | query | no | migrate |
count | integer | query | no | 10 |
curl -X GET -H 'Accept: application/json' -H 'X-API-KEY: YOUR_API_KEY' 'https://example.com/repos/search/api?q=migrate&count=10'
{
"query": {
"count": 10,
"q": "migrate"
}
}{
"results": [],
"scope": "repos-global",
"telemetry": {}
}GET /repos/{name}/search/apiRepository code search JSON · auth member (Member) · negotiable
JSON hits plus telemetry scoped to one repository. Needs repository.read.
| Name | Type | Location | Required | Example |
|---|---|---|---|---|
name | string | path | yes | garden |
q | string | query | no | migrate |
count | integer | query | no | 10 |
curl -X GET -H 'Accept: application/json' -H 'X-API-KEY: YOUR_API_KEY' 'https://example.com/repos/garden/search/api?q=migrate&count=10'
{
"path": {
"name": "garden"
},
"query": {
"count": 10,
"q": "migrate"
}
}{
"results": [],
"scope": "repos-one",
"telemetry": {}
}GET /repos/search/streamGlobal code search stream · auth member (Member) · negotiable
Server-sent stream with result, telemetry, and done events.
| Name | Type | Location | Required | Example |
|---|---|---|---|---|
q | string | query | no | migrate |
curl -X GET -H 'Accept: application/json' -H 'X-API-KEY: YOUR_API_KEY' 'https://example.com/repos/search/stream?q=migrate'
{
"query": {
"q": "migrate"
}
}{
"event": "done"
}GET /repos/{name}/search/streamRepository code search stream · auth member (Member) · negotiable
Server-sent stream scoped to one repository. Needs repository.read.
| Name | Type | Location | Required | Example |
|---|---|---|---|---|
name | string | path | yes | garden |
q | string | query | no | migrate |
curl -X GET -H 'Accept: application/json' -H 'X-API-KEY: YOUR_API_KEY' 'https://example.com/repos/garden/search/stream?q=migrate'
{
"path": {
"name": "garden"
},
"query": {
"q": "migrate"
}
}{
"event": "done"
}GET /repos/{name}/branchesBranches · auth public (guest) · negotiable
Active branches: default, branches with open pull requests, and branches with commits in the last 90 days.
| Name | Type | Location | Required | Example |
|---|---|---|---|---|
name | string | path | yes | garden |
curl -X GET -H 'Accept: application/json' 'https://example.com/repos/garden/branches'
{
"path": {
"name": "garden"
}
}{
"branches": [],
"stale_branches": 0
}GET /repos/{name}/compareCompare branches · auth member (Member) · negotiable
Merge check, commits and diff between a base and a head branch, plus the creation form.
| Name | Type | Location | Required | Example |
|---|---|---|---|---|
name | string | path | yes | garden |
base | string | query | no | main |
head | string | query | no | feature |
curl -X GET -H 'Accept: application/json' -H 'X-API-KEY: YOUR_API_KEY' 'https://example.com/repos/garden/compare?base=main&head=feature'
{
"path": {
"name": "garden"
},
"query": {
"base": "main",
"head": "feature"
}
}{
"check": {
"status": "mergeable"
}
}GET /repos/pullsAll pull requests · auth member (Member) · negotiable
Pull requests across every readable repository with status, review, draft, merge, author and involvement filters.
| Name | Type | Location | Required | Example |
|---|---|---|---|---|
state | string | query | no | None |
involved | string | query | no | None |
curl -X GET -H 'Accept: application/json' -H 'X-API-KEY: YOUR_API_KEY' 'https://example.com/repos/pulls?state=open&involved=authored'
{
"query": {
"involved": "authored",
"state": "open"
}
}{
"counts": {},
"pulls": []
}GET /repos/{name}/pullsPull requests · auth public (guest) · negotiable
Pull requests of one repository with status tabs and filters.
| Name | Type | Location | Required | Example |
|---|---|---|---|---|
name | string | path | yes | garden |
state | string | query | no | None |
review | string | query | no | None |
curl -X GET -H 'Accept: application/json' 'https://example.com/repos/garden/pulls?state=open&review=any'
{
"path": {
"name": "garden"
},
"query": {
"review": "any",
"state": "open"
}
}{
"counts": {
"open": 0
},
"pulls": []
}POST /repos/{name}/pullsCreate pull request · auth member (Member) · negotiable
Opens a pull request from head into base. Needs repository.write.
| Name | Type | Location | Required | Example |
|---|---|---|---|---|
name | string | path | yes | garden |
base | string | body | yes | main |
head | string | body | yes | feature |
title | string | body | yes | Add feature |
body | string | body | no | None |
reviewers | string | body | no | cleo |
curl -X POST -H 'Accept: application/json' -H 'X-API-KEY: YOUR_API_KEY' -H 'Content-Type: application/json' -d '{}' 'https://example.com/repos/garden/pulls'{}{
"ok": true,
"redirect": "/repos/garden/pulls/1"
}GET /repos/{name}/pulls/{number}Pull request · auth public (guest) · negotiable
Conversation, commits or files changed of one pull request, with merge box and reviewers.
| Name | Type | Location | Required | Example |
|---|---|---|---|---|
name | string | path | yes | garden |
number | integer | path | yes | 1 |
tab | string | query | no | None |
curl -X GET -H 'Accept: application/json' 'https://example.com/repos/garden/pulls/1?tab=conversation'
{
"path": {
"name": "garden",
"number": 1
},
"query": {
"tab": "conversation"
}
}{
"pull": {
"number": 1
}
}POST /repos/{name}/pulls/{number}/editEdit pull request · auth member (Member) · negotiable
Changes title, description or base branch. Author or writers, open pull requests only.
| Name | Type | Location | Required | Example |
|---|---|---|---|---|
name | string | path | yes | garden |
number | integer | path | yes | 1 |
title | string | body | no | None |
body | string | body | no | None |
base | string | body | no | None |
curl -X POST -H 'Accept: application/json' -H 'X-API-KEY: YOUR_API_KEY' -H 'Content-Type: application/json' -d '{}' 'https://example.com/repos/garden/pulls/1/edit'{}null
POST /repos/{name}/pulls/{number}/wipToggle work in progress · auth member (Member) · negotiable
Adds or removes the work-in-progress title prefix.
| Name | Type | Location | Required | Example |
|---|---|---|---|---|
name | string | path | yes | garden |
number | integer | path | yes | 1 |
curl -X POST -H 'Accept: application/json' -H 'X-API-KEY: YOUR_API_KEY' -H 'Content-Type: application/json' -d '{}' 'https://example.com/repos/garden/pulls/1/wip'{}null
POST /repos/{name}/pulls/{number}/closeClose pull request · auth member (Member) · negotiable
Closes an open pull request. Author or writers.
| Name | Type | Location | Required | Example |
|---|---|---|---|---|
name | string | path | yes | garden |
number | integer | path | yes | 1 |
curl -X POST -H 'Accept: application/json' -H 'X-API-KEY: YOUR_API_KEY' -H 'Content-Type: application/json' -d '{}' 'https://example.com/repos/garden/pulls/1/close'{}null
POST /repos/{name}/pulls/{number}/reopenReopen pull request · auth member (Member) · negotiable
Reopens a closed pull request when both branches exist.
| Name | Type | Location | Required | Example |
|---|---|---|---|---|
name | string | path | yes | garden |
number | integer | path | yes | 1 |
curl -X POST -H 'Accept: application/json' -H 'X-API-KEY: YOUR_API_KEY' -H 'Content-Type: application/json' -d '{}' 'https://example.com/repos/garden/pulls/1/reopen'{}null
POST /repos/{name}/pulls/{number}/commentsComment · auth member (Member) · negotiable
Adds a conversation comment; action=close closes the pull request as well.
| Name | Type | Location | Required | Example |
|---|---|---|---|---|
name | string | path | yes | garden |
number | integer | path | yes | 1 |
body | string | body | no | None |
action | string | body | no | None |
curl -X POST -H 'Accept: application/json' -H 'X-API-KEY: YOUR_API_KEY' -H 'Content-Type: application/json' -d '{}' 'https://example.com/repos/garden/pulls/1/comments'{}null
POST /repos/{name}/pulls/{number}/comments/{comment_uid}/editEdit comment · auth member (Member) · negotiable
Edits your own comment.
| Name | Type | Location | Required | Example |
|---|---|---|---|---|
name | string | path | yes | garden |
number | integer | path | yes | 1 |
comment_uid | string | path | yes | None |
body | string | body | yes | None |
curl -X POST -H 'Accept: application/json' -H 'X-API-KEY: YOUR_API_KEY' -H 'Content-Type: application/json' -d '{}' 'https://example.com/repos/garden/pulls/1/comments/{comment_uid}/edit'{}null
POST /repos/{name}/pulls/{number}/comments/{comment_uid}/deleteDelete comment · auth member (Member) · negotiable
Deletes your own comment; repository administrators may delete any comment.
| Name | Type | Location | Required | Example |
|---|---|---|---|---|
name | string | path | yes | garden |
number | integer | path | yes | 1 |
comment_uid | string | path | yes | None |
curl -X POST -H 'Accept: application/json' -H 'X-API-KEY: YOUR_API_KEY' -H 'Content-Type: application/json' -d '{}' 'https://example.com/repos/garden/pulls/1/comments/{comment_uid}/delete'{}null
POST /repos/{name}/pulls/{number}/code-commentsLine comment · auth member (Member) · negotiable
Comments on a diff line as a single comment or as part of your pending review; thread replies to a conversation.
| Name | Type | Location | Required | Example |
|---|---|---|---|---|
name | string | path | yes | garden |
number | integer | path | yes | 1 |
body | string | body | yes | None |
mode | string | body | no | None |
path | string | body | no | None |
side | string | body | no | None |
line | integer | body | no | None |
thread | string | body | no | None |
curl -X POST -H 'Accept: application/json' -H 'X-API-KEY: YOUR_API_KEY' -H 'Content-Type: application/json' -d '{}' 'https://example.com/repos/garden/pulls/1/code-comments'{}null
POST /repos/{name}/pulls/{number}/threads/{thread_uid}/{action}Resolve conversation · auth member (Member) · negotiable
Resolves or unresolves a conversation. Author, writers and official reviewers.
| Name | Type | Location | Required | Example |
|---|---|---|---|---|
name | string | path | yes | garden |
number | integer | path | yes | 1 |
thread_uid | string | path | yes | None |
action | string | path | yes | None |
curl -X POST -H 'Accept: application/json' -H 'X-API-KEY: YOUR_API_KEY' -H 'Content-Type: application/json' -d '{}' 'https://example.com/repos/garden/pulls/1/threads/{thread_uid}/{action}'{}null
POST /repos/{name}/pulls/{number}/reviewsSubmit review · auth member (Member) · negotiable
Submits a review: approve, comment or reject (request changes). Authors cannot approve or reject their own pull request.
| Name | Type | Location | Required | Example |
|---|---|---|---|---|
name | string | path | yes | garden |
number | integer | path | yes | 1 |
type | string | body | yes | None |
body | string | body | no | None |
curl -X POST -H 'Accept: application/json' -H 'X-API-KEY: YOUR_API_KEY' -H 'Content-Type: application/json' -d '{}' 'https://example.com/repos/garden/pulls/1/reviews'{}null
POST /repos/{name}/pulls/{number}/reviews/discardDiscard pending review · auth member (Member) · negotiable
Deletes your pending review and its pending comments.
| Name | Type | Location | Required | Example |
|---|---|---|---|---|
name | string | path | yes | garden |
number | integer | path | yes | 1 |
curl -X POST -H 'Accept: application/json' -H 'X-API-KEY: YOUR_API_KEY' -H 'Content-Type: application/json' -d '{}' 'https://example.com/repos/garden/pulls/1/reviews/discard'{}null
POST /repos/{name}/pulls/{number}/reviews/{review_uid}/dismissDismiss review · auth member (Member) · negotiable
Dismisses an approval or change request with a message. Repository administrators only.
| Name | Type | Location | Required | Example |
|---|---|---|---|---|
name | string | path | yes | garden |
number | integer | path | yes | 1 |
review_uid | string | path | yes | None |
message | string | body | yes | None |
curl -X POST -H 'Accept: application/json' -H 'X-API-KEY: YOUR_API_KEY' -H 'Content-Type: application/json' -d '{}' 'https://example.com/repos/garden/pulls/1/reviews/{review_uid}/dismiss'{}null
POST /repos/{name}/pulls/{number}/reviewersRequest review · auth member (Member) · negotiable
Requests or re-requests a review from a user who can read the repository.
| Name | Type | Location | Required | Example |
|---|---|---|---|---|
name | string | path | yes | garden |
number | integer | path | yes | 1 |
user | string | body | yes | cleo |
curl -X POST -H 'Accept: application/json' -H 'X-API-KEY: YOUR_API_KEY' -H 'Content-Type: application/json' -d '{}' 'https://example.com/repos/garden/pulls/1/reviewers'{}null
POST /repos/{name}/pulls/{number}/reviewers/{user_uid}/removeRemove review request · auth member (Member) · negotiable
Removes a pending review request.
| Name | Type | Location | Required | Example |
|---|---|---|---|---|
name | string | path | yes | garden |
number | integer | path | yes | 1 |
user_uid | string | path | yes | None |
curl -X POST -H 'Accept: application/json' -H 'X-API-KEY: YOUR_API_KEY' -H 'Content-Type: application/json' -d '{}' 'https://example.com/repos/garden/pulls/1/reviewers/{user_uid}/remove'{}null
POST /repos/{name}/pulls/{number}/viewedMark file viewed · auth member (Member) · negotiable
Marks or unmarks a changed file as viewed for yourself.
| Name | Type | Location | Required | Example |
|---|---|---|---|---|
name | string | path | yes | garden |
number | integer | path | yes | 1 |
path | string | body | yes | None |
viewed | boolean | body | no | None |
curl -X POST -H 'Accept: application/json' -H 'X-API-KEY: YOUR_API_KEY' -H 'Content-Type: application/json' -d '{}' 'https://example.com/repos/garden/pulls/1/viewed'{}null
GET /repos/{name}/pulls/{number}/checkMerge status · auth public (guest) · negotiable
Current merge status, advisory warnings and assisted merge availability.
| Name | Type | Location | Required | Example |
|---|---|---|---|---|
name | string | path | yes | garden |
number | integer | path | yes | 1 |
curl -X GET -H 'Accept: application/json' 'https://example.com/repos/garden/pulls/1/check'
{
"path": {
"name": "garden",
"number": 1
}
}{
"pull": {
"merge_status": "mergeable"
},
"warnings": []
}POST /repos/{name}/pulls/{number}/delete-branchDelete head branch · auth member (Member) · negotiable
Deletes the head branch of a closed or merged pull request when it has no new commits.
| Name | Type | Location | Required | Example |
|---|---|---|---|---|
name | string | path | yes | garden |
number | integer | path | yes | 1 |
curl -X POST -H 'Accept: application/json' -H 'X-API-KEY: YOUR_API_KEY' -H 'Content-Type: application/json' -d '{}' 'https://example.com/repos/garden/pulls/1/delete-branch'{}null
POST /repos/{name}/pulls/{number}/restore-branchRestore head branch · auth member (Member) · negotiable
Recreates a deleted head branch from refs/pull/N/head.
| Name | Type | Location | Required | Example |
|---|---|---|---|---|
name | string | path | yes | garden |
number | integer | path | yes | 1 |
curl -X POST -H 'Accept: application/json' -H 'X-API-KEY: YOUR_API_KEY' -H 'Content-Type: application/json' -d '{}' 'https://example.com/repos/garden/pulls/1/restore-branch'{}null
POST /repos/{name}/pulls/{number}/mergeMerge pull request · auth member (Member) · negotiable
Starts a merge job: merge, rebase, rebase-merge, squash, fast-forward-only or manually-merged; assisted=1 resolves conflicts with the assistant. Writers may merge their own pull requests.
| Name | Type | Location | Required | Example |
|---|---|---|---|---|
name | string | path | yes | garden |
number | integer | path | yes | 1 |
style | string | body | no | None |
title | string | body | no | None |
message | string | body | no | None |
commit | string | body | no | None |
delete_branch | boolean | body | no | None |
assisted | boolean | body | no | None |
acknowledged | string | body | no | None |
curl -X POST -H 'Accept: application/json' -H 'X-API-KEY: YOUR_API_KEY' -H 'Content-Type: application/json' -d '{}' 'https://example.com/repos/garden/pulls/1/merge'{}{
"data": {
"job": "..."
},
"ok": true
}POST /repos/{name}/pulls/{number}/updateUpdate branch · auth member (Member) · negotiable
Merges the base branch into the head branch when that merge is clean.
| Name | Type | Location | Required | Example |
|---|---|---|---|---|
name | string | path | yes | garden |
number | integer | path | yes | 1 |
curl -X POST -H 'Accept: application/json' -H 'X-API-KEY: YOUR_API_KEY' -H 'Content-Type: application/json' -d '{}' 'https://example.com/repos/garden/pulls/1/update'{}null
GET /repos/{name}/pulls/{number}/merge/jobs/{job_uid}Merge job · auth public (guest) · negotiable
State of a merge job.
| Name | Type | Location | Required | Example |
|---|---|---|---|---|
name | string | path | yes | garden |
number | integer | path | yes | 1 |
job_uid | string | path | yes | None |
curl -X GET -H 'Accept: application/json' 'https://example.com/repos/garden/pulls/1/merge/jobs/{job_uid}'{
"path": {
"name": "garden",
"number": 1
}
}{
"job": {
"status": "running"
}
}GET /repos/{name}/pulls/{number}/merge/jobs/{job_uid}/streamMerge job stream · auth public (guest) · negotiable
Server-sent events: line, phase, telemetry, state, cleanup, error, result, done.
| Name | Type | Location | Required | Example |
|---|---|---|---|---|
name | string | path | yes | garden |
number | integer | path | yes | 1 |
job_uid | string | path | yes | None |
after | integer | query | no | None |
curl -X GET -H 'Accept: application/json' 'https://example.com/repos/garden/pulls/1/merge/jobs/{job_uid}/stream'{
"path": {
"name": "garden",
"number": 1
}
}{
"event": "done"
}POST /repos/{name}/pulls/{number}/merge/jobs/{job_uid}/cancelCancel merge job · auth member (Member) · negotiable
Cancels a running merge job; cleanup always runs. Starter or repository administrators.
| Name | Type | Location | Required | Example |
|---|---|---|---|---|
name | string | path | yes | garden |
number | integer | path | yes | 1 |
job_uid | string | path | yes | None |
curl -X POST -H 'Accept: application/json' -H 'X-API-KEY: YOUR_API_KEY' -H 'Content-Type: application/json' -d '{}' 'https://example.com/repos/garden/pulls/1/merge/jobs/{job_uid}/cancel'{}null
POST /repos/{name}/settings/pullsPull request settings · auth member (Member) · negotiable
Allowed merge styles, default style, branch deletion default, manual merge, merge detection and assisted merging.
| Name | Type | Location | Required | Example |
|---|---|---|---|---|
name | string | path | yes | garden |
merge_styles | string | body | no | None |
default_merge_style | string | body | no | None |
assisted_merge | boolean | body | no | None |
curl -X POST -H 'Accept: application/json' -H 'X-API-KEY: YOUR_API_KEY' -H 'Content-Type: application/json' -d '{}' 'https://example.com/repos/garden/settings/pulls'{}null
POST /admin/users/{uid}/login-asImpersonate account · auth admin (Admin) · negotiable
Switches into the account with a stacked session. Senior administrators and deactivated accounts are refused.
| Name | Type | Location | Required | Example |
|---|---|---|---|---|
uid | string | path | yes | None |
curl -X POST -H 'Accept: application/json' -H 'X-API-KEY: YOUR_API_KEY' 'https://example.com/admin/users/{uid}/login-as'{
"data": {
"impersonated_by": {
"uid": "..."
},
"uid": "..."
},
"ok": true,
"redirect": "/"
}POST /admin/login-as/exitExit impersonation · auth admin (Admin) · negotiable
Deletes the impersonated session and restores the administrator cookie.
curl -X POST -H 'Accept: application/json' -H 'X-API-KEY: YOUR_API_KEY' 'https://example.com/admin/login-as/exit'
{
"data": {
"impersonated_by": null
},
"ok": true,
"redirect": "/admin/users"
}