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/runRun Web Ingestion
POST/api/v1/medha-os/admin/ingestion/web/runRun Web Ingestion
GET/api/v1/medha-os/admin/configGet Configs
GET/api/v1/medha-os/admin/configGet Configs
POST/api/v1/medha-os/admin/configSet Config
POST/api/v1/medha-os/admin/configSet Config
GET/api/v1/medha-os/admin/config/listList Configs
GET/api/v1/medha-os/admin/config/listList Configs
GET/api/v1/medha-os/admin/config/{config_key}Get Config
GET/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/schemaGet Intent Schema
GET/api/v1/medha-os/ai/intent/schemaGet Intent Schema
GET/api/v1/medha-os/ai/identityGet Identity
GET/api/v1/medha-os/ai/identityGet Identity
POST/api/v1/medha-os/ai/files/guestUpload file for guest chat
POST/api/v1/medha-os/ai/files/guestUpload file for guest chat
GET/api/v1/medha-os/ai/files/guest/{file_id}Download guest file
GET/api/v1/medha-os/ai/files/guest/{file_id}Download guest file
POST/api/v1/medha-os/ai/chat/guestPublic guest chat
POST/api/v1/medha-os/ai/chat/guestPublic guest chat

+194 more. See OpenAPI for full list.

AI Execution
POST/api/v1/medha-os/ai/executeExecute AI Operation
POST/api/v1/medha-os/ai/executeExecute AI Operation
POST/api/v1/ai/executeExecute AI Operation
POST/api/v1/ai/executeExecute AI Operation
Assistant
POST/api/v1/medha-os/assistant/chatChat with Assistant
POST/api/v1/medha-os/assistant/chatChat with Assistant
GET/api/v1/medha-os/assistant/capabilitiesGet Assistant Capabilities
GET/api/v1/medha-os/assistant/capabilitiesGet Assistant Capabilities
GET/api/v1/medha-os/assistant/conversationsList Conversations
GET/api/v1/medha-os/assistant/conversationsList Conversations
GET/api/v1/medha-os/assistant/conversations/{conversation_id}Get Conversation
GET/api/v1/medha-os/assistant/conversations/{conversation_id}Get Conversation
DELETE/api/v1/medha-os/assistant/conversations/{conversation_id}Delete Conversation
DELETE/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 Case
GET/api/v1/medha-os/audit/cases/{case_id}Get Audit Trail for Case
GET/api/v1/medha-os/audit/export/{case_id}Export Audit Trail
GET/api/v1/medha-os/audit/export/{case_id}Export Audit Trail
GET/api/v1/medha-os/audit/verify/{case_id}Verify Audit Trail Hash Chain
GET/api/v1/medha-os/audit/verify/{case_id}Verify Audit Trail Hash Chain
GET/api/v1/medha-os/auditList Audit Events
GET/api/v1/medha-os/auditList Audit Events
GET/api/v1/audit/cases/{case_id}Get Audit Trail for Case
GET/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/loginLogin
POST/api/v1/medha-os/auth/loginLogin
POST/api/v1/medha-os/auth/logoutLogout
POST/api/v1/medha-os/auth/logoutLogout
GET/api/v1/medha-os/auth/oauth/loginOauth Login
GET/api/v1/medha-os/auth/oauth/loginOauth Login
GET/api/v1/medha-os/auth/oauth/callbackOauth Callback
GET/api/v1/medha-os/auth/oauth/callbackOauth Callback
POST/api/v1/medha-os/auth/oauth/logoutOauth Logout
POST/api/v1/medha-os/auth/oauth/logoutOauth Logout

+10 more. See OpenAPI for full list.

Chat
POST/api/v1/chat/messageChat Message
Data Export
POST/api/v1/medha-os/data/exportExport All Tenant Data
POST/api/v1/medha-os/data/exportExport All Tenant Data
POST/api/v1/data/exportExport All Tenant Data
POST/api/v1/data/exportExport All Tenant Data
Data Ingestion
POST/api/v1/medha-os/ingestion/urlsIngest Urls
POST/api/v1/medha-os/ingestion/urlsIngest Urls
POST/api/v1/medha-os/ingestion/filesIngest Files
POST/api/v1/medha-os/ingestion/filesIngest Files
POST/api/v1/medha-os/ingestion/structuredIngest Structured
POST/api/v1/medha-os/ingestion/structuredIngest Structured
GET/api/v1/medha-os/ingestion/jobsList Ingestion Jobs
GET/api/v1/medha-os/ingestion/jobsList Ingestion Jobs
GET/api/v1/medha-os/ingestion/statusGet Tenant Ingestion Status
GET/api/v1/medha-os/ingestion/statusGet Tenant Ingestion Status

+18 more. See OpenAPI for full list.

Evals
POST/api/v1/medha-os/evals/runRun Eval
POST/api/v1/medha-os/evals/runRun Eval
POST/api/v1/medha-os/evals/compareCompare Evals
POST/api/v1/medha-os/evals/compareCompare Evals
GET/api/v1/medha-os/evals/resultsList Eval Results
GET/api/v1/medha-os/evals/resultsList Eval Results
POST/api/v1/evals/runRun Eval
POST/api/v1/evals/runRun Eval
POST/api/v1/evals/compareCompare Evals
POST/api/v1/evals/compareCompare Evals

+2 more. See OpenAPI for full list.

Feedback
POST/api/v1/medha-os/feedback/guestSubmit Guest Feedback
POST/api/v1/medha-os/feedback/guestSubmit Guest Feedback
POST/api/v1/medha-os/feedbackSubmit Feedback
POST/api/v1/medha-os/feedbackSubmit Feedback
GET/api/v1/medha-os/feedbackList Feedback
GET/api/v1/medha-os/feedbackList Feedback
GET/api/v1/medha-os/feedback/adminList Feedback Admin
GET/api/v1/medha-os/feedback/adminList Feedback Admin
POST/api/v1/medha-os/feedback/analyzeAnalyze Feedback
POST/api/v1/medha-os/feedback/analyzeAnalyze Feedback

+14 more. See OpenAPI for full list.

Kill Switches
POST/api/v1/medha-os/kill-switches/ai/disableDisable AI Globally
POST/api/v1/medha-os/kill-switches/ai/disableDisable AI Globally
POST/api/v1/medha-os/kill-switches/ai/enableEnable AI Globally
POST/api/v1/medha-os/kill-switches/ai/enableEnable AI Globally
POST/api/v1/medha-os/kill-switches/models/{model_version}/disableDisable Model
POST/api/v1/medha-os/kill-switches/models/{model_version}/disableDisable Model
POST/api/v1/medha-os/kill-switches/models/{model_version}/enableEnable Model
POST/api/v1/medha-os/kill-switches/models/{model_version}/enableEnable Model
POST/api/v1/medha-os/kill-switches/tenants/{tenant_id}/disableDisable AI for Tenant
POST/api/v1/medha-os/kill-switches/tenants/{tenant_id}/disableDisable AI for Tenant

+18 more. See OpenAPI for full list.

Metrics
GET/api/v1/medha-os/metrics/aiAI Metrics
GET/api/v1/medha-os/metrics/aiAI Metrics
GET/api/v1/medha-os/metrics/slaSLA Metrics
GET/api/v1/medha-os/metrics/slaSLA Metrics
GET/api/v1/medha-os/metrics/driftDrift alerts
GET/api/v1/medha-os/metrics/driftDrift alerts
GET/api/v1/metrics/aiAI Metrics
GET/api/v1/metrics/aiAI Metrics
GET/api/v1/metrics/slaSLA Metrics
GET/api/v1/metrics/slaSLA Metrics

+2 more. See OpenAPI for full list.

Models
POST/api/v1/medha-os/modelsCreate Model
POST/api/v1/medha-os/modelsCreate Model
GET/api/v1/medha-os/modelsList Models
GET/api/v1/medha-os/modelsList Models
GET/api/v1/medha-os/models/ab-testsList Ab Tests
GET/api/v1/medha-os/models/ab-testsList Ab Tests
GET/api/v1/medha-os/models/{model_id}Get Model
GET/api/v1/medha-os/models/{model_id}Get Model
POST/api/v1/medha-os/models/{model_id}/versionsCreate Version
POST/api/v1/medha-os/models/{model_id}/versionsCreate Version

+42 more. See OpenAPI for full list.

Onboarding
POST/api/v1/medha-os/onboardOnboard Tenant
POST/api/v1/medha-os/onboardOnboard Tenant
GET/api/v1/medha-os/onboard/status/{tenant_id}Get Onboarding Status
GET/api/v1/medha-os/onboard/status/{tenant_id}Get Onboarding Status
POST/api/v1/medha-os/onboard/verify-domainVerify Domain
POST/api/v1/medha-os/onboard/verify-domainVerify Domain
POST/api/v1/medha-os/onboard/domainsRegister Domain
POST/api/v1/medha-os/onboard/domainsRegister Domain
GET/api/v1/medha-os/onboard/domainsList Domains
GET/api/v1/medha-os/onboard/domainsList Domains

+26 more. See OpenAPI for full list.

Orchestration
GET/api/v1/medha-os/intent/schemaGet Intent Schema
GET/api/v1/medha-os/identityGet Identity
GET/api/v1/intent/schemaGet Intent Schema
GET/api/v1/identityGet Identity
Payment
POST/api/v1/medha-os/payment/createCreate Payment
POST/api/v1/medha-os/payment/createCreate Payment
GET/api/v1/medha-os/payment/status/{payment_id}Get Payment Status
GET/api/v1/medha-os/payment/status/{payment_id}Get Payment Status
GET/api/v1/medha-os/payment/status/order/{merchant_order_id}Get Payment Status By Order
GET/api/v1/medha-os/payment/status/order/{merchant_order_id}Get Payment Status By Order
POST/api/v1/medha-os/payment/callbackHandle Payment Callback
POST/api/v1/medha-os/payment/callbackHandle Payment Callback
POST/api/v1/medha-os/payment/refundProcess Refund
POST/api/v1/medha-os/payment/refundProcess Refund

+10 more. See OpenAPI for full list.

PDF Ops
POST/api/v1/medha-os/pdf/mergePdf Merge
POST/api/v1/medha-os/pdf/splitPdf Split
POST/api/v1/medha-os/pdf/split-bookmarksPdf Split Bookmarks
POST/api/v1/medha-os/pdf/split-sizePdf Split Size
POST/api/v1/medha-os/pdf/split-countPdf Split Count
POST/api/v1/medha-os/pdf/comparePdf Compare
POST/api/v1/medha-os/pdf/overlay-modePdf Overlay Mode
POST/api/v1/medha-os/pdf/convertPdf Convert Generic
POST/api/v1/medha-os/edit/replace-textReplace Text
POST/api/v1/medha-os/edit/replace-imageReplace Image

+250 more. See OpenAPI for full list.

Policy
POST/api/v1/medha-os/policy/checkPolicy Check
POST/api/v1/medha-os/policy/checkPolicy Check
GET/api/v1/medha-os/policy/packsList Policy Packs
GET/api/v1/medha-os/policy/packsList Policy Packs
POST/api/v1/medha-os/policy/packsCreate Policy Pack
POST/api/v1/medha-os/policy/packsCreate Policy Pack
POST/api/v1/medha-os/policy/packs/{pack_id}/activateActivate Policy Pack
POST/api/v1/medha-os/policy/packs/{pack_id}/activateActivate Policy Pack
POST/api/v1/policy/checkPolicy Check
POST/api/v1/policy/checkPolicy Check

+6 more. See OpenAPI for full list.

Preflight
GET/api/v1/medha-os/preflightPreflight check
GET/api/v1/medha-os/preflightPreflight check
GET/api/v1/preflightPreflight check
GET/api/v1/preflightPreflight check
Prompts
GET/api/v1/medha-os/prompts/{prompt_id}Get Latest Approved Prompt
GET/api/v1/medha-os/prompts/{prompt_id}Get Latest Approved Prompt
POST/api/v1/medha-os/prompts/{prompt_id}/versionsCreate Prompt Version
POST/api/v1/medha-os/prompts/{prompt_id}/versionsCreate Prompt Version
POST/api/v1/medha-os/prompts/{prompt_id}/versions/{version}/approveApprove Prompt Version
POST/api/v1/medha-os/prompts/{prompt_id}/versions/{version}/approveApprove Prompt Version
GET/api/v1/medha-os/promptsList Prompt Versions
GET/api/v1/medha-os/promptsList Prompt Versions
GET/api/v1/prompts/{prompt_id}Get Latest Approved Prompt
GET/api/v1/prompts/{prompt_id}Get Latest Approved Prompt

+6 more. See OpenAPI for full list.

