---
title: "Upload HTML Page"
method: POST
path: "/api/file/html_page"
tags: ["File"]
---

# Upload HTML Page

`POST /api/file/html_page`

Chunk HTML by headings and queue for indexing into the specified dataset.

## Request body

- UploadHtmlPageReqPayload
  - `data` Document, required
    - `extract` string, nullable
    - `html` string, nullable
    - `links` string[], nullable
    - `markdown` string, nullable
    - `metadata` Metadata, required
      - `articleSection` string, nullable
      - `articleTag` string, nullable
      - `dcDate` string, nullable
      - `dcDateCreated` string, nullable
      - `dcDescription` string, nullable
      - `dcSubject` string, nullable
      - `dcTermsAudience` string, nullable
      - `dcTermsCreated` string, nullable
      - `dcTermsKeywords` string, nullable
      - `dcTermsSubject` string, nullable
      - `dcTermsType` string, nullable
      - `dcType` string, nullable
      - `description` string, nullable
      - `error` string, nullable
      - `keywords` string, nullable
      - `language` string, nullable
      - `modifiedTime` string, nullable
      - `ogAudio` string, nullable
      - `ogDescription` string, nullable
      - `ogDeterminer` string, nullable
      - `ogImage` string, nullable
      - `ogLocale` string, nullable
      - `ogLocaleAlternate` string[], nullable
      - `ogSiteName` string, nullable
      - `ogTitle` string, nullable
      - `ogUrl` string, nullable
      - `ogVideo` string, nullable
      - `publishedTime` string, nullable
      - `robots` string, nullable
      - `site_map` Sitemap
        - `changefreq` string, required
      - `sourceURL` string, nullable
      - `statusCode` integer, nullable
      - `title` string, nullable
    - `rawHtml` string, nullable
    - `screenshot` string, nullable
  - `metadata` unknown, required
  - `scrapeId` string, uuid, required

## Response `204`

Confirmation that html is being processed

## Other responses

- `400` — Service error relating to processing the file

---

[API](https://skmtc.net/devflowinc/apis/trieve-api.md) · [All operations](https://skmtc.net/devflowinc/apis/trieve-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/devflowinc/trieve-api/versions/84583e7c9fc1/schema)