Skip to content

Repository files navigation

docxodus-service

Minimal ASP.NET Core microservice that parses DOCX files into OpenContract JSON format using Docxodus.

Endpoints

POST /parse

Accepts a JSON body with a base64-encoded DOCX file and returns an OpenContractDocExport JSON document containing extracted text, structural annotations with character offsets, and page/token metadata.

Request:

{
  "filename": "contract.docx",
  "docx_base64": "UEsDBBQAAAAI..."
}

Response: OpenContractDocExport JSON with fields such as title, content, pageCount, pawlsFileContent, labelledText, docLabels, and relationships.

GET /health

Returns {"status": "healthy"} with HTTP 200.

Docker

The service uses Docxodus 12.4.1 on .NET 10. Consumers rendering DOCX with the docxodus npm package must pin it to 12.4.1 too, so extracted text and annotation character offsets match the browser renderer.

docker pull ghcr.io/open-source-legal/docxodus-service:1.2.0-docxodus12.4.1
docker run -p 8080:8080 ghcr.io/open-source-legal/docxodus-service:1.2.0-docxodus12.4.1

Build from source

Requires the .NET 10 SDK.

dotnet build
dotnet run

The service listens on port 8080 by default.

License

AGPL-3.0

About

Minimal ASP.NET Core microservice wrapping Docxodus for DOCX-to-OpenContract JSON parsing

Resources

Stars

2 stars

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages