Encelade API Docs

Public Projects

List projects

GET
/api/public/v1/projects

Authorization

apiKey
x-api-key<token>

In: header

Query Parameters

cursor?string

Pagination cursor from a previous response.

limit?integer

Maximum number of projects to return.

Default20
Range1 <= value <= 100
endUserEmail?string

Filter projects by the end-user email set during generation.

Formatemail

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/public/v1/projects"
{
  "projects": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "pid": "string",
      "name": "string",
      "theme": "default",
      "brandingId": null,
      "pageLayersScrollable": true,
      "pageAspectRatio": "16:9",
      "pageGridEnabled": false,
      "pageGridType": "12-column",
      "pageNumbersEnabled": false,
      "linkShareToken": "string",
      "linkAccess": "tenant",
      "linkRole": "owner",
      "publishSlug": null,
      "isPublished": false,
      "publishedAt": null,
      "ogImageUrl": null,
      "publishDescription": null,
      "lockedThemeMode": null,
      "showMadeWithEncelade": false,
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "pinnedAt": null,
      "firstPageId": "2f8ddfb6-97dc-4f88-8a30-be55455ab046",
      "members": [
        {
          "id": "string",
          "userId": "string",
          "name": "string",
          "email": "string",
          "avatar": "string",
          "role": {
            "id": "owner",
            "name": "string"
          }
        }
      ]
    }
  ],
  "nextCursor": null,
  "hasMore": false
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string"
}

Get a project by pid

GET
/api/public/v1/projects/{pid}

Authorization

apiKey
x-api-key<token>

In: header

Path Parameters

pid*string

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/public/v1/projects/string"
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "pid": "string",
  "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
  "name": "string",
  "theme": "default",
  "themeDefinitionSnapshot": {
    "light": {
      "surface": "string",
      "panel": "string",
      "border": "string",
      "accent": "string",
      "accentMuted": "string",
      "text": "string",
      "mutedText": "string",
      "fontFamily": "string",
      "headingFontFamily": "string",
      "pageBackground": [],
      "layerBackground": {
        "type": "color",
        "value": "string",
        "tint": "string"
      },
      "layerBorder": {
        "radius": 0,
        "width": 0,
        "type": "color",
        "value": "string",
        "side": "all",
        "sideWidths": {
          "property1": 0,
          "property2": 0
        }
      },
      "layerShadow": "drop-shadow-none",
      "chartColors": [
        "string"
      ]
    },
    "dark": {
      "surface": "string",
      "panel": "string",
      "border": "string",
      "accent": "string",
      "accentMuted": "string",
      "text": "string",
      "mutedText": "string",
      "fontFamily": "string",
      "headingFontFamily": "string",
      "pageBackground": [],
      "layerBackground": {
        "type": "color",
        "value": "string",
        "tint": "string"
      },
      "layerBorder": {
        "radius": 0,
        "width": 0,
        "type": "color",
        "value": "string",
        "side": "all",
        "sideWidths": {
          "property1": 0,
          "property2": 0
        }
      },
      "layerShadow": "drop-shadow-none",
      "chartColors": [
        "string"
      ]
    },
    "fonts": [
      {
        "id": "string",
        "label": "string",
        "family": "string",
        "url": "http://example.com",
        "mimeType": "string",
        "sizeBytes": 0,
        "assetId": "string",
        "storageKey": "string",
        "weight": 0,
        "style": "string"
      }
    ]
  },
  "brandingId": null,
  "pageLayersScrollable": true,
  "pageAspectRatio": "16:9",
  "pageGridEnabled": false,
  "pageGridType": "12-column",
  "pageNumbersEnabled": false,
  "linkShareToken": "string",
  "linkAccess": "tenant",
  "linkRole": "owner",
  "publishSlug": null,
  "isPublished": false,
  "publishedAt": null,
  "ogImageUrl": null,
  "publishDescription": null,
  "lockedThemeMode": null,
  "showMadeWithEncelade": false,
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "pinnedAt": null,
  "backgroundPresets": [],
  "pages": [
    {
      "pageBackground": [],
      "presentModeAnimation": "layers-staggered",
      "currentSelectedLayerId": null,
      "currentSelectedLayerType": null,
      "speakerNotes": "",
      "watermarkEnabled": false,
      "watermarkText": "",
      "watermarkShowOnAllPages": false,
      "layout": [],
      "isPageLayoutLocked": false,
      "hide": false,
      "layerVisibilityDefaults": null,
      "showLayoutBounds": true,
      "fluidLayout": null,
      "narrativeBeat": null,
      "pageTypeId": "string",
      "pageTypeVariantId": "string",
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string",
      "slug": "string",
      "position": 0
    }
  ],
  "members": [
    {
      "id": "string",
      "userId": "string",
      "name": "string",
      "email": "string",
      "avatar": "string",
      "role": {
        "id": "owner",
        "name": "string"
      }
    }
  ]
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string"
}

