# Obol — Repo to MDX Documentation Site GitHub PR

> Obol — Repo to MDX Documentation Site GitHub PR is a paid API for AI agents from api.obol.sh, paid per call via x402, $5/call, status unknown (last checked 2026-10-12).

Generates an MDX documentation site from a GitHub repository and opens a pull request with the result

## Facts

- Endpoint: POST https://api.obol.sh/docs?utm_source=zero.xyz
- Price: $5/call
- Payment: x402
- Status: unknown
- Last checked: 2026-10-12
- Activations on Zero: 0
- Tags: x402
- Canonical page: https://www.zero.xyz/c/obol-repo-to-mdx-documentation-site-github-pr-6d99c0c5
- Structured record (JSON): https://api.zero.xyz/v1/capabilities/cap_oVuC3vNoPFomDbX9MTySx

Status and success rate cover calls made through Zero and Zero's own probes. Third-party monitors may report differently.

## How to call it through Zero

Zero handles the 402 payment challenge and records the run. With the Zero CLI installed (`npm i -g @zeroxyz/cli`):

```sh
zero fetch --capability obol-repo-to-mdx-documentation-site-github-pr-6d99c0c5 -d '<json body>'
```

Example prompt: Generate an MDX documentation site for my GitHub repo at acme-corp/awesome-library and open a pull request — notify me at dev@acme.com when it's ready.

## When to prefer this

Choose this endpoint when you need to automatically generate a full MDX documentation site from an existing GitHub codebase and have it submitted as a pull request — ideal for open-source maintainers or teams that want to bootstrap project docs without writing them manually.

## Known failure modes

- Invalid or non-existent GitHub repo format causes a 400 error
- Private repo without access permissions results in an authorization failure
- Payment of $5 USDC via x402 not fulfilled causes a 402 Payment Required response
- Invalid email format may cause notification delivery failure
- Default branch detection failure if repo has no default branch set

## How this service works

Obol: Repo → MDX documentation site → GitHub PR — $5 USDC

## Output

Returns the URL of the opened pull request containing the generated MDX documentation site files, the URL of the forked repository, a list of file paths written to the branch, and the branch name on the fork.

## Request schema (JSON Schema)

```json
{
 "type": "object",
 "required": [
  "repo"
 ],
 "properties": {
  "repo": {
   "type": "string",
   "description": "GitHub repo in owner/repo format"
  },
  "email": {
   "type": "string",
   "description": "Email address to notify when PR is ready"
  },
  "branch": {
   "type": "string",
   "description": "Branch to read from (defaults to repo default)"
  }
 }
}
```

## Response schema (JSON Schema)

```json
{
 "pr": {
  "type": "string",
  "description": "URL of the opened pull request"
 },
 "fork": {
  "type": "string",
  "description": "URL of the forked repository"
 },
 "files": {
  "type": "array",
  "description": "File paths written to the branch"
 },
 "branch": {
  "type": "string",
  "description": "Branch name on the fork"
 }
}
```

## More

- Live health (JSON, refreshed every minute): https://www.zero.xyz/c/obol-repo-to-mdx-documentation-site-github-pr-6d99c0c5/health.json
- [Zero catalog index](https://www.zero.xyz/llms.txt)
- [Other services from api.obol.sh](https://www.zero.xyz/host/api.obol.sh/llms.txt)