AUTHENTICATION

Authenticate outside model context

BEARERbash

curl http://127.0.0.1:8787/v1/usage \
+  -H "Authorization: Bearer $SHREDDAR_API_KEY"

API KEY HEADERbash

curl http://127.0.0.1:8787/v1/usage \
+  -H "X-SHREDDAR-Key: $SHREDDAR_API_KEY"

PRIVACY METHODS

Analyze, protect, reconstruct, and shard

METHOD	PATH	RESPONSIBILITY
POST	/v1/analyze	Return risk, route, entities, task categories, and warnings without creating a Vault session
POST	/v1/protect	Return protected text, transformations, local session credentials, route, and receipt
POST	/v1/reconstruct	Resolve only authorized current-session placeholders with explicit credentials
POST	/v1/shard	Return two to eight bounded protected compartments and a synthesis outline
POST	/v1/playground/run	Operator demo path that protects, generates a deterministic response, guards, and reconstructs

PROTECT REQUESTjson

{
  "text": "Authorized source text",
  "task": "Summarize the termination obligation",
  "policy_id": "strict-v1",
  "privacy_mode": "strict",
  "session_ttl_seconds": 3600
}

OPENAI-COMPATIBLE

Protect the complete request and response

METHOD	PATH	NOTES
GET	/v1/models	Lists shreddar-demo and configured-upstream surfaces
POST	/v1/chat/completions	Accepts OpenAI-style messages plus shreddar_task, shreddar_policy, and shreddar_privacy_mode

POLICY + EVIDENCE

Inspect configuration and results

METHOD	PATH	RESPONSIBILITY
GET	/v1/policies	List built-in and custom policies
GET	/v1/policies/{policy_id}	Read rules, version, and canonical hash
POST	/v1/policies	Create a bounded custom policy
GET	/v1/receipts	List metadata-only receipts with limit and offset
GET	/v1/receipts/{request_id}	Read one receipt
GET	/v1/receipts/{request_id}/verify	Recompute and verify the integrity chain
GET	/v1/receipts/{request_id}/anchor-payload	Prepare a hash payload; does not submit a transaction
GET	/v1/usage	Aggregate protected operations and input/external token meters
GET	/v1/payments/x402	Read the disabled settlement state and missing release evidence

OPENAI-COMPATIBLE GUIDE