API Reference
=======

The following is a detailed introduction to the Origin PilotOS API with code examples.

- RESTful API Endpoint List (GET / POST / PUT / DELETE)
- Request URLs, Parameters, and Examples
- Response Format (JSON)
- Error Code Reference Table
- SDK Usage Examples (Python / cURL)



.. toctree::
    :maxdepth: 1
    :caption: Table of Contents:

    PilotOS Login <05.1_PilotOS_Login.rst>
    Submit Quantum Chip Computing Task <05.2_Submit_Quantum_Chip_Computing_Task.rst>
    Query Task <05.3_Query_Task.rst>
    Get Queue Information <05.4_Get_Queue_Information.rst>
    Get Chip Information <05.5_Get_Chip_Information.rst>
    Submit Cluster Simulation Computing Task <05.6_Submit_Cluster_Simulation_Computing_Task.rst>
    Cluster Simulation Computing Task Status Query <05.7_Cluster_Simulation_Task_Status_Query.rst>
    Get Task Queuing Information for Specified Backend <05.8_Get_Backend_Task_Queue_Information.rst>
    Get Chip Calibration Time <05.9_Get_Chip_Calibration_Time.rst>
    Pause Chip Scheduling Service <05.10_Pause_Chip_Scheduling_Service.rst>
    Get Chip Scheduling Service Status <05.11_Get_Chip_Scheduling_Service_Status.rst>
    Manually Perform M3 Sampling <05.12_Manually_Perform_M3_Sampling.rst>
    Session-Based Task Management <05.13_Session_Based_Task_Management.rst>
    Get Optimal Qubit Blocks for Chip <05.14_Get_Optimal_Qubit_Blocks.rst>
    Get Task Priority <05.15_Get_Task_Priority.rst>