POST/organizations/{organizationId}/projects/{projectId}/documents

Create a project document

Creates a draft document with Markdown content and optional labels.

Send request

Use the documented inputs to call this endpoint directly.

API serverbase URL

Bearer tokenBearerAuthoptional

Stored only in this browser for the BearerAuth security scheme and reused on every API page in this group.

Parameters

Values are applied to the request and the example on the right.

organizationIdpath · stringrequired

Opaque organization identifier.

projectIdpath · stringrequired

Idempotency-Keyheader · string · uuidoptional

Unique key for retry-safe writes, retained for 24 hours.

Request body

application/jsonrequired

titlestringrequired

contentstringrequired

labelsarray<string>optional

reviewer_idsarray<string>optional

Responses

201application/json

Draft created.

{
  "id": "doc_01J8F8W4S3P2N9B6M7K5Q1R0T",
  "project_id": "prj_01J8F5KM4MAB0V7YQ6P3N2R8D1",
  "title": "Mobile launch runbook",
  "slug": "mobile-launch-runbook",
  "content": "# Launch checklist\n\n- Verify monitoring\n- Approve release",
  "state": "published",
  "version": 4,
  "labels": [
    "release",
    "mobile"
  ],
  "review_state": "approved",
  "published_at": "2026-09-02T18:00:00Z",
  "etag": "W/\"document-4\""
}

idstringoptional

project_idstringoptional

titlestringoptional

slugstringoptional

contentstringoptional

statestringoptional

versionintegeroptional

labelsarray<string>optional

review_statestringoptional

published_atobject · date-timeoptional

etagstringoptional

422

Document fields are invalid.

curl --request POST \ 'https://api.demo.heyo.example/v3/organizations/org_01J8F1Q6N6VTX4E8W9R2D0A7B3/projects/prj_01J8F5KM4MAB0V7YQ6P3N2R8D1/documents' \ --header 'Idempotency-Key: 5ba89923-8c6d-44a3-9ab7-2fbbdb865f9a' \ --header 'Content-Type: application/json' \ --data '{ "title": "Mobile launch runbook", "content": "# Launch checklist\n\n- Verify monitoring\n- Approve release", "labels": [ "release", "mobile" ], "reviewer_ids": [ "mem_01J8F3D2P9Q7V6N5M4K" ]}'

{ "id": "doc_01J8F8W4S3P2N9B6M7K5Q1R0T", "project_id": "prj_01J8F5KM4MAB0V7YQ6P3N2R8D1", "title": "Mobile launch runbook", "slug": "mobile-launch-runbook", "content": "# Launch checklist\n\n- Verify monitoring\n- Approve release", "state": "published", "version": 4, "labels": [ "release", "mobile" ], "review_state": "approved", "published_at": "2026-09-02T18:00:00Z", "etag": "W/\"document-4\""}