{
  "openapi": "3.0.1",
  "info": {
    "title": "Dataset to XLSX with Images",
    "description": "Compatible with Microsoft Excel. Turn inline JSON or CSV into an XLSX with embedded thumbnails and an image report. Up to 200 rows; public HTTPS PNG, JPEG and WEBP images. Free beta: $0 developer fee; Apify usage applies. Independent BGMOWL tool, not affiliated with Microsoft.",
    "version": "0.0",
    "x-build-id": "p2vESg5gW0mbcNmwc"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/bgmowl~dataset-to-excel-with-images-beta/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-bgmowl-dataset-to-excel-with-images-beta",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/acts/bgmowl~dataset-to-excel-with-images-beta/runs": {
      "post": {
        "operationId": "runs-sync-bgmowl-dataset-to-excel-with-images-beta",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor and returns information about the initiated run in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/runsResponseSchema"
                }
              }
            }
          }
        }
      }
    },
    "/acts/bgmowl~dataset-to-excel-with-images-beta/run-sync": {
      "post": {
        "operationId": "run-sync-bgmowl-dataset-to-excel-with-images-beta",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "inputSchema": {
        "type": "object",
        "properties": {
          "demoMode": {
            "title": "Try the fictional product demo",
            "type": "boolean",
            "description": "When true, generate a clearly labeled fictional 12-product catalog using bundled assets: 10 embedded images, 1 missing-image notice, and 1 rejected-image notice. No image-host requests are made. Only demoMode and optional title may be supplied. To use your own data, turn this off, provide records OR csvText, and set imageColumn. The Console initially prefills true; API and CLI callers must explicitly send true to run the demo.",
            "default": false
          },
          "records": {
            "title": "JSON records",
            "minItems": 1,
            "maxItems": 200,
            "type": "array",
            "description": "Your data: turn demoMode off, then supply this OR csvText, never both. Omit this field in demo mode. Accepts 1–200 JSON objects; field names are column names. Use strings for long identifiers to prevent upstream rounding. Do not include secrets or data you are not allowed to process.",
            "items": {
              "type": "object"
            }
          },
          "csvText": {
            "title": "CSV text",
            "minLength": 1,
            "type": "string",
            "description": "Your data: turn demoMode off, then supply this OR records, never both. Omit this field in demo mode. Inline comma-separated CSV with headers and 1–200 data rows; leading zeros stay text. Uploads, file URLs, dataset IDs, and API tokens are not supported in this beta."
          },
          "imageColumn": {
            "title": "Image URL column",
            "minLength": 1,
            "maxLength": 128,
            "type": "string",
            "description": "Required for your own data; omit in demo mode. Exact, case-sensitive existing source field containing image URLs, up to 128 characters. Missing images retain the row and are reported. URLs must use public HTTPS; redirects, URL credentials, and non-public IP destinations are forbidden. Avoid secret URLs: requests disclose the full URL and requester IP to the image host."
          },
          "columns": {
            "title": "Ordered data columns (optional)",
            "minItems": 1,
            "maxItems": 30,
            "uniqueItems": true,
            "type": "array",
            "description": "Optional for your own data; omit in demo mode. Ordered list of 1–30 distinct source field names to include. When omitted, columns follow first-seen input order. The imageColumn still determines the thumbnail source.",
            "items": {
              "type": "string",
              "minLength": 1,
              "maxLength": 128
            }
          },
          "title": {
            "title": "Workbook title (optional)",
            "minLength": 1,
            "maxLength": 100,
            "type": "string",
            "description": "Non-blank human-readable title containing 1–100 characters. The default is Dataset to Excel with Images.",
            "default": "Dataset to Excel with Images"
          }
        }
      },
      "runsResponseSchema": {
        "type": "object",
        "properties": {
          "data": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "actId": {
                "type": "string"
              },
              "userId": {
                "type": "string"
              },
              "startedAt": {
                "type": "string",
                "format": "date-time",
                "example": "2025-01-08T00:00:00.000Z"
              },
              "finishedAt": {
                "type": "string",
                "format": "date-time",
                "example": "2025-01-08T00:00:00.000Z"
              },
              "status": {
                "type": "string",
                "example": "READY"
              },
              "meta": {
                "type": "object",
                "properties": {
                  "origin": {
                    "type": "string",
                    "example": "API"
                  },
                  "userAgent": {
                    "type": "string"
                  }
                }
              },
              "stats": {
                "type": "object",
                "properties": {
                  "inputBodyLen": {
                    "type": "integer",
                    "example": 2000
                  },
                  "rebootCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "restartCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "resurrectCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "computeUnits": {
                    "type": "integer",
                    "example": 0
                  }
                }
              },
              "options": {
                "type": "object",
                "properties": {
                  "build": {
                    "type": "string",
                    "example": "latest"
                  },
                  "timeoutSecs": {
                    "type": "integer",
                    "example": 300
                  },
                  "memoryMbytes": {
                    "type": "integer",
                    "example": 1024
                  },
                  "diskMbytes": {
                    "type": "integer",
                    "example": 2048
                  }
                }
              },
              "buildId": {
                "type": "string"
              },
              "defaultKeyValueStoreId": {
                "type": "string"
              },
              "defaultDatasetId": {
                "type": "string"
              },
              "defaultRequestQueueId": {
                "type": "string"
              },
              "buildNumber": {
                "type": "string",
                "example": "1.0.0"
              },
              "containerUrl": {
                "type": "string"
              },
              "usage": {
                "type": "object",
                "properties": {
                  "ACTOR_COMPUTE_UNITS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_WRITES": {
                    "type": "integer",
                    "example": 1
                  },
                  "KEY_VALUE_STORE_LISTS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_INTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_EXTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_SERPS": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_UNBLOCKER_UNITS": {
                    "type": "integer",
                    "example": 0
                  }
                }
              },
              "usageTotalUsd": {
                "type": "number",
                "example": 0.00005
              },
              "usageUsd": {
                "type": "object",
                "properties": {
                  "ACTOR_COMPUTE_UNITS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_WRITES": {
                    "type": "number",
                    "example": 0.00005
                  },
                  "KEY_VALUE_STORE_LISTS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_INTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_EXTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_SERPS": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_UNBLOCKER_UNITS": {
                    "type": "integer",
                    "example": 0
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}