Developer documentation
API reference, SDK integration, and supported formats. Start with onboarding or browse the guides below.
Guides
AI capabilities
The API uses capability-based model selection. Use these IDs when calling AI endpoints.
Loading supported capabilities…
API reference
Endpoints are loaded from the OpenAPI spec. For request/response schemas, use the interactive docs below.
- Admin
- POST
/api/v1/medha-os/admin/ingestion/web/run— Run Web IngestionPOST/api/v1/medha-os/admin/ingestion/web/run— Run Web IngestionGET/api/v1/medha-os/admin/config— Get ConfigsGET/api/v1/medha-os/admin/config— Get ConfigsPOST/api/v1/medha-os/admin/config— Set ConfigPOST/api/v1/medha-os/admin/config— Set ConfigGET/api/v1/medha-os/admin/config/list— List ConfigsGET/api/v1/medha-os/admin/config/list— List ConfigsGET/api/v1/medha-os/admin/config/{config_key}— Get ConfigGET/api/v1/medha-os/admin/config/{config_key}— Get Config+158 more. See OpenAPI for full list.
- AI
- GET
/api/v1/medha-os/ai/intent/schema— Get Intent SchemaGET/api/v1/medha-os/ai/intent/schema— Get Intent SchemaGET/api/v1/medha-os/ai/identity— Get IdentityGET/api/v1/medha-os/ai/identity— Get IdentityPOST/api/v1/medha-os/ai/files/guest— Upload file for guest chatPOST/api/v1/medha-os/ai/files/guest— Upload file for guest chatGET/api/v1/medha-os/ai/files/guest/{file_id}— Download guest fileGET/api/v1/medha-os/ai/files/guest/{file_id}— Download guest filePOST/api/v1/medha-os/ai/chat/guest— Public guest chatPOST/api/v1/medha-os/ai/chat/guest— Public guest chat+194 more. See OpenAPI for full list.
- AI Execution
- POST
/api/v1/medha-os/ai/execute— Execute AI OperationPOST/api/v1/medha-os/ai/execute— Execute AI OperationPOST/api/v1/ai/execute— Execute AI OperationPOST/api/v1/ai/execute— Execute AI Operation - Assistant
- POST
/api/v1/medha-os/assistant/chat— Chat with AssistantPOST/api/v1/medha-os/assistant/chat— Chat with AssistantGET/api/v1/medha-os/assistant/capabilities— Get Assistant CapabilitiesGET/api/v1/medha-os/assistant/capabilities— Get Assistant CapabilitiesGET/api/v1/medha-os/assistant/conversations— List ConversationsGET/api/v1/medha-os/assistant/conversations— List ConversationsGET/api/v1/medha-os/assistant/conversations/{conversation_id}— Get ConversationGET/api/v1/medha-os/assistant/conversations/{conversation_id}— Get ConversationDELETE/api/v1/medha-os/assistant/conversations/{conversation_id}— Delete ConversationDELETE/api/v1/medha-os/assistant/conversations/{conversation_id}— Delete Conversation+10 more. See OpenAPI for full list.
- Audit
- GET
/api/v1/medha-os/audit/cases/{case_id}— Get Audit Trail for CaseGET/api/v1/medha-os/audit/cases/{case_id}— Get Audit Trail for CaseGET/api/v1/medha-os/audit/export/{case_id}— Export Audit TrailGET/api/v1/medha-os/audit/export/{case_id}— Export Audit TrailGET/api/v1/medha-os/audit/verify/{case_id}— Verify Audit Trail Hash ChainGET/api/v1/medha-os/audit/verify/{case_id}— Verify Audit Trail Hash ChainGET/api/v1/medha-os/audit— List Audit EventsGET/api/v1/medha-os/audit— List Audit EventsGET/api/v1/audit/cases/{case_id}— Get Audit Trail for CaseGET/api/v1/audit/cases/{case_id}— Get Audit Trail for Case+6 more. See OpenAPI for full list.
- Auth
- POST
/api/v1/medha-os/auth/login— LoginPOST/api/v1/medha-os/auth/login— LoginPOST/api/v1/medha-os/auth/logout— LogoutPOST/api/v1/medha-os/auth/logout— LogoutGET/api/v1/medha-os/auth/oauth/login— Oauth LoginGET/api/v1/medha-os/auth/oauth/login— Oauth LoginGET/api/v1/medha-os/auth/oauth/callback— Oauth CallbackGET/api/v1/medha-os/auth/oauth/callback— Oauth CallbackPOST/api/v1/medha-os/auth/oauth/logout— Oauth LogoutPOST/api/v1/medha-os/auth/oauth/logout— Oauth Logout+10 more. See OpenAPI for full list.
- Chat
- POST
/api/v1/chat/message— Chat Message - Data Export
- POST
/api/v1/medha-os/data/export— Export All Tenant DataPOST/api/v1/medha-os/data/export— Export All Tenant DataPOST/api/v1/data/export— Export All Tenant DataPOST/api/v1/data/export— Export All Tenant Data - Data Ingestion
- POST
/api/v1/medha-os/ingestion/urls— Ingest UrlsPOST/api/v1/medha-os/ingestion/urls— Ingest UrlsPOST/api/v1/medha-os/ingestion/files— Ingest FilesPOST/api/v1/medha-os/ingestion/files— Ingest FilesPOST/api/v1/medha-os/ingestion/structured— Ingest StructuredPOST/api/v1/medha-os/ingestion/structured— Ingest StructuredGET/api/v1/medha-os/ingestion/jobs— List Ingestion JobsGET/api/v1/medha-os/ingestion/jobs— List Ingestion JobsGET/api/v1/medha-os/ingestion/status— Get Tenant Ingestion StatusGET/api/v1/medha-os/ingestion/status— Get Tenant Ingestion Status+18 more. See OpenAPI for full list.
- Evals
- POST
/api/v1/medha-os/evals/run— Run EvalPOST/api/v1/medha-os/evals/run— Run EvalPOST/api/v1/medha-os/evals/compare— Compare EvalsPOST/api/v1/medha-os/evals/compare— Compare EvalsGET/api/v1/medha-os/evals/results— List Eval ResultsGET/api/v1/medha-os/evals/results— List Eval ResultsPOST/api/v1/evals/run— Run EvalPOST/api/v1/evals/run— Run EvalPOST/api/v1/evals/compare— Compare EvalsPOST/api/v1/evals/compare— Compare Evals+2 more. See OpenAPI for full list.
- Feedback
- POST
/api/v1/medha-os/feedback/guest— Submit Guest FeedbackPOST/api/v1/medha-os/feedback/guest— Submit Guest FeedbackPOST/api/v1/medha-os/feedback— Submit FeedbackPOST/api/v1/medha-os/feedback— Submit FeedbackGET/api/v1/medha-os/feedback— List FeedbackGET/api/v1/medha-os/feedback— List FeedbackGET/api/v1/medha-os/feedback/admin— List Feedback AdminGET/api/v1/medha-os/feedback/admin— List Feedback AdminPOST/api/v1/medha-os/feedback/analyze— Analyze FeedbackPOST/api/v1/medha-os/feedback/analyze— Analyze Feedback+14 more. See OpenAPI for full list.
- Kill Switches
- POST
/api/v1/medha-os/kill-switches/ai/disable— Disable AI GloballyPOST/api/v1/medha-os/kill-switches/ai/disable— Disable AI GloballyPOST/api/v1/medha-os/kill-switches/ai/enable— Enable AI GloballyPOST/api/v1/medha-os/kill-switches/ai/enable— Enable AI GloballyPOST/api/v1/medha-os/kill-switches/models/{model_version}/disable— Disable ModelPOST/api/v1/medha-os/kill-switches/models/{model_version}/disable— Disable ModelPOST/api/v1/medha-os/kill-switches/models/{model_version}/enable— Enable ModelPOST/api/v1/medha-os/kill-switches/models/{model_version}/enable— Enable ModelPOST/api/v1/medha-os/kill-switches/tenants/{tenant_id}/disable— Disable AI for TenantPOST/api/v1/medha-os/kill-switches/tenants/{tenant_id}/disable— Disable AI for Tenant+18 more. See OpenAPI for full list.
- Metrics
- GET
/api/v1/medha-os/metrics/ai— AI MetricsGET/api/v1/medha-os/metrics/ai— AI MetricsGET/api/v1/medha-os/metrics/sla— SLA MetricsGET/api/v1/medha-os/metrics/sla— SLA MetricsGET/api/v1/medha-os/metrics/drift— Drift alertsGET/api/v1/medha-os/metrics/drift— Drift alertsGET/api/v1/metrics/ai— AI MetricsGET/api/v1/metrics/ai— AI MetricsGET/api/v1/metrics/sla— SLA MetricsGET/api/v1/metrics/sla— SLA Metrics+2 more. See OpenAPI for full list.
- Models
- POST
/api/v1/medha-os/models— Create ModelPOST/api/v1/medha-os/models— Create ModelGET/api/v1/medha-os/models— List ModelsGET/api/v1/medha-os/models— List ModelsGET/api/v1/medha-os/models/ab-tests— List Ab TestsGET/api/v1/medha-os/models/ab-tests— List Ab TestsGET/api/v1/medha-os/models/{model_id}— Get ModelGET/api/v1/medha-os/models/{model_id}— Get ModelPOST/api/v1/medha-os/models/{model_id}/versions— Create VersionPOST/api/v1/medha-os/models/{model_id}/versions— Create Version+42 more. See OpenAPI for full list.
- Onboarding
- POST
/api/v1/medha-os/onboard— Onboard TenantPOST/api/v1/medha-os/onboard— Onboard TenantGET/api/v1/medha-os/onboard/status/{tenant_id}— Get Onboarding StatusGET/api/v1/medha-os/onboard/status/{tenant_id}— Get Onboarding StatusPOST/api/v1/medha-os/onboard/verify-domain— Verify DomainPOST/api/v1/medha-os/onboard/verify-domain— Verify DomainPOST/api/v1/medha-os/onboard/domains— Register DomainPOST/api/v1/medha-os/onboard/domains— Register DomainGET/api/v1/medha-os/onboard/domains— List DomainsGET/api/v1/medha-os/onboard/domains— List Domains+26 more. See OpenAPI for full list.
- Orchestration
- GET
/api/v1/medha-os/intent/schema— Get Intent SchemaGET/api/v1/medha-os/identity— Get IdentityGET/api/v1/intent/schema— Get Intent SchemaGET/api/v1/identity— Get Identity - Payment
- POST
/api/v1/medha-os/payment/create— Create PaymentPOST/api/v1/medha-os/payment/create— Create PaymentGET/api/v1/medha-os/payment/status/{payment_id}— Get Payment StatusGET/api/v1/medha-os/payment/status/{payment_id}— Get Payment StatusGET/api/v1/medha-os/payment/status/order/{merchant_order_id}— Get Payment Status By OrderGET/api/v1/medha-os/payment/status/order/{merchant_order_id}— Get Payment Status By OrderPOST/api/v1/medha-os/payment/callback— Handle Payment CallbackPOST/api/v1/medha-os/payment/callback— Handle Payment CallbackPOST/api/v1/medha-os/payment/refund— Process RefundPOST/api/v1/medha-os/payment/refund— Process Refund+10 more. See OpenAPI for full list.
- PDF Ops
- POST
/api/v1/medha-os/pdf/merge— Pdf MergePOST/api/v1/medha-os/pdf/split— Pdf SplitPOST/api/v1/medha-os/pdf/split-bookmarks— Pdf Split BookmarksPOST/api/v1/medha-os/pdf/split-size— Pdf Split SizePOST/api/v1/medha-os/pdf/split-count— Pdf Split CountPOST/api/v1/medha-os/pdf/compare— Pdf ComparePOST/api/v1/medha-os/pdf/overlay-mode— Pdf Overlay ModePOST/api/v1/medha-os/pdf/convert— Pdf Convert GenericPOST/api/v1/medha-os/edit/replace-text— Replace TextPOST/api/v1/medha-os/edit/replace-image— Replace Image+250 more. See OpenAPI for full list.
- Policy
- POST
/api/v1/medha-os/policy/check— Policy CheckPOST/api/v1/medha-os/policy/check— Policy CheckGET/api/v1/medha-os/policy/packs— List Policy PacksGET/api/v1/medha-os/policy/packs— List Policy PacksPOST/api/v1/medha-os/policy/packs— Create Policy PackPOST/api/v1/medha-os/policy/packs— Create Policy PackPOST/api/v1/medha-os/policy/packs/{pack_id}/activate— Activate Policy PackPOST/api/v1/medha-os/policy/packs/{pack_id}/activate— Activate Policy PackPOST/api/v1/policy/check— Policy CheckPOST/api/v1/policy/check— Policy Check+6 more. See OpenAPI for full list.
- Preflight
- GET
/api/v1/medha-os/preflight— Preflight checkGET/api/v1/medha-os/preflight— Preflight checkGET/api/v1/preflight— Preflight checkGET/api/v1/preflight— Preflight check - Prompts
- GET
/api/v1/medha-os/prompts/{prompt_id}— Get Latest Approved PromptGET/api/v1/medha-os/prompts/{prompt_id}— Get Latest Approved PromptPOST/api/v1/medha-os/prompts/{prompt_id}/versions— Create Prompt VersionPOST/api/v1/medha-os/prompts/{prompt_id}/versions— Create Prompt VersionPOST/api/v1/medha-os/prompts/{prompt_id}/versions/{version}/approve— Approve Prompt VersionPOST/api/v1/medha-os/prompts/{prompt_id}/versions/{version}/approve— Approve Prompt VersionGET/api/v1/medha-os/prompts— List Prompt VersionsGET/api/v1/medha-os/prompts— List Prompt VersionsGET/api/v1/prompts/{prompt_id}— Get Latest Approved PromptGET/api/v1/prompts/{prompt_id}— Get Latest Approved Prompt+6 more. See OpenAPI for full list.
- Readiness
- GET
/api/v1/medha-os/readiness— Get Enterprise Readiness ScoreGET/api/v1/medha-os/readiness— Get Enterprise Readiness ScoreGET/api/v1/readiness— Get Enterprise Readiness ScoreGET/api/v1/readiness— Get Enterprise Readiness Score - Registry
- POST
/api/v1/medha-os/registry/models— Create Provider ModelPOST/api/v1/medha-os/registry/models— Create Provider ModelGET/api/v1/medha-os/registry/models— List Provider ModelsGET/api/v1/medha-os/registry/models— List Provider ModelsGET/api/v1/medha-os/registry/models/{model_id}— Get Provider ModelGET/api/v1/medha-os/registry/models/{model_id}— Get Provider ModelPATCH/api/v1/medha-os/registry/models/{model_id}— Update Provider ModelPATCH/api/v1/medha-os/registry/models/{model_id}— Update Provider ModelDELETE/api/v1/medha-os/registry/models/{model_id}— Delete Provider ModelDELETE/api/v1/medha-os/registry/models/{model_id}— Delete Provider Model+30 more. See OpenAPI for full list.
- sastra
- GET
/api/v1/sastra/conversations/{conversation_id}— Get ConversationPOST/api/v1/sastra/conversations— Create ConversationPOST/api/v1/sastra/messages— Add MessagePOST/api/v1/sastra/leads— Create LeadPOST/api/v1/sastra/continue-chat— Continue Chat - Sastra
- GET
/api/v1/sastra/conversations/{conversation_id}— Get ConversationPOST/api/v1/sastra/conversations— Create ConversationPOST/api/v1/sastra/messages— Add MessagePOST/api/v1/sastra/leads— Create LeadPOST/api/v1/sastra/continue-chat— Continue Chat - SCIM
- GET
/api/v1/medha-os/scim/v2/Users— List UsersGET/api/v1/medha-os/scim/v2/Users— List UsersPOST/api/v1/medha-os/scim/v2/Users— Create UserPOST/api/v1/medha-os/scim/v2/Users— Create UserGET/api/v1/medha-os/scim/v2/Users/{user_id}— Get UserGET/api/v1/medha-os/scim/v2/Users/{user_id}— Get UserPUT/api/v1/medha-os/scim/v2/Users/{user_id}— Update UserPUT/api/v1/medha-os/scim/v2/Users/{user_id}— Update UserPATCH/api/v1/medha-os/scim/v2/Users/{user_id}— Patch UserPATCH/api/v1/medha-os/scim/v2/Users/{user_id}— Patch User+26 more. See OpenAPI for full list.
- Search
- GET
/api/v1/medha-os/search/history— Get Search HistoryGET/api/v1/medha-os/search/history— Get Search HistoryDELETE/api/v1/medha-os/search/history— Clear Search HistoryDELETE/api/v1/medha-os/search/history— Clear Search HistoryGET/api/v1/medha-os/search/suggestions— Get Search SuggestionsGET/api/v1/medha-os/search/suggestions— Get Search SuggestionsGET/api/v1/search/history— Get Search HistoryGET/api/v1/search/history— Get Search HistoryDELETE/api/v1/search/history— Clear Search HistoryDELETE/api/v1/search/history— Clear Search History+2 more. See OpenAPI for full list.
- Similarity
- POST
/api/v1/medha-os/similarity/calculate— Calculate Document SimilarityPOST/api/v1/medha-os/similarity/calculate— Calculate Document SimilarityGET/api/v1/medha-os/similarity/{file_id}— Find Similar DocumentsGET/api/v1/medha-os/similarity/{file_id}— Find Similar DocumentsPOST/api/v1/similarity/calculate— Calculate Document SimilarityPOST/api/v1/similarity/calculate— Calculate Document SimilarityGET/api/v1/similarity/{file_id}— Find Similar DocumentsGET/api/v1/similarity/{file_id}— Find Similar Documents - Tables
- POST
/api/v1/medha-os/tables/recognize— Recognize Tables in DocumentPOST/api/v1/medha-os/tables/recognize— Recognize Tables in DocumentGET/api/v1/medha-os/tables/{file_id}— Get Tables from DocumentGET/api/v1/medha-os/tables/{file_id}— Get Tables from DocumentPOST/api/v1/tables/recognize— Recognize Tables in DocumentPOST/api/v1/tables/recognize— Recognize Tables in DocumentGET/api/v1/tables/{file_id}— Get Tables from DocumentGET/api/v1/tables/{file_id}— Get Tables from Document - training
- POST
/api/v1/medha-os/training/start— Start TrainingGET/api/v1/medha-os/training/status/{job_id}— Get Training StatusGET/api/v1/medha-os/training/jobs— List Training JobsGET/api/v1/medha-os/training/checkpoints— List CheckpointsPOST/api/v1/medha-os/training/jobs/{job_id}/sync-to-s3— Sync Job Output To S3GET/api/v1/medha-os/training/s3-datasets— List S3 DatasetsGET/api/v1/medha-os/training/dataset-links— Get Dataset LinksPOST/api/v1/medha-os/training/dataset-links— Add Dataset LinkDELETE/api/v1/medha-os/training/dataset-links— Remove Dataset LinkPOST/api/v1/training/start— Start Training+8 more. See OpenAPI for full list.
- Training
- POST
/api/v1/medha-os/training/start— Start TrainingGET/api/v1/medha-os/training/status/{job_id}— Get Training StatusGET/api/v1/medha-os/training/jobs— List Training JobsGET/api/v1/medha-os/training/checkpoints— List CheckpointsPOST/api/v1/medha-os/training/jobs/{job_id}/sync-to-s3— Sync Job Output To S3GET/api/v1/medha-os/training/s3-datasets— List S3 DatasetsGET/api/v1/medha-os/training/dataset-links— Get Dataset LinksPOST/api/v1/medha-os/training/dataset-links— Add Dataset LinkDELETE/api/v1/medha-os/training/dataset-links— Remove Dataset LinkPOST/api/v1/training/start— Start Training+8 more. See OpenAPI for full list.