Protect documents
Upload text, PDF, or DOCX files, follow a processing job, and retrieve protected artifacts.
Document job workflow
- Submit raw UTF-8 text, PDF, or DOCX bytes to
POST /v1/documents/jobs. - Keep the returned job ID and poll
GET /v1/documents/jobs/{id}. - When the job succeeds, retrieve the listed text, PDF, and optional mapping artifacts.
- Delete or allow temporary job data to expire after your application has stored the result it needs.
Content type matters
Send the file bytes directly with text/plain, application/pdf, or the DOCX media type. The maximum upload is 10 MB.
Submit a file
curl 'https://api.shinrai.innovius.io/v1/documents/jobs?mode=replace&include_mapping=true' \
-H "Authorization: Bearer $SHINRAI_API_KEY" \
-H 'Content-Type: application/pdf' \
-H 'Idempotency-Key: customer-case-4815' \
--data-binary @case.pdf
Poll and download artifacts
curl "https://api.shinrai.innovius.io/v1/documents/jobs/$JOB_ID" \
-H "Authorization: Bearer $SHINRAI_API_KEY"Use the artifact URLs returned by the status response. Job and artifact access is restricted to the account that created the job.
Handle failures safely
Do not forward the original file when protection fails. Treat 415 as an unsupported media type, 422 as invalid document content, and 503 as a temporary worker failure.