API Overview

This portal provides a public overview of the Apropo API surface used for project and structure management.

Where to start

1. Review the authentication requirements in Authentication.
2. Review the required draft structure syntax in Structure Markdown Format.
3. Use the request and response samples in Examples.
4. Browse the full endpoint contract in API Reference.
5. Check Coverage and integration readiness before shipping your integration.

Scope

The current public documentation covers these API groups:

• workspaces and work types,
• project metadata and lifecycle operations,
• project structure read and update operations,
• library elements and estimates,
• taxonomy assistance,
• draft validation and draft creation workflows.

Example markdown for draft/init

When you call POST /api/project/ai/draft/init, the most important field is structure_markdown. This markdown defines the initial project structure that will be stored in the draft.

For the full syntax guide, validation rules, invalid examples, and JSON request shape, see Structure Markdown Format.

Example:

Service Planner
===

# Core

* description | Core business capabilities of the platform.
  ** worktypes | Backend, Frontend

## Authentication

* description | Login, registration and session management.

### Login

* description | User login flow.

#### Validate credentials

* description | Validate submitted credentials against identity provider.

- Backend: 6 h
- Frontend: 2 h
  ===
  ===
  ===
  ===

Example request payload:

{
  "workspace": "83bd8a7f-6af6-4fa3-930d-e1fcf2a0db30",
  "requirements_summary": "Build a SaaS workspace for planning software delivery, including authentication, project structure management, and export-ready estimates.",
  "project_type": "saas",
  "draft_name": "AI Draft - Service Planner",
  "structure_markdown": "Service Planner\n===\n# Core\n* description | Core business capabilities of the platform.\n** worktypes | Backend, Frontend\n## Authentication\n* description | Login, registration and session management.\n### Login\n* description | User login flow.\n#### Validate credentials\n* description | Validate submitted credentials against identity provider.\n- Backend: 6 h\n- Frontend: 2 h\n===\n===\n===\n==="
}

Example success response:

{
  "project_uuid": "8f9d0d4f-1f00-4a17-9dd5-f4a90d1f73c2",
  "draft_project_uuid": "8f9d0d4f-1f00-4a17-9dd5-f4a90d1f73c2",
  "draft_url": "https://app.example.invalid/home/editor/project/8f9d0d4f-1f00-4a17-9dd5-f4a90d1f73c2",
  "ai_draft_status": "queued"
}

Use this as a starting template and adjust the names, descriptions, work types, and estimates to your own project.

Important rules:

• the first line is the project name,
• #, ##, ###, and #### define the hierarchy,
• ** worktypes | ... belongs at the section level,
• estimates such as - Backend: 6 h should be added on the lowest level you use,
• every opened block must be closed with a standalone === line.

For a full end-to-end example, including validation and draft creation, see Examples.

Public documentation principles

This portal is intentionally written for external consumers. It focuses on request contracts, authentication, example payloads, and integration behavior. Internal implementation details, repository layout, deployment notes, and operational procedures are excluded from the public surface.