💻 Configure Code Runner

• In src/configs/config.yml, modify api_url to your custom code runner API.

    code-runner:
      api_url: <YOUR_CODE_RUNNER_API>
  

  The code runner API is called via POST request and must conform to the following request and response formats.

  • Request format: The request body is in JSON format and includes the following fields.

      {
        "id": <REQUEST_ID>, # Unique identifier for the request, type: string
        "code_text": <CODE>, # Code text, type: string
        "code_type": <PROGRAMMING_LANGUAGE>, # Programming language type, e.g., "python"
      }
    

  • Response format: The response body is in JSON format, with the code execution text output in the text field and image output in the img field. Example response:

      {
        "id": <REQUEST_ID>, # Unique identifier for the request, type: string
        "code": 200, # Status code: 200 for success, 500 for failure, type: int
        "data": [
          {"text": "Hello world!\n"}, 
          {"img": "iVBORw0KGgoAAAANSUhEUgAAAjMAAAHFCAYAAAAHcXhbAAAAOXRFWHRTb2Z0d2FyZQBNYXRwbG90bGliIHZlcnNpb24zLjYuMiwgaHR0cHM6Ly9tYXRwbG90bGliLm9yZy8o6BhiAAAACXBIWXMAAA9hAAAPY……ggg=="}, 
          {"text": "Hello DeepLiterature"}
        ], 
        "msg": "success", # Execution status message, type: string
        "time": 0.711 # Execution time in seconds, type: float
      }
    

• Ensure security: The code runner uses a sandbox mechanism to ensure user code runs in an isolated environment.