{
  "opencollection": "1.0.0",
  "info": {
    "name": "API Reference subpackage_actions subpackage_prompts.subpackage_prompts/versions API",
    "version": "1.0.0"
  },
  "items": [
    {
      "info": {
        "name": "subpackage_prompts.subpackage_prompts/versions",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "✨ Get default prompt version name",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://localhost:8000/api/prompts/:id/get-default-version-name",
            "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>\nGet default prompt version name"
        },
        {
          "info": {
            "name": "✨ List prompt versions",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://localhost:8000/api/prompts/:prompt_id/versions",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "prompt_id",
                "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>\nList all versions of a prompt."
        },
        {
          "info": {
            "name": "✨ Create prompt version",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "http://localhost:8000/api/prompts/:prompt_id/versions",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "prompt_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>\nCreate a new version of a prompt."
        },
        {
          "info": {
            "name": "✨ Get prompt version",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://localhost:8000/api/prompts/:prompt_id/versions/:version_id",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "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>\nRetrieve a specific prompt of a model."
        },
        {
          "info": {
            "name": "✨ Update prompt version",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "http://localhost:8000/api/prompts/:prompt_id/versions/:version_id",
            "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>\nUpdate a specific prompt version by ID."
        },
        {
          "info": {
            "name": "✨ Delete prompt version",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "http://localhost:8000/api/prompts/:prompt_id/versions/:version_id",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "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>\nDelete a prompt version by ID"
        },
        {
          "info": {
            "name": "✨ Get cost estimate for running a prompt version on a particular project/subset",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://localhost:8000/api/prompts/:prompt_id/versions/:version_id/cost-estimate",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "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>\nGet an estimate of the cost for making a"
        },
        {
          "info": {
            "name": "✨ Get refined prompt",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://localhost:8000/api/prompts/:prompt_id/versions/:version_id/refine",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "prompt_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "version_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "refinement_job_id",
                "value": "",
                "type": "query",
                "description": "Refinement Job ID acquired from the `POST /api/prompts/{prompt_id}/versions/{version_id}/refine` endpoint"
              }
            ]
          },
          "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 the refined prompt based on the `ref"
        },
        {
          "info": {
            "name": "✨ Refine a prompt version",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "http://localhost:8000/api/prompts/:prompt_id/versions/:version_id/refine",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "prompt_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "version_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "async",
                "value": "",
                "type": "query",
                "description": "Whether to run the refinement asynchronously"
              }
            ],
            "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>\nRefine a prompt version using a teacher "
        }
      ]
    }
  ],
  "bundled": true
}