{
  "opencollection": "1.0.0",
  "info": {
    "name": "API Reference subpackage_actions subpackage_states API",
    "version": "1.0.0"
  },
  "items": [
    {
      "info": {
        "name": "subpackage_states",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "✨ Trigger state backfill for organization",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "http://localhost:8000/api/fsm/backfill/",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "project_id",
                "value": "",
                "type": "query",
                "description": "Optional project ID to trigger backfill for a single project"
              }
            ]
          },
          "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>\nTrigger state backfill for the authentic"
        },
        {
          "info": {
            "name": "✨ Cancel state backfill jobs",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "http://localhost:8000/api/fsm/backfill/",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "job_id",
                "value": "",
                "type": "query",
                "description": "Optional specific job ID to cancel"
              },
              {
                "name": "project_id",
                "value": "",
                "type": "query",
                "description": "Optional project ID to cancel its active jobs"
              }
            ]
          },
          "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 state backfill jobs for the authe"
        },
        {
          "info": {
            "name": "✨ List state backfill jobs",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://localhost:8000/api/fsm/backfill/jobs/",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ]
          },
          "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 the latest 10 state backfill jo"
        },
        {
          "info": {
            "name": "✨ Get state backfill status",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://localhost:8000/api/fsm/backfill/status/",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "job_id",
                "value": "",
                "type": "query",
                "description": "Optional job ID to retrieve specific job status"
              },
              {
                "name": "project_id",
                "value": "",
                "type": "query",
                "description": "Optional project ID to retrieve the latest job status for a project. If omitted, returns aggregated org status."
              }
            ]
          },
          "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 the status of a state backfill "
        },
        {
          "info": {
            "name": "✨ Get entity state history",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://localhost:8000/api/fsm/entities/:entity_name/:entity_id/history",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "entity_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "entity_name",
                "value": "",
                "type": "path"
              },
              {
                "name": "created_at_from",
                "value": "",
                "type": "query",
                "description": "Filter for state history items created at or after the ISO 8601 formatted date (YYYY-MM-DDTHH:MM:SS)"
              },
              {
                "name": "created_at_to",
                "value": "",
                "type": "query",
                "description": "Filter for state history items created at or before the ISO 8601 formatted date (YYYY-MM-DDTHH:MM:SS)"
              },
              {
                "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": "previous_state",
                "value": "",
                "type": "query",
                "description": "Filter previous_state by exact match (case-insensitive)"
              },
              {
                "name": "state",
                "value": "",
                "type": "query",
                "description": "Filter state by exact match (case-insensitive)"
              },
              {
                "name": "transition_name",
                "value": "",
                "type": "query",
                "description": "Filter transition_name by exact match (case-insensitive)"
              },
              {
                "name": "triggered_by",
                "value": "",
                "type": "query",
                "description": "Filter triggered_by by exact match"
              }
            ]
          },
          "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 state history of an entity"
        },
        {
          "info": {
            "name": "✨ Execute manual state transition",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "http://localhost:8000/api/fsm/entities/:entity_name/:entity_id/transition/",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "entity_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "entity_name",
                "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>\nExecute a registered manual transition f"
        }
      ]
    }
  ],
  "bundled": true
}