KNOWLEDGE-BASE INGESTION

Build documents
into your workflow.

Our metered API is being prepared for developers. The free browser tools, including local OCR, are available now.

Availability

The production API is not open yet. There is no checkout, subscription or automatic charge on this site. Airwallex online payment activation, backend database provisioning and end-to-end payment testing are required before launch.

The first API release is designed for text and Markdown to structured knowledge-base chunks. PDF and image OCR are currently browser features; cloud OCR is not part of the API yet.

Planned API contract

Bearer API key authentication. A required Idempotency-Key prevents duplicate usage charges. One credit per started 10,000 UTF-16 code units, up to 200,000 per request. The planned pack is US$5 for 100 credits; checkout remains closed until payment testing is complete.

The API processes content on the server. Its ledger is designed to retain only key hashes, request hashes, usage and payment references, without document contents. The browser tools continue to process locally.

Integration example — after launch

curl https://yuantechnology.uk/api/v1/convert \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Idempotency-Key: document-job-0001' \
  -H 'Content-Type: application/json' \
  -d '{"format":"markdown","title":"Project notes","content":"# Project notes\n\nYour document content."}'

Response: original Markdown, document title, chunks with source offsets, and usage credits. Chunks are plain text; generate embeddings and store them in your own retrieval system.

401: invalid key · 402: insufficient credits · 409: reused key with different content · 413: oversized body · 503: service or billing unavailable.

SEE THE API RESULT

From Markdown to knowledge-base chunks.

This interactive example shows the current paid API output. It runs locally with sample text; no account, upload or credits are required.

Input Markdown

Structured API response

Each chunk includes its text and source offsets. The response also includes a document title and usage credits. Embeddings are generated in your own system.

Feature	Free browser tools	Paid API
PDF conversion and image OCR	Included locally	Not included yet
Text and Markdown chunking	Manual export	Automated HTTP requests
Processing location	Your device	Server
Account required	No	For purchases

US$5 for 100 credits. One credit per started 10,000 UTF-16 code units. Online payments are awaiting merchant approval.

API credit packs →