ExtractPDFRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ExtractPDFRequest",
  "title": "ExtractPDFRequest",
  "type": "object",
  "required": [
    "assetID"
  ],
  "properties": {
    "assetID": {
      "type": "string",
      "description": "The asset ID of the PDF to extract from.",
      "example": "500123"
    },
    "elementsToExtract": {
      "type": "array",
      "description": "The types of elements to extract from the PDF.",
      "items": {
        "type": "string",
        "enum": [
          "text",
          "tables"
        ]
      },
      "default": [
        "text",
        "tables"
      ],
      "example": []
    },
    "elementsToExtractRenditions": {
      "type": "array",
      "description": "Rendition types to generate for extracted elements.",
      "items": {
        "type": "string",
        "enum": [
          "tables",
          "figures"
        ]
      },
      "example": []
    },
    "tableOutputFormat": {
      "type": "string",
      "description": "The output format for extracted tables.",
      "enum": [
        "csv",
        "xlsx"
      ],
      "default": "csv",
      "example": "csv"
    },
    "getStylingInfo": {
      "type": "boolean",
      "description": "Whether to include styling information (font, color, etc.) in the extraction output.",
      "default": false,
      "example": true
    },
    "addCharInfo": {
      "type": "boolean",
      "description": "Whether to include character-level bounding box information.",
      "default": false,
      "example": true
    }
  }
}