Skip to content
ParseHawkParseHawk Developer Docs

Overview

Local-first document extraction API

ParseHawk API 0.2.1

Section titled “ParseHawk API 0.2.1”

Turn PDFs, images, scans, Markdown, and text into validated JSON. ParseHawk is self-hosted and exposes the same local API used by its CLI and web UI.

Information

  • License: Apache License 2.0
  • OpenAPI version: 3.1.0

Operations

Section titled “Operations”
GET
/health
GET
/
GET
/v1/files
POST
/v1/files
GET
/v1/files/{file_id}
DELETE
/v1/files/{file_id}
GET
/v1/files/{file_id}/content
POST
/v1/schemas/validate
GET
/v1/extractors
POST
/v1/extractors
GET
/v1/extractors/{extractor_ref}
PUT
/v1/extractors/{extractor_ref}
DELETE
/v1/extractors/{extractor_ref}
PATCH
/v1/extractors/{extractor_ref}
GET
/v1/providers
GET
/v1/providers/{name}
PATCH
/v1/providers/{name}
GET
/v1/providers/{name}/models
GET
/v1/jobs
POST
/v1/jobs
GET
/v1/jobs/{job_id}
DELETE
/v1/jobs/{job_id}
POST
/v1/jobs/{job_id}/cancel