Endpoints

All endpoints below are under the base path https://api.tapeto.dev/api/v1. Every route requires authentication — see Authentication.

Conversions

Create a conversion

POST /conversions

{
  "project_id": "uuid",
  "builder": "gutenberg",
  "metadata": { "custom": "data" }
}

builder is one of gutenberg, elementor, oxygen, divi — availability depends on your plan. The project must already be parsed (POST /projects/:id/parse) before you can convert it.

{
  "ok": true,
  "data": { "conversion": { "id": "uuid", "status": "queued", "...": "..." } },
  "message": "Conversion queued successfully. Check status with GET /conversions/:id"
}

Possible errors: 404 if the project doesn’t exist or isn’t yours, 422 if it hasn’t been parsed yet, 403 if the builder isn’t available on your plan.

List conversions

GET /conversions?page=1&project_id=uuid&builder=gutenberg&status=completed

{
  "ok": true,
  "data": {
    "conversions": [
      {
        "id": "uuid",
        "project_id": "uuid",
        "builder": "elementor",
        "status": "completed",
        "progress": 100,
        "fidelity_score": 87,
        "output_data": { "...": "..." },
        "created_at": "...",
        "updated_at": "..."
      }
    ],
    "meta": { "page": 1, "pageSize": 20, "total": 150, "totalPages": 8 }
  }
}

Get / retry / delete a conversion

GET    /conversions/:id
PATCH  /conversions/:id
DELETE /conversions/:id
POST   /conversions/:id/retry

Push to WordPress

POST /conversions/:id/push

Requires a configured WordPress connection (connection_id). Supported for gutenberg and elementor builders only.

{
  "ok": true,
  "data": {
    "page_id": 123,
    "page_title": "Home",
    "page_url": "https://example.com/home",
    "edit_url": "https://example.com/wp-admin/post.php?post=123&action=edit",
    "preview_url": "https://example.com/home",
    "elementor_injected": true
  }
}

Download / export

GET /conversions/:id/download
GET /conversions/:id/file?part=page|header|footer|sidebar
GET /conversions/:id/export?format=wxr

export?format=wxr returns a WordPress eXtended RSS file, importable natively via Tools → Import on any WordPress site.

Webhooks PRO

Outgoing webhooks are available on the Studio plan. Up to 10 endpoints per account, signed with HMAC-SHA256.

GET    /webhooks
POST   /webhooks
GET    /webhooks/:id
PATCH  /webhooks/:id
DELETE /webhooks/:id
GET    /webhooks/:id/deliveries
POST   /webhooks/:id/test

Supported events: conversion.completed, conversion.failed, project.created, export.ready, or * to subscribe to all of them.

Builder availability by plan

Requesting a builder your plan doesn’t include returns 403 BUILDER_NOT_ALLOWED.