Update a project

PATCH
/api/public/v1/projects/{pid}

Authorization

apiKey
x-api-key<token>

In: header

Path Parameters

pid*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/api/public/v1/projects/string" \  -H "Content-Type: application/json" \  -d '{}'
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "pid": "string",
  "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
  "name": "string",
  "theme": "default",
  "themeDefinitionSnapshot": {
    "light": {
      "surface": "string",
      "panel": "string",
      "border": "string",
      "accent": "string",
      "accentMuted": "string",
      "text": "string",
      "mutedText": "string",
      "fontFamily": "string",
      "headingFontFamily": "string",
      "pageBackground": [],
      "layerBackground": {
        "type": "color",
        "value": "string",
        "tint": "string"
      },
      "layerBorder": {
        "radius": 0,
        "width": 0,
        "type": "color",
        "value": "string",
        "side": "all",
        "sideWidths": {
          "property1": 0,
          "property2": 0
        }
      },
      "layerShadow": "drop-shadow-none",
      "chartColors": [
        "string"
      ]
    },
    "dark": {
      "surface": "string",
      "panel": "string",
      "border": "string",
      "accent": "string",
      "accentMuted": "string",
      "text": "string",
      "mutedText": "string",
      "fontFamily": "string",
      "headingFontFamily": "string",
      "pageBackground": [],
      "layerBackground": {
        "type": "color",
        "value": "string",
        "tint": "string"
      },
      "layerBorder": {
        "radius": 0,
        "width": 0,
        "type": "color",
        "value": "string",
        "side": "all",
        "sideWidths": {
          "property1": 0,
          "property2": 0
        }
      },
      "layerShadow": "drop-shadow-none",
      "chartColors": [
        "string"
      ]
    },
    "fonts": [
      {
        "id": "string",
        "label": "string",
        "family": "string",
        "url": "http://example.com",
        "mimeType": "string",
        "sizeBytes": 0,
        "assetId": "string",
        "storageKey": "string",
        "weight": 0,
        "style": "string"
      }
    ]
  },
  "brandingId": null,
  "pageLayersScrollable": true,
  "pageAspectRatio": "16:9",
  "pageGridEnabled": false,
  "pageGridType": "12-column",
  "pageNumbersEnabled": false,
  "linkShareToken": "string",
  "linkAccess": "tenant",
  "linkRole": "owner",
  "publishSlug": null,
  "isPublished": false,
  "publishedAt": null,
  "ogImageUrl": null,
  "publishDescription": null,
  "lockedThemeMode": null,
  "showMadeWithEncelade": false,
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "pinnedAt": null,
  "backgroundPresets": [],
  "pages": [
    {
      "pageBackground": [],
      "presentModeAnimation": "layers-staggered",
      "currentSelectedLayerId": null,
      "currentSelectedLayerType": null,
      "speakerNotes": "",
      "watermarkEnabled": false,
      "watermarkText": "",
      "watermarkShowOnAllPages": false,
      "layout": [],
      "isPageLayoutLocked": false,
      "hide": false,
      "layerVisibilityDefaults": null,
      "showLayoutBounds": true,
      "fluidLayout": null,
      "narrativeBeat": null,
      "pageTypeId": "string",
      "pageTypeVariantId": "string",
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string",
      "slug": "string",
      "position": 0
    }
  ],
  "members": [
    {
      "id": "string",
      "userId": "string",
      "name": "string",
      "email": "string",
      "avatar": "string",
      "role": {
        "id": "owner",
        "name": "string"
      }
    }
  ]
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string"
}

Delete a project

DELETE
/api/public/v1/projects/{pid}

Authorization

apiKey
x-api-key<token>

In: header

Path Parameters

pid*string

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X DELETE "https://example.com/api/public/v1/projects/string"
Empty
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string"
}

Public Generation

Previous Page

Public Sessions

Next Page