Readiness
GET/api/v1/medha-os/readinessGet Enterprise Readiness Score
GET/api/v1/medha-os/readinessGet Enterprise Readiness Score
GET/api/v1/readinessGet Enterprise Readiness Score
GET/api/v1/readinessGet Enterprise Readiness Score
Registry
POST/api/v1/medha-os/registry/modelsCreate Provider Model
POST/api/v1/medha-os/registry/modelsCreate Provider Model
GET/api/v1/medha-os/registry/modelsList Provider Models
GET/api/v1/medha-os/registry/modelsList Provider Models
GET/api/v1/medha-os/registry/models/{model_id}Get Provider Model
GET/api/v1/medha-os/registry/models/{model_id}Get Provider Model
PATCH/api/v1/medha-os/registry/models/{model_id}Update Provider Model
PATCH/api/v1/medha-os/registry/models/{model_id}Update Provider Model
DELETE/api/v1/medha-os/registry/models/{model_id}Delete Provider Model
DELETE/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 Conversation
POST/api/v1/sastra/conversationsCreate Conversation
POST/api/v1/sastra/messagesAdd Message
POST/api/v1/sastra/leadsCreate Lead
POST/api/v1/sastra/continue-chatContinue Chat
Sastra
GET/api/v1/sastra/conversations/{conversation_id}Get Conversation
POST/api/v1/sastra/conversationsCreate Conversation
POST/api/v1/sastra/messagesAdd Message
POST/api/v1/sastra/leadsCreate Lead
POST/api/v1/sastra/continue-chatContinue Chat
SCIM
GET/api/v1/medha-os/scim/v2/UsersList Users
GET/api/v1/medha-os/scim/v2/UsersList Users
POST/api/v1/medha-os/scim/v2/UsersCreate User
POST/api/v1/medha-os/scim/v2/UsersCreate User
GET/api/v1/medha-os/scim/v2/Users/{user_id}Get User
GET/api/v1/medha-os/scim/v2/Users/{user_id}Get User
PUT/api/v1/medha-os/scim/v2/Users/{user_id}Update User
PUT/api/v1/medha-os/scim/v2/Users/{user_id}Update User
PATCH/api/v1/medha-os/scim/v2/Users/{user_id}Patch User
PATCH/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/historyGet Search History
GET/api/v1/medha-os/search/historyGet Search History
DELETE/api/v1/medha-os/search/historyClear Search History
DELETE/api/v1/medha-os/search/historyClear Search History
GET/api/v1/medha-os/search/suggestionsGet Search Suggestions
GET/api/v1/medha-os/search/suggestionsGet Search Suggestions
GET/api/v1/search/historyGet Search History
GET/api/v1/search/historyGet Search History
DELETE/api/v1/search/historyClear Search History
DELETE/api/v1/search/historyClear Search History

+2 more. See OpenAPI for full list.

Similarity
POST/api/v1/medha-os/similarity/calculateCalculate Document Similarity
POST/api/v1/medha-os/similarity/calculateCalculate Document Similarity
GET/api/v1/medha-os/similarity/{file_id}Find Similar Documents
GET/api/v1/medha-os/similarity/{file_id}Find Similar Documents
POST/api/v1/similarity/calculateCalculate Document Similarity
POST/api/v1/similarity/calculateCalculate Document Similarity
GET/api/v1/similarity/{file_id}Find Similar Documents
GET/api/v1/similarity/{file_id}Find Similar Documents
Tables
POST/api/v1/medha-os/tables/recognizeRecognize Tables in Document
POST/api/v1/medha-os/tables/recognizeRecognize Tables in Document
GET/api/v1/medha-os/tables/{file_id}Get Tables from Document
GET/api/v1/medha-os/tables/{file_id}Get Tables from Document
POST/api/v1/tables/recognizeRecognize Tables in Document
POST/api/v1/tables/recognizeRecognize Tables in Document
GET/api/v1/tables/{file_id}Get Tables from Document
GET/api/v1/tables/{file_id}Get Tables from Document
training
POST/api/v1/medha-os/training/startStart Training
GET/api/v1/medha-os/training/status/{job_id}Get Training Status
GET/api/v1/medha-os/training/jobsList Training Jobs
GET/api/v1/medha-os/training/checkpointsList Checkpoints
POST/api/v1/medha-os/training/jobs/{job_id}/sync-to-s3Sync Job Output To S3
GET/api/v1/medha-os/training/s3-datasetsList S3 Datasets
GET/api/v1/medha-os/training/dataset-linksGet Dataset Links
POST/api/v1/medha-os/training/dataset-linksAdd Dataset Link
DELETE/api/v1/medha-os/training/dataset-linksRemove Dataset Link
POST/api/v1/training/startStart Training

+8 more. See OpenAPI for full list.

Training
POST/api/v1/medha-os/training/startStart Training
GET/api/v1/medha-os/training/status/{job_id}Get Training Status
GET/api/v1/medha-os/training/jobsList Training Jobs
GET/api/v1/medha-os/training/checkpointsList Checkpoints
POST/api/v1/medha-os/training/jobs/{job_id}/sync-to-s3Sync Job Output To S3
GET/api/v1/medha-os/training/s3-datasetsList S3 Datasets
GET/api/v1/medha-os/training/dataset-linksGet Dataset Links
POST/api/v1/medha-os/training/dataset-linksAdd Dataset Link
DELETE/api/v1/medha-os/training/dataset-linksRemove Dataset Link
POST/api/v1/training/startStart Training

+8 more. See OpenAPI for full list.