{
  "opencollection": "1.0.0",
  "info": {
    "name": "API Reference subpackage_actions subpackage_prompts API",
    "version": "1.0.0"
  },
  "items": [
    {
      "info": {
        "name": "subpackage_prompts",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "✨ Create batch of failed predictions",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "http://localhost:8000/api/model-run/batch-failed-predictions",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "num_failed_predictions",
                "value": "",
                "type": "query",
                "description": "Number of failed predictions being sent (for telemetry only, has no effect)"
              }
            ],
            "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>\nCreate a new batch of failed predictions"
        },
        {
          "info": {
            "name": "✨ Create batch predictions",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "http://localhost:8000/api/model-run/batch-predictions",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "num_predictions",
                "value": "",
                "type": "query",
                "description": "Number of predictions being sent (for telemetry only, has no effect)"
              }
            ],
            "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>\nCreate a new batch prediction."
        },
        {
          "info": {
            "name": "✨ Get Project Subset Task List with Predictions and Accuracy details",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://localhost:8000/api/projects/:project_pk/subset-tasks",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "project_pk",
                "value": "",
                "type": "path"
              },
              {
                "name": "include_total",
                "value": "",
                "type": "query",
                "description": "If true (default), includes task_count in response; if false, omits it."
              },
              {
                "name": "model_run",
                "value": "",
                "type": "query",
                "description": "A unique ID of a ModelRun"
              },
              {
                "name": "ordering",
                "value": "",
                "type": "query",
                "description": "Which field to use when ordering the results."
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "A page number within the paginated result set."
              },
              {
                "name": "page_size",
                "value": "",
                "type": "query",
                "description": "Number of results to return per page."
              },
              {
                "name": "parent_model",
                "value": "",
                "type": "query",
                "description": "The ID of the parent model (ModelInterface) for this Inference Run"
              },
              {
                "name": "project_subset",
                "value": "",
                "type": "query",
                "description": "The project subset to retrieve tasks for"
              }
            ]
          },
          "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>\n\n        Provides list of tasks, based o"
        },
        {
          "info": {
            "name": "✨ Get available subsets of a project (for prompts usage)",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://localhost:8000/api/projects/:project_pk/subsets",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "project_pk",
                "value": "",
                "type": "path"
              },
              {
                "name": "ordering",
                "value": "",
                "type": "query",
                "description": "Which field to use when ordering the results."
              }
            ]
          },
          "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>\n\n        Provides list of available subs"
        },
        {
          "info": {
            "name": "✨ List prompts",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://localhost:8000/api/prompts/",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "ordering",
                "value": "",
                "type": "query",
                "description": "Which field to use when ordering the results."
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "A page number within the paginated result set."
              },
              {
                "name": "page_size",
                "value": "",
                "type": "query",
                "description": "Number of results to return per page."
              },
              {
                "name": "search",
                "value": "",
                "type": "query",
                "description": "A search term."
              }
            ]
          },
          "docs": "List all prompts."
        },
        {
          "info": {
            "name": "✨ Create prompt",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "http://localhost:8000/api/prompts/",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "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>\nCreate a new prompt."
        },
        {
          "info": {
            "name": "✨ List projects compatible with prompt",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://localhost:8000/api/prompts/compatible-projects",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "ordering",
                "value": "",
                "type": "query",
                "description": "Which field to use when ordering the results."
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "A page number within the paginated result set."
              },
              {
                "name": "page_size",
                "value": "",
                "type": "query",
                "description": "Number of results to return per page."
              },
              {
                "name": "project_type",
                "value": "",
                "type": "query",
                "description": "Skill to filter by"
              }
            ]
          },
          "docs": "Retrieve a list of compatible project for prompt."
        },
        {
          "info": {
            "name": "✨ Get prompt",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://localhost:8000/api/prompts/:id/",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "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>\nRetrieve a specific prompt."
        },
        {
          "info": {
            "name": "✨ Update prompt",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "http://localhost:8000/api/prompts/:id/",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "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>\nUpdate a specific prompt by ID."
        },
        {
          "info": {
            "name": "✨ Delete prompt",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "http://localhost:8000/api/prompts/:id/",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "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>\nDelete a prompt by ID"
        }
      ]
    }
  ],
  "bundled": true
}