Skip to content
ParseHawk Developer Docs
Search
Ctrl
K
Cancel
ParseHawk on GitHub
ParseHawk website
Select theme
Dark
Light
Auto
Home
Start here
Choose an installation path
Tutorials
Extract your first document
Build a reusable extractor
Integrate the REST API
How-to guides
Install on macOS Apple Silicon
Install on Linux with NVIDIA
Choose a model provider
Use the bundled vLLM runtime
Use Ollama locally
Use OpenAI
Use Microsoft Foundry
Use an OpenAI-compatible API
Design reliable extraction schemas
Manage files and extractors
Operate asynchronous jobs
Use the Web UI
Upgrade and back up ParseHawk
Inspect extraction traces
Troubleshoot a local stack
Explanation
Architecture
What local-first means
Core concepts
Schemas and semantic types
Providers and model adapters
Job lifecycle
Deployment and hardware
API stability and versioning
Reference
REST API
Overview
health
Overview
Check API health
GET
Discover the API
GET
files
Overview
List files
GET
Upload a file
POST
Get file metadata
GET
Delete a file
DELETE
Download file content
GET
schemas
Overview
Validate an extraction schema
POST
extractors
Overview
List extractors
GET
Create an extractor
POST
Get an extractor
GET
Create or replace an extractor
PUT
Delete an extractor
DELETE
Update an extractor
PATCH
providers
Overview
List providers
GET
Get a provider
GET
Configure a provider
PATCH
List provider models
GET
jobs
Overview
List jobs
GET
Create a job
POST
Get a job
GET
Delete a job
DELETE
Cancel a job
POST
CLI reference
Generated
Configuration reference
Generated
Extraction schema reference
Generated
Provider matrix
Runtime matrix
Errors and job states
Paths, ports, and defaults
Versioning reference
Documentation feedback
ParseHawk on GitHub
ParseHawk website
Select theme
Dark
Light
Auto
Overview
health
Section titled “health”
API discovery and process liveness.
Operations
Section titled “Operations”
GET
/health
GET
/
