PDF Generator

Get all PDF presentations

GET · PDF Generator

GET/api/v1/pdf-generator/get

Authentication

x-api-key

Request

curl --globoff --request GET \
  --url 'https://api.example.com/api/v1/pdf-generator/get' \
  --header 'x-api-key: <API_KEY>'

Replace credential and <field> placeholders with your own values. URL placeholders appear as %3Cfield%3E. Review the example values before sending your request.

Replace https://api.example.com with the API server URL.

Responses

200All PDF presentations retrieved

{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "_id": {
        "type": "string",
        "description": "PDF presentation ID"
      },
      "topic": {
        "type": "string",
        "description": "Topic of the presentation"
      },
      "numberOfSlides": {
        "type": "number",
        "description": "Number of slides"
      },
      "locale": {
        "type": "string",
        "description": "Locale of the presentation"
      },
      "url": {
        "type": "string",
        "description": "URL to the generated PDF on S3"
      },
      "pptxUrl": {
        "type": "string",
        "description": "URL to the generated PowerPoint (PPTX) on S3"
      },
      "transcript": {
        "description": "Transcript of each slide",
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "pageNum": {
              "type": "number",
              "description": "Page number of the slide"
            },
            "descriptionOfPage": {
              "type": "string",
              "description": "Description of the slide content and OCR text"
            }
          },
          "required": [
            "pageNum",
            "descriptionOfPage"
          ]
        }
      },
      "organizationId": {
        "type": "string",
        "description": "Organization ID"
      },
      "userId": {
        "type": "string",
        "description": "User ID"
      },
      "createdAt": {
        "format": "date-time",
        "type": "string",
        "description": "Creation timestamp"
      },
      "updatedAt": {
        "format": "date-time",
        "type": "string",
        "description": "Update timestamp"
      }
    },
    "required": [
      "_id",
      "topic",
      "numberOfSlides",
      "locale",
      "url",
      "transcript",
      "organizationId",
      "createdAt",
      "updatedAt"
    ]
  }
}