SponsoredDeveloper Deals

Markdown API Reference Generator

Design REST API documentation for GitHub READMEs, GitBook, and Docusaurus with parameter tables, cURL snippets, and response models.

HTTP Method:

Requires Bearer Auth

Endpoint Basics

Path / Route

Summary / Headline

Detailed Description (optional)

Query Parameters (2)

Req

JSON Body Fields (3)

Req

Live Generated API Documentation (.md)1669 characters

## `POST /api/v1/projects`

![POST](https://img.shields.io/badge/POST-green?style=for-the-badge)

**Create a new project workspace**

Initializes a new cloud project workspace with default environment variables and git repository linking.

> **Authentication Required**: Include your Bearer API token in the `Authorization` header.

### Request Headers

| Header | Value | Description |
|:---|:---|:---|
| `Content-Type` | `application/json` | Payload format |
| `Accept` | `application/json` | Preferred response media type |

### Query Parameters

| Parameter | Type | Required | Description |
|:---|:---|:---|:---|
| `teamId` | `string` | No | Optional organization team UUID |
| `dryRun` | `boolean` | No | Validate request without creating resources |

### Request Body Schema

| Field | Type | Required | Description |
|:---|:---|:---|:---|
| `name` | `string` | **Yes** | Unique human-readable project title |
| `region` | `string` | No | Deployment region (default: us-east-1) |
| `isPrivate` | `boolean` | **Yes** | Whether the repo is publicly visible |

### cURL Example

```bash
curl -X POST "https://api.example.com/api/v1/projects" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json"
  -d '{"example": "value"}' \
```

### Responses

#### `201` — Project successfully provisioned

```json
{
  "id": "proj_99af28c3",
  "name": "Acme Web App",
  "status": "active",
  "createdAt": "2026-09-05T12:00:00Z"
}
```

#### `400` — Invalid request payload or missing required parameters

```json
{
  "error": "validation_failed",
  "message": "Field 'name' is required and must not be empty."
}
```

SponsoredDeveloper Deals

Complete Guide & Overview

Markdown API Reference & REST Endpoint Documentation Generator

Generate clean, structured REST API documentation for your GitHub repositories, developer portals, GitBook, and Docusaurus. Includes automated cURL command examples, parameter tables, and JSON response models.

How to Use the Markdown API Reference & REST Endpoint Documentation Generator

Input Content

Paste or compose your markdown or source data into the input editor.

Customize Settings

Select formatting options, syntax modes, or display options.

Copy or Download

Copy the processed output to your clipboard or download the generated file.

Key Features & Capabilities

Shields.io HTTP Badges: Automatically renders eye-catching badges for GET, POST, PUT, PATCH, and DELETE endpoints.

Parameter Schema Tables: Generates GFM tables for query parameters, headers, and request body attributes.

Automated cURL Generator: Generates ready-to-execute cURL terminal commands matching your schema.

Multi-Status Responses: Document success 200/201 and error 400/404/500 JSON response payloads with clean syntax.

Client-Side Privacy: Your proprietary API endpoints and parameters never touch any backend server.

Frequently Asked Questions

Is the generated Markdown compatible with GitHub and GitLab?

Yes! All tables, code blocks, shields badges, and blockquotes adhere strictly to GitHub Flavored Markdown (GFM) and render identically on GitHub, GitLab, and Docusaurus.

How are authentication headers handled?

When 'Requires Bearer Auth' is enabled, the generator automatically includes an informative callout box and adds the `-H 'Authorization: Bearer YOUR_API_KEY'` header to the cURL example snippet.

Workflow Continuity

Related Markdown Tools

View all 123 tools

Tables

Table Generator

Interactive visual spreadsheet grid for designing and formatting Markdown pipe tables.

Open Tool

Converters

JSON to Markdown

Transform structured JSON arrays and objects into pipe tables, bullet trees, or key-value cards.

Open Tool

Generators

Markdown Docs Sidebar Generator

Generate Nextra _meta.json, Docusaurus sidebars.js, and GitBook SUMMARY.md navigation from Markdown files.

Open Tool

Security & Analysis

Code Block Extractor

Extract, filter by language (JS, Python, TS, Go), and download code blocks from documents.

Open Tool

SponsoredDeveloper Deals