Encelade API Docs

Public Sessions

Get a generation session

GET
/api/public/v1/sessions/{sessionId}
x-api-key<token>

In: header

Path Parameters

sessionId*string

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://loading/api/public/v1/sessions/string"
{
  "sessionId": "string",
  "request": null,
  "plan": {
    "title": "string",
    "tone": "string",
    "audience": "string",
    "summary": "string",
    "callToAction": "string",
    "pages": [
      {
        "title": "string",
        "objective": "string",
        "keyPoints": [
          "string"
        ],
        "slideType": "narrative",
        "contentDensity": "minimal",
        "mediaRole": "none",
        "narrativeBeat": "setup",
        "headlineStyle": "insight",
        "recommendedRoadmapStyles": [
          "OPTION1"
        ],
        "recommendedStatisticsStyles": [
          "CENTERED"
        ],
        "supportingPacketIds": [
          "string"
        ],
        "userContent": "string"
      }
    ]
  },
  "events": [
    {
      "type": "string",
      "message": "string",
      "data": null
    }
  ],
  "status": "pending",
  "queuedAt": "2019-08-24T14:15:22Z",
  "startedAt": "2019-08-24T14:15:22Z",
  "completedAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "createdAt": "2019-08-24T14:15:22Z",
  "formState": {
    "property1": null,
    "property2": null
  },
  "reviewConfirmed": true,
  "projectPid": "string",
  "phase": "planning",
  "link": "string"
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string"
}

Cancel a generation session

DELETE
/api/public/v1/sessions/{sessionId}
x-api-key<token>

In: header

Path Parameters

sessionId*string

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X DELETE "https://loading/api/public/v1/sessions/string"
Empty
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string"
}