{
  "opencollection": "1.0.0",
  "info": {
    "name": "API Reference subpackage_actions subpackage_prompts.subpackage_prompts/runs API",
    "version": "1.0.0"
  },
  "items": [
    {
      "info": {
        "name": "subpackage_prompts.subpackage_prompts/runs",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "✨ Get inference run info",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://localhost:8000/api/prompts/:prompt_id/versions/:version_id/inference-runs",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "prompt_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "version_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "ordering",
                "value": "",
                "type": "query",
                "description": "Which field to use when ordering the results."
              },
              {
                "name": "parent_model",
                "value": "",
                "type": "query",
                "description": "The ID of the parent model for this Inference Run"
              },
              {
                "name": "project",
                "value": "",
                "type": "query",
                "description": "The ID of the project this Inference Run makes predictions on"
              },
              {
                "name": "project_subset",
                "value": "",
                "type": "query",
                "description": "Defines which tasks are operated on (e.g. HasGT will only operate on tasks with a ground truth annotation, but All will operate on all records)"
              }
            ]
          },
          "docs": "<Card href=\"https://humansignal.com/goenterprise\">\n        <img style=\"pointer-events: none; margin-left: 0px; margin-right: 0px;\" src=\"https://docs.humansignal.com/images/badge.svg\" alt=\"Label Studio Enterprise badge\"/>\n        <p style=\"margin-top: 10px; font-size: 14px;\">\n            This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n        </p>\n    </Card>\nGet information (status, metadata, etc) "
        },
        {
          "info": {
            "name": "✨ Run prompt inference",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "http://localhost:8000/api/prompts/:prompt_id/versions/:version_id/inference-runs",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "prompt_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "version_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "<Card href=\"https://humansignal.com/goenterprise\">\n        <img style=\"pointer-events: none; margin-left: 0px; margin-right: 0px;\" src=\"https://docs.humansignal.com/images/badge.svg\" alt=\"Label Studio Enterprise badge\"/>\n        <p style=\"margin-top: 10px; font-size: 14px;\">\n            This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n        </p>\n    </Card>\nRun a prompt inference."
        },
        {
          "info": {
            "name": "✨ Cancel Inference Run API",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "http://localhost:8000/api/prompts/:prompt_id/versions/:version_id/inference-runs/:inference_run_id/cancel",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "inference_run_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "prompt_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "version_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "<Card href=\"https://humansignal.com/goenterprise\">\n        <img style=\"pointer-events: none; margin-left: 0px; margin-right: 0px;\" src=\"https://docs.humansignal.com/images/badge.svg\" alt=\"Label Studio Enterprise badge\"/>\n        <p style=\"margin-top: 10px; font-size: 14px;\">\n            This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n        </p>\n    </Card>\nCancel the inference run for the given a"
        }
      ]
    }
  ],
  "bundled": true
}