PDF Generator V3

Get a PDF v3 presentation by ID

GET · PDF Generator V3

GET/api/v1/pdf-generator/v3/get/{id}

Authentication

x-api-key

Request

curl --globoff --request GET \
  --url 'https://api.example.com/api/v1/pdf-generator/v3/get/%3Cid%3E' \
  --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.

Parameters

idpath · string · required

PDF presentation ID

Responses

200PDF v3 presentation retrieved successfully

{
  "type": "object",
  "properties": {
    "_id": {
      "type": "string",
      "description": "PDF presentation ID"
    },
    "topic": {
      "type": "string",
      "description": "Topic of the generated presentation"
    },
    "numberOfSlides": {
      "type": "number",
      "description": "Number of generated slides/pages"
    },
    "locale": {
      "type": "string",
      "description": "Locale stored with the generated presentation"
    },
    "url": {
      "type": "string",
      "description": "Signed GCS URL for the generated PDF"
    },
    "transcript": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "pageNum": {
            "type": "number",
            "description": "Page number of the slide"
          },
          "descriptionOfPage": {
            "type": "string",
            "description": "Human-readable slide transcript generated from the v3 outline"
          }
        },
        "required": [
          "pageNum",
          "descriptionOfPage"
        ]
      }
    },
    "rawSlides": {
      "type": "object",
      "properties": {
        "generatorVersion": {
          "type": "string",
          "example": "v3"
        },
        "model": {
          "type": "string",
          "example": "gemini-3-flash-preview"
        },
        "outline": {
          "type": "object",
          "description": "Structured outline used to render the SVG slides"
        },
        "svgs": {
          "description": "Raw SVG source for each generated slide",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "required": [
        "generatorVersion",
        "model",
        "outline",
        "svgs"
      ]
    },
    "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",
    "rawSlides",
    "organizationId",
    "createdAt",
    "updatedAt"
  ]
}