{
  "opencollection": "1.0.0",
  "info": {
    "name": "API Reference subpackage_actions subpackage_comments API",
    "version": "1.0.0"
  },
  "items": [
    {
      "info": {
        "name": "subpackage_comments",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "✨ List comments",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://localhost:8000/api/comments/",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "annotation",
                "value": "",
                "type": "query"
              },
              {
                "name": "annotators",
                "value": "",
                "type": "query"
              },
              {
                "name": "draft",
                "value": "",
                "type": "query"
              },
              {
                "name": "expand_created_by",
                "value": "",
                "type": "query"
              },
              {
                "name": "ordering",
                "value": "",
                "type": "query",
                "description": "Which field to use when ordering the results."
              },
              {
                "name": "projects",
                "value": "",
                "type": "query"
              }
            ]
          },
          "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 comments for a specific annotat"
        },
        {
          "info": {
            "name": "✨ Create comment",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "http://localhost:8000/api/comments/",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "expand_created_by",
                "value": "",
                "type": "query",
                "description": "Expand the created_by field"
              }
            ],
            "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 comment for a specific annotati"
        },
        {
          "info": {
            "name": "✨ Export comments to CSV",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://localhost:8000/api/comments/export/",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "annotation",
                "value": "",
                "type": "query"
              },
              {
                "name": "annotators",
                "value": "",
                "type": "query"
              },
              {
                "name": "draft",
                "value": "",
                "type": "query"
              },
              {
                "name": "expand_created_by",
                "value": "",
                "type": "query"
              },
              {
                "name": "projects",
                "value": "",
                "type": "query"
              },
              {
                "name": "tz",
                "value": "",
                "type": "query",
                "description": "Timezone in which to export the data. Format IANA timezone name, e.g. \"America/New_York\""
              }
            ]
          },
          "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>\nExport comments to CSV file"
        },
        {
          "info": {
            "name": "✨ Get comment",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://localhost:8000/api/comments/:id/",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              },
              {
                "name": "expand_created_by",
                "value": "",
                "type": "query",
                "description": "Expand the created_by field"
              }
            ]
          },
          "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 comment by ID for an"
        },
        {
          "info": {
            "name": "✨ Update comment",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "http://localhost:8000/api/comments/:id/",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              },
              {
                "name": "expand_created_by",
                "value": "",
                "type": "query",
                "description": "Expand the created_by field"
              }
            ],
            "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 comment by ID."
        },
        {
          "info": {
            "name": "✨ Delete comment",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "http://localhost:8000/api/comments/:id/",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              },
              {
                "name": "expand_created_by",
                "value": "",
                "type": "query",
                "description": "Expand the created_by field"
              }
            ]
          },
          "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 comment by ID"
        }
      ]
    }
  ],
  "bundled": true
}