{"openapi":"3.1.0","info":{"title":"Orivfy Text Detection API","version":"0.1.0"},"paths":{"/api/v1/scan/ai-scan":{"post":{"tags":["Scan"],"summary":"Ai Scan","description":"Passage level text classification.","operationId":"ai_scan_api_v1_scan_ai_scan_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScanRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AIScanResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/scan/deep-scan":{"post":{"tags":["Scan"],"summary":"Deep Scan","description":"Sentence level classification.","operationId":"deep_scan_api_v1_scan_deep_scan_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScanRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeepScanResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/scan/extract-document-text":{"post":{"tags":["Scan"],"summary":"Extract Document Text","description":"Extract plain text from an uploaded PDF or DOCX.\nReturns { text: string, word_count: int, filename: string }.","operationId":"extract_document_text_api_v1_scan_extract_document_text_post","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/Body_extract_document_text_api_v1_scan_extract_document_text_post"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/scan/document-forensics":{"post":{"tags":["Scan"],"summary":"Document Forensics","description":"Analyse an uploaded PDF or DOCX for metadata forensic signals:\nAI-tool fingerprints, editing-speed anomalies, copy-paste detection,\nrevision/rsid density, timestamp consistency, font uniformity, etc.","operationId":"document_forensics_api_v1_scan_document_forensics_post","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/Body_document_forensics_api_v1_scan_document_forensics_post"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentForensicsResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/discovery.json":{"get":{"tags":["Meta"],"summary":"Machine-readable endpoint index (JSON)","description":"Minimal JSON discovery for automation.","operationId":"api_discovery_json_api_v1_discovery_json_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}}},"components":{"schemas":{"AIScanResponse":{"properties":{"prediction":{"type":"string","title":"Prediction"},"confidence":{"type":"number","title":"Confidence"},"is_mixed":{"type":"boolean","title":"Is Mixed"},"is_ai":{"type":"boolean","title":"Is Ai"},"ai_score":{"type":"number","title":"Ai Score","default":0.0},"mixed_score":{"type":"number","title":"Mixed Score","default":0.0},"human_score":{"type":"number","title":"Human Score","default":0.0},"source_attribution":{"anyOf":[{"$ref":"#/components/schemas/SourceAttribution"},{"type":"null"}]},"radar_axes":{"items":{"$ref":"#/components/schemas/RadarAxis"},"type":"array","title":"Radar Axes"}},"type":"object","required":["prediction","confidence","is_mixed","is_ai"],"title":"AIScanResponse"},"Body_document_forensics_api_v1_scan_document_forensics_post":{"properties":{"file":{"type":"string","contentMediaType":"application/octet-stream","title":"File"},"secret_key":{"type":"string","title":"Secret Key"}},"type":"object","required":["file","secret_key"],"title":"Body_document_forensics_api_v1_scan_document_forensics_post"},"Body_extract_document_text_api_v1_scan_extract_document_text_post":{"properties":{"file":{"type":"string","contentMediaType":"application/octet-stream","title":"File"},"secret_key":{"type":"string","title":"Secret Key"}},"type":"object","required":["file","secret_key"],"title":"Body_extract_document_text_api_v1_scan_extract_document_text_post"},"DeepScanResponse":{"properties":{"sentences":{"items":{"$ref":"#/components/schemas/SentenceResult"},"type":"array","title":"Sentences"},"distribution_confidence":{"type":"number","title":"Distribution Confidence","default":0.0},"passage_verdict":{"type":"string","title":"Passage Verdict","default":"Human"},"distribution_verdict":{"type":"string","title":"Distribution Verdict","default":"Human"},"deep_labels":{"items":{"type":"string"},"type":"array","title":"Deep Labels","default":[]},"overall_prediction":{"type":"string","title":"Overall Prediction"},"is_mixed":{"type":"boolean","title":"Is Mixed"},"mixed_ratio":{"type":"number","title":"Mixed Ratio","default":0.0},"ai_score":{"type":"number","title":"Ai Score","default":0.0},"mixed_score":{"type":"number","title":"Mixed Score","default":0.0},"uncertain_sentence_ratio":{"type":"number","title":"Uncertain Sentence Ratio","default":0.0},"human_score":{"type":"number","title":"Human Score","default":0.0},"source_attribution":{"anyOf":[{"$ref":"#/components/schemas/SourceAttribution"},{"type":"null"}]},"radar_axes":{"items":{"$ref":"#/components/schemas/RadarAxis"},"type":"array","title":"Radar Axes"}},"type":"object","required":["sentences","overall_prediction","is_mixed"],"title":"DeepScanResponse"},"DocumentForensicsResponse":{"properties":{"doc_type":{"type":"string","title":"Doc Type"},"filename":{"type":"string","title":"Filename","default":""},"file_size":{"type":"integer","title":"File Size","default":0},"metadata":{"additionalProperties":{"type":"string"},"type":"object","title":"Metadata","default":{}},"signals":{"items":{"$ref":"#/components/schemas/ForensicSignalResponse"},"type":"array","title":"Signals","default":[]},"suspicion_score":{"type":"number","title":"Suspicion Score","default":0.0},"verdict":{"type":"string","title":"Verdict","default":"Clean"},"editing_behaviour":{"anyOf":[{"$ref":"#/components/schemas/EditingBehaviour"},{"type":"null"}]},"summary":{"type":"string","title":"Summary","default":""}},"type":"object","required":["doc_type"],"title":"DocumentForensicsResponse"},"EditingBehaviour":{"properties":{"revision_count":{"type":"integer","title":"Revision Count","default":0},"editing_time_minutes":{"type":"integer","title":"Editing Time Minutes","default":0},"rsid_count":{"type":"integer","title":"Rsid Count","default":0},"word_count":{"type":"integer","title":"Word Count","default":0},"paragraph_count":{"type":"integer","title":"Paragraph Count","default":0},"words_per_minute":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Words Per Minute"},"rsid_per_paragraph":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Rsid Per Paragraph"},"estimated_typed_ratio":{"type":"number","title":"Estimated Typed Ratio","default":0.5},"estimated_pasted_ratio":{"type":"number","title":"Estimated Pasted Ratio","default":0.5},"timestamp_gap_seconds":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Timestamp Gap Seconds"},"unique_styles":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Unique Styles"}},"type":"object","title":"EditingBehaviour"},"ForensicSignalResponse":{"properties":{"category":{"type":"string","title":"Category"},"field":{"type":"string","title":"Field"},"value":{"type":"string","title":"Value"},"verdict":{"type":"string","title":"Verdict"},"weight":{"type":"string","title":"Weight"},"description":{"type":"string","title":"Description"}},"type":"object","required":["category","field","value","verdict","weight","description"],"title":"ForensicSignalResponse"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ParameterConfig":{"properties":{"min_sentence_length":{"type":"integer","title":"Min Sentence Length","default":10},"batch_size":{"type":"integer","title":"Batch Size","default":16},"threshold":{"type":"number","title":"Threshold","default":0.5},"mixed_offset":{"type":"number","title":"Mixed Offset","default":0.05},"context_sentences":{"type":"integer","title":"Context Sentences","default":2}},"type":"object","title":"ParameterConfig"},"RadarAxis":{"properties":{"key":{"type":"string","title":"Key"},"label":{"type":"string","title":"Label"},"value":{"type":"integer","title":"Value"}},"type":"object","required":["key","label","value"],"title":"RadarAxis","description":"Five heuristic linguistic dimensions (0–100) aligned with product radar charts."},"ScanRequest":{"properties":{"secret_key":{"type":"string","title":"Secret Key"},"text":{"type":"string","title":"Text"},"context_before":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Context Before"},"context_after":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Context After"},"config":{"anyOf":[{"$ref":"#/components/schemas/ParameterConfig"},{"type":"null"}]}},"type":"object","required":["secret_key","text"],"title":"ScanRequest"},"SentenceResult":{"properties":{"sentence":{"type":"string","title":"Sentence"},"prediction":{"type":"string","title":"Prediction"},"ai_probability":{"type":"number","title":"Ai Probability"}},"type":"object","required":["sentence","prediction","ai_probability"],"title":"SentenceResult"},"SourceAttribution":{"properties":{"status":{"type":"string","title":"Status"},"likely_source":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Likely Source"},"likely_label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Likely Label"},"confidence":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Confidence"},"margin":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Margin"},"candidates":{"items":{"$ref":"#/components/schemas/SourceCandidate"},"type":"array","title":"Candidates","default":[]},"source_display":{"anyOf":[{"$ref":"#/components/schemas/SourceDisplay"},{"type":"null"}]},"evidence":{"items":{"type":"string"},"type":"array","title":"Evidence","default":[]},"method":{"type":"string","title":"Method","default":"lmscan"},"word_count":{"type":"integer","title":"Word Count","default":0},"detail":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Detail"}},"type":"object","required":["status"],"title":"SourceAttribution","description":"Vendor hints when passage verdict is AI — ``status`` is ``ok``, ``uncertain``, ``unavailable``, or ``inconclusive_*``."},"SourceCandidate":{"properties":{"source":{"type":"string","title":"Source"},"label":{"type":"string","title":"Label"},"score":{"type":"number","title":"Score"}},"type":"object","required":["source","label","score"],"title":"SourceCandidate","description":"Internal fused scores (API field); UI should prefer ``source_display``."},"SourceDisplay":{"properties":{"kind":{"type":"string","title":"Kind"},"options":{"items":{"$ref":"#/components/schemas/SourceDisplayOption"},"type":"array","title":"Options"},"show_confidence":{"type":"boolean","title":"Show Confidence","default":false}},"type":"object","required":["kind"],"title":"SourceDisplay","description":"What to show the user: one vendor, two tied vendors, or Uncertain — no runner-up list."},"SourceDisplayOption":{"properties":{"source":{"type":"string","title":"Source"},"label":{"type":"string","title":"Label"}},"type":"object","required":["source","label"],"title":"SourceDisplayOption"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}