Docus Lab SAAS Sandbox
    Docus Lab SAAS Sandbox
    • Getting Started
    • Initial Biomarkers and Biomarker Groups Setup
    • Flow Between Lab and API
    • Limitations
    • Support
    • Patient
      • Create a patient
        POST
      • Update a patient
        PUT
      • Get patient by ID
        GET
    • Visit
      • Create visit
        POST
      • Create composite visit
        POST
      • Generate AI report
        POST
      • Get AI report by visit ID
        GET
    • Lab Test
      • Create a plain lab test
        POST
      • Create a lab test with biomarkers
        POST
      • Create bulk plain lab tests
        POST
      • Create bulk lab tests with biomarkers
        POST
      • Get lab test by ID
        GET
    • Biomarker Group
      • Create a biomarker group
        POST
      • Update a biomarker group
        PUT
      • Get biomarker group by ID
        GET
    • Biomarker
      • Create a biomarker
        POST
      • Update biomarker by ID
        PUT
      • Get biomarker by ID
        GET
    • Branch
      • Create a branch
        POST
      • Update branch by ID
        PUT
      • Get branch by ID
        GET
    • Webhooks
      • Health reports
      • Notifications
    • Schemas
      • Schemas
        • UpdateBiomarkerDto
        • CreateLabTestPlanDTO
        • UpdateBiomarkerGroupDto
        • LabTestReport
        • CreateCompositeVisitDto
        • MultipleTestIdsDto
        • CreateBulkLabTestsPlainDTO
        • CreateBulkLabTestsDTO
        • CreateBranchDto
        • UpdateBranchDto
        • Biomarker
        • CreateBiomarkerGroupDto
        • CreateBiomarkerDto
        • SingleReport
        • CreatePatientDto
        • UpdatePatientDto
        • CreateVisitDto
        • CreateLabTestDTO

    Getting Started

    Welcome to the Docus Lab API and Frontend solution, a RESTful service and frontend console designed for managing patient visits, lab test results, and AI interpretation. This API allows seamless integration with medical systems, enabling efficient data management.

    Base URL#

    https://test-api-labs.docus.live/partner/lab

    Authentication#

    This API requires two API keys for authentication:
    x-api-key → Used for standard API authentication
    x-docus-key → Used for additional security and service-level access

    Authentication Headers#

    Every request must include both keys in the headers:

    Example Request Using curl#


    Endpoints Overview#

    Below is a quick overview of the available endpoints:
    Create a patient
    Update a patient
    Get patient by ID
    Create visit
    Generate AI report
    Get AI report by visit ID
    Get AI dynamics report by visit ID
    Get visit by ID
    Create a lab test
    Get lab test by ID
    Create a biomarker group
    Update a biomarker group
    Get biomarker group by ID
    Create a biomarker
    Update a biomarker
    Get biomarker by ID

    Webhooks
    Overview
    Health reports#

    Error Handling#

    The API uses standard HTTP response codes to indicate success or failure.
    Status CodeMeaning
    200 OKSuccessful request
    201 CreatedResource created successfully
    400 Bad RequestInvalid input data
    401 UnauthorizedMissing or invalid authentication token
    404 Not FoundResource not found
    500 Internal Server ErrorUnexpected server issue

    Example Error Response#

    {
      "error": "Invalid patient_id format",
      "statusCode": 400
    }

    Need Help?#

    For support or API-related questions, contact us at support@docus.ai.
    Modified at 2025-08-08 17:51:01
    Next
    Initial Biomarkers and Biomarker Groups Setup
    Built with