` to explore them.
Example: `GET api/actions?id=delete_tasks&project=1`"
}
]
},
{
"info": {
"name": "subpackage_views",
"type": "folder"
},
"items": [
{
"info": {
"name": "List views",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/dm/views/",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "project",
"value": "",
"type": "query",
"description": "Project ID"
}
]
},
"docs": "List all views for a specific project."
},
{
"info": {
"name": "Create view",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://localhost:8000/api/dm/views/",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create a view for a specific project."
},
{
"info": {
"name": "Update order of views",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://localhost:8000/api/dm/views/order/",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update the order field of views based on the provided list of view IDs"
},
{
"info": {
"name": "Delete all project views",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "http://localhost:8000/api/dm/views/reset/",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "project",
"value": "",
"type": "query",
"description": "Project ID"
}
]
},
"docs": "Delete all views for a specific project."
},
{
"info": {
"name": "Get view details",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/dm/views/:id/",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "View ID"
}
]
},
"docs": "Get the details about a specific view in the data manager"
},
{
"info": {
"name": "Update view",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "http://localhost:8000/api/dm/views/:id/",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "View ID"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update view data with additional filters and other information for a specific project."
},
{
"info": {
"name": "Delete view",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "http://localhost:8000/api/dm/views/:id/",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "View ID"
}
]
},
"docs": "Delete a specific view by ID."
}
]
},
{
"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": "\n ![\"Label](\"https://docs.humansignal.com/images/badge.svg\")
\n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \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": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \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": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \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": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \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": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \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": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nExecute a registered manual transition f"
}
]
},
{
"info": {
"name": "subpackage_files",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get file upload",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/import/file-upload/:id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
]
},
"docs": "Retrieve details about a specific uploaded file."
},
{
"info": {
"name": "Update file upload",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "http://localhost:8000/api/import/file-upload/:id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update a specific uploaded file."
},
{
"info": {
"name": "Delete file upload",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "http://localhost:8000/api/import/file-upload/:id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
]
},
"docs": "Delete a specific uploaded file."
},
{
"info": {
"name": "Get files list",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/projects/:id/file-uploads",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
},
{
"name": "all",
"value": "",
"type": "query",
"description": "Set to \"true\" if you want to retrieve all file uploads"
},
{
"name": "ids",
"value": "",
"type": "query",
"description": "Specify the list of file upload IDs to retrieve, e.g. ids=[1,2,3]"
},
{
"name": "ordering",
"value": "",
"type": "query",
"description": "Which field to use when ordering the results."
}
]
},
"docs": "\n Retrieve the list of uploaded files used to create labeling tasks for a specific project.\n "
},
{
"info": {
"name": "Delete files",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "http://localhost:8000/api/projects/:id/file-uploads",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
]
},
"docs": "\n Delete uploaded files for a specific project.\n "
},
{
"info": {
"name": "Download file",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/data/upload/:filename",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "filename",
"value": "",
"type": "path"
}
]
},
"docs": "Download a specific uploaded file."
}
]
},
{
"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": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \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": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \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": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \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": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \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": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \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": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \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": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \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": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nDelete a prompt by ID"
}
]
},
{
"info": {
"name": "subpackage_prompts.subpackage_prompts/indicators",
"type": "folder"
},
"items": [
{
"info": {
"name": "✨ Get key indicators",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/inference-runs/:id/indicators/",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
]
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nGet key indicators for the Prompt dashbo"
},
{
"info": {
"name": "✨ Get key indicator",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/inference-runs/:id/indicators/:indicator_key",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
},
{
"name": "indicator_key",
"value": "",
"type": "path"
}
]
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nGet a specific key indicator for the Pro"
}
]
},
{
"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": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \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": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \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": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \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": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \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": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \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": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \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": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \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": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \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": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nRefine a prompt version using a teacher "
}
]
},
{
"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": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \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": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \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": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nCancel the inference run for the given a"
}
]
},
{
"info": {
"name": "subpackage_organizations",
"type": "folder"
},
"items": [
{
"info": {
"name": "Reset organization token",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://localhost:8000/api/invite/reset-token",
"headers": [
{
"name": "Authorization",
"value": ""
}
]
},
"docs": "Reset the token used in the invitation link to invite someone to an organization."
},
{
"info": {
"name": "List your organizations",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/organizations/",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "ordering",
"value": "",
"type": "query",
"description": "Which field to use when ordering the results."
}
]
},
"docs": "\n Return a list of the organizations you've created or that you have access to.\n "
},
{
"info": {
"name": "Get organization settings",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/organizations/:id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
]
},
"docs": "Retrieve the settings for a specific organization by ID."
},
{
"info": {
"name": "✨ Update organization",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "http://localhost:8000/api/organizations/:id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nUpdate organization details including ti"
},
{
"info": {
"name": "✨ Update default role",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "http://localhost:8000/api/organizations/:id/set-default-role",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nUpdate the default role for members of a"
}
]
},
{
"info": {
"name": "subpackage_organizations.subpackage_organizations/invites",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get invite link",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/invite",
"headers": [
{
"name": "Authorization",
"value": ""
}
]
},
"docs": "Get invite link for organization"
},
{
"info": {
"name": "✨ Revoke invite",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://localhost:8000/api/invite/revoke",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nRevoke invite to organization"
},
{
"info": {
"name": "✨ Send email with invite",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://localhost:8000/api/invite/send-email",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nSend email with invite to organization"
}
]
},
{
"info": {
"name": "subpackage_organizations.subpackage_organizations/memberTags",
"type": "folder"
},
"items": [
{
"info": {
"name": "✨ List organization member tags",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/organizations/:id/member-tags",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "A unique integer value identifying this organization."
},
{
"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 per page (default: 30, max: 100)."
},
{
"name": "search",
"value": "",
"type": "query",
"description": "Search tags by label (case-insensitive)."
}
]
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nRetrieve a list of all member tags for a"
},
{
"info": {
"name": "✨ Create organization member tag",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://localhost:8000/api/organizations/:id/member-tags",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "A unique integer value identifying this organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nCreate a new member tag for a specific o"
},
{
"info": {
"name": "✨ Bulk assign tags to organization members",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://localhost:8000/api/organizations/:id/member-tags/assignments",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "A unique integer value identifying this organization."
},
{
"name": "exclude_project_id",
"value": "",
"type": "query",
"description": "Filter exclude_project_id by exact match"
},
{
"name": "exclude_workspace_id",
"value": "",
"type": "query",
"description": "Filter exclude_workspace_id by exact match"
},
{
"name": "is_deleted",
"value": "",
"type": "query",
"description": "Filter is_deleted by exact match"
},
{
"name": "role",
"value": "",
"type": "query",
"description": "Multiple values may be separated by commas. (comma-separated values)"
},
{
"name": "tags",
"value": "",
"type": "query",
"description": "Multiple values may be separated by commas. (comma-separated values)"
},
{
"name": "user__last_activity__gte",
"value": "",
"type": "query",
"description": "Filter user__last_activity by greater than or equal to"
},
{
"name": "user__last_activity__lte",
"value": "",
"type": "query",
"description": "Filter user__last_activity by less than or equal to"
},
{
"name": "user_type",
"value": "",
"type": "query",
"description": "Multiple values may be separated by commas. (comma-separated values)"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nAssign tags to multiple organization mem"
},
{
"info": {
"name": "✨ Import member tags from CSV",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://localhost:8000/api/organizations/:id/member-tags/imports",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "A unique integer value identifying this organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nUpload a CSV file to bulk import member "
},
{
"info": {
"name": "✨ Get member tag import status",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/organizations/:id/member-tags/imports/:import_pk",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "A unique integer value identifying this organization."
},
{
"name": "import_pk",
"value": "",
"type": "path",
"description": "A unique integer value identifying this import job."
}
]
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nRetrieve the status and results of a mem"
},
{
"info": {
"name": "✨ Get organization member tag",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/organizations/:id/member-tags/:tag_pk",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "A unique integer value identifying this organization."
},
{
"name": "tag_pk",
"value": "",
"type": "path",
"description": "A unique integer value identifying this member tag."
}
]
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nRetrieve details of a specific member ta"
},
{
"info": {
"name": "✨ Update organization member tag",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "http://localhost:8000/api/organizations/:id/member-tags/:tag_pk",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "A unique integer value identifying this organization."
},
{
"name": "tag_pk",
"value": "",
"type": "path",
"description": "A unique integer value identifying this member tag."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nPartially update an existing member tag."
},
{
"info": {
"name": "✨ Delete organization member tag",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "http://localhost:8000/api/organizations/:id/member-tags/:tag_pk",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "A unique integer value identifying this organization."
},
{
"name": "tag_pk",
"value": "",
"type": "path",
"description": "A unique integer value identifying this member tag."
}
]
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nDelete a member tag from the organizatio"
}
]
},
{
"info": {
"name": "subpackage_organizations.subpackage_organizations/memberTags.subpackage_organizations/memberTags/bulk",
"type": "folder"
},
"items": [
{
"info": {
"name": "✨ Bulk create organization member tags",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://localhost:8000/api/organizations/:id/member-tags/bulk",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "A unique integer value identifying this organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nCreate multiple member tags for the orga"
},
{
"info": {
"name": "✨ Bulk delete organization member tags",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "http://localhost:8000/api/organizations/:id/member-tags/bulk",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "A unique integer value identifying this organization."
},
{
"name": "ids",
"value": "",
"type": "query",
"description": "Tag IDs to delete. Accepts comma-separated values (e.g., `1,2`) or repeated params."
}
]
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nDelete multiple member tags from the org"
}
]
},
{
"info": {
"name": "subpackage_organizations.subpackage_organizations/members",
"type": "folder"
},
"items": [
{
"info": {
"name": "✨ Get organization members/roles",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/organizations/:id/memberships",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "A unique integer value identifying this organization."
},
{
"name": "contributed_to_projects",
"value": "",
"type": "query",
"description": "Whether to include projects created and contributed to by the members."
},
{
"name": "exclude_project_id",
"value": "",
"type": "query",
"description": "Project ID to exclude users who are already associated with this project (direct members, workspace members, or implicit admin/owner access)."
},
{
"name": "exclude_workspace_id",
"value": "",
"type": "query",
"description": "Workspace ID to exclude users who are already associated with this workspace (direct workspace members or implicit admin/owner access)."
},
{
"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": "role",
"value": "",
"type": "query",
"description": "Filter members by organization role. Accepts single role or comma-separated list of roles.\n\n**Format:**\n- Single role: `?role=RE`\n- Multiple roles: `?role=AN,RE` (users with ANY of these roles)\n\n**Role Codes:**\n- `OW` = Owner\n- `AD` = Administrator\n- `MA` = Manager\n- `RE` = Reviewer\n- `AN` = Annotator\n- `NO` = Not Activated\n- `DI` = Disabled\n"
},
{
"name": "scope",
"value": "",
"type": "query",
"description": "Member visibility scope. `accessible` (default) limits Managers to members in their projects/workspaces. `all` returns all organization members. Only affects Manager role."
},
{
"name": "search",
"value": "",
"type": "query",
"description": "A search term."
},
{
"name": "tags",
"value": "",
"type": "query",
"description": "Filter members by tags. Use a comma-separated list of tag IDs."
}
]
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nRetrieve a list of all users and roles i"
},
{
"info": {
"name": "✨ Update organization member/role",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "http://localhost:8000/api/organizations/:id/memberships",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "A unique integer value identifying this organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nUpdate organization membership or role f"
},
{
"info": {
"name": "Get organization member details",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/organizations/:id/memberships/:user_pk/",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
},
{
"name": "user_pk",
"value": "",
"type": "path",
"description": "A unique integer value identifying the user to get organization details for."
},
{
"name": "contributed_to_projects",
"value": "",
"type": "query",
"description": "Whether to include projects created and contributed to by the member."
}
]
},
"docs": "Get organization member details by user ID."
},
{
"info": {
"name": "Soft delete an organization member",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "http://localhost:8000/api/organizations/:id/memberships/:user_pk/",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
},
{
"name": "user_pk",
"value": "",
"type": "path",
"description": "A unique integer value identifying the user to be deleted from the organization."
}
]
},
"docs": "Soft delete a member from the organization."
}
]
},
{
"info": {
"name": "subpackage_organizations.subpackage_organizations/permissions",
"type": "folder"
},
"items": [
{
"info": {
"name": "✨ List organization permission overrides",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/organizations/:id/permissions",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
},
{
"name": "ordering",
"value": "",
"type": "query",
"description": "Which field to use when ordering the results."
}
]
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nList all organization-level permission o"
},
{
"info": {
"name": "✨ Create organization permission override",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://localhost:8000/api/organizations/:id/permissions",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nCreate a new organization-level permissi"
},
{
"info": {
"name": "✨ Get configurable permissions options",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/organizations/:id/permissions/options",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
},
{
"name": "ordering",
"value": "",
"type": "query",
"description": "Which field to use when ordering the results."
}
]
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nRetrieve the list of configurable permis"
},
{
"info": {
"name": "✨ Retrieve organization permission override",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/organizations/:id/permissions/:permission",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
},
{
"name": "permission",
"value": "",
"type": "path"
}
]
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nRetrieve the organization-level permissi"
},
{
"info": {
"name": "✨ Replace organization permission override",
"type": "http"
},
"http": {
"method": "PUT",
"url": "http://localhost:8000/api/organizations/:id/permissions/:permission",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "A unique integer value identifying this organization."
},
{
"name": "permission",
"value": "",
"type": "path",
"description": "Permission key to update within the organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nReplace the organization-level permissio"
},
{
"info": {
"name": "✨ Update organization permission override",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "http://localhost:8000/api/organizations/:id/permissions/:permission",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
},
{
"name": "permission",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nPartially update the organization-level "
},
{
"info": {
"name": "✨ Delete organization permission override",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "http://localhost:8000/api/organizations/:id/permissions/:permission",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
},
{
"name": "permission",
"value": "",
"type": "path"
}
]
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nDelete the organization-level permission"
}
]
},
{
"info": {
"name": "subpackage_jwtSettings",
"type": "folder"
},
"items": [
{
"info": {
"name": "Retrieve JWT Settings",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/jwt/settings",
"headers": [
{
"name": "Authorization",
"value": ""
}
]
},
"docs": "Retrieve JWT settings for the currently active organization."
},
{
"info": {
"name": "Update JWT Settings",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://localhost:8000/api/jwt/settings",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update JWT settings for the currently active organization."
}
]
},
{
"info": {
"name": "subpackage_projects",
"type": "folder"
},
"items": [
{
"info": {
"name": "List projects",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/projects/",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "archived",
"value": "",
"type": "query",
"description": "Filter by projects that belong to archived workspaces"
},
{
"name": "filter",
"value": "",
"type": "query",
"description": "Filter projects by pinned status. Use 'pinned_only' to return only pinned projects, 'exclude_pinned' to return only non-pinned projects, or 'all' to return all projects."
},
{
"name": "ids",
"value": "",
"type": "query",
"description": "Filter id by in list"
},
{
"name": "include",
"value": "",
"type": "query",
"description": "Comma-separated list of count fields to include in the response to optimize performance. Available fields: task_number, finished_task_number, total_predictions_number, total_annotations_number, num_tasks_with_annotations, useful_annotation_number, ground_truth_number, skipped_annotations_number. If not specified, all count fields are included."
},
{
"name": "members_limit",
"value": "",
"type": "query",
"description": "Maximum number of members to return"
},
{
"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": "Search term for project title and description"
},
{
"name": "state",
"value": "",
"type": "query",
"description": "Filter current_state by exact match"
},
{
"name": "title",
"value": "",
"type": "query",
"description": "Filter title by contains (case-insensitive)"
},
{
"name": "workspaces",
"value": "",
"type": "query",
"description": "Filter workspaces by exact match"
}
]
},
"docs": "Retrieve a list of projects."
},
{
"info": {
"name": "Create a project",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://localhost:8000/api/projects/",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create a project for a specific organization."
},
{
"info": {
"name": "List projects' counts",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/projects/counts/",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "archived",
"value": "",
"type": "query",
"description": "Filter by projects that belong to archived workspaces"
},
{
"name": "filter",
"value": "",
"type": "query",
"description": "Filter projects by pinned status. Use 'pinned_only' to return only pinned projects, 'exclude_pinned' to return only non-pinned projects, or 'all' to return all projects."
},
{
"name": "ids",
"value": "",
"type": "query",
"description": "Filter id by in list"
},
{
"name": "include",
"value": "",
"type": "query",
"description": "Comma-separated list of count fields to include in the response to optimize performance. Available fields: task_number, finished_task_number, total_predictions_number, total_annotations_number, num_tasks_with_annotations, useful_annotation_number, ground_truth_number, skipped_annotations_number. If not specified, all count fields are included."
},
{
"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": "Search term for project title and description"
},
{
"name": "state",
"value": "",
"type": "query",
"description": "Filter current_state by exact match"
},
{
"name": "title",
"value": "",
"type": "query",
"description": "Filter title by contains (case-insensitive)"
},
{
"name": "workspaces",
"value": "",
"type": "query",
"description": "Filter workspaces by exact match"
}
]
},
"docs": "Returns a list of projects with their counts. For example, task_number which is the total task number in project"
},
{
"info": {
"name": "Get project by ID",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/projects/:id/",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
},
{
"name": "members_limit",
"value": "",
"type": "query",
"description": "Maximum number of members to return"
}
]
},
"docs": "Retrieve information about a project by project ID."
},
{
"info": {
"name": "Update project details",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "http://localhost:8000/api/projects/:id/",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
},
{
"name": "members_limit",
"value": "",
"type": "query",
"description": "Maximum number of members to return"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update the details of a specific project."
},
{
"info": {
"name": "Delete project",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "http://localhost:8000/api/projects/:id/",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
]
},
"docs": "Delete a project by specified project ID."
},
{
"info": {
"name": "List unique annotators for project",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/projects/:id/annotators/",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
]
},
"docs": "Return unique users who have submitted annotations in the specified project."
},
{
"info": {
"name": "✨ Duplicate project",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://localhost:8000/api/projects/:id/duplicate/",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nMake a copy of project."
},
{
"info": {
"name": "Import tasks",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://localhost:8000/api/projects/:id/import",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "A unique integer value identifying this project."
},
{
"name": "commit_to_project",
"value": "",
"type": "query",
"description": "Set to \"true\" to immediately commit tasks to the project."
},
{
"name": "preannotated_from_fields",
"value": "",
"type": "query",
"description": "List of fields to preannotate from the task data. For example, if you provide a list of `{\"text\": \"text\", \"prediction\": \"label\"}` items in the request, the system will create a task with the `text` field and a prediction with the `label` field when `preannoted_from_fields=[\"prediction\"]`."
},
{
"name": "return_task_ids",
"value": "",
"type": "query",
"description": "Set to \"true\" to return task IDs in the response."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "\n Import data as labeling tasks in bulk using this API endpoint. You can use this API endpoint to import multiple tasks.\n One POST request is limited at 250K tasks and 200 MB.\n\n **Note:** Imported data is verified against a project *label_config* and must\n include all variables that were used in the *label_config*. For example,\n if the label configuration has a *$text* variable, then each item in a data object\n must include a \"tex"
},
{
"info": {
"name": "Import predictions",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://localhost:8000/api/projects/:id/import/predictions",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "A unique integer value identifying this project."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Import model predictions for tasks in the specified project."
},
{
"info": {
"name": "Validate project label config",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://localhost:8000/api/projects/:id/validate/",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "A unique integer value identifying this project."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Determine whether the label configuration for a specific project is valid."
}
]
},
{
"info": {
"name": "subpackage_projects.subpackage_projects/roles",
"type": "folder"
},
"items": [
{
"info": {
"name": "✨ List project roles for current user",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/projects/roles/",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "ids",
"value": "",
"type": "query"
},
{
"name": "ordering",
"value": "",
"type": "query",
"description": "Which field to use when ordering the results."
}
]
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \n\n List project roles for requeste"
},
{
"info": {
"name": "✨ Create project role for user",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://localhost:8000/api/projects/roles/",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \n\n Create project role for user al"
},
{
"info": {
"name": "✨ Remove project role for user",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "http://localhost:8000/api/projects/roles/:id/",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "A unique integer value identifying this project role."
}
]
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \n\n Remove project role for user al"
},
{
"info": {
"name": "✨ List project roles",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/projects/:id/roles",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
]
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \n\n List users and their project le"
}
]
},
{
"info": {
"name": "subpackage_projects.subpackage_projects/metrics",
"type": "folder"
},
"items": [
{
"info": {
"name": "✨ Get project metrics configuration",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/projects/:id/metricparam/",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
]
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nGet the current metrics configuration fo"
},
{
"info": {
"name": "✨ Update project metrics configuration",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://localhost:8000/api/projects/:id/metricparam/",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nUpdate metrics strategy and parameters f"
}
]
},
{
"info": {
"name": "subpackage_projects.subpackage_projects/metrics.subpackage_projects/metrics/custom",
"type": "folder"
},
"items": [
{
"info": {
"name": "✨ Get AWS custom metric code",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/projects/:id/aws-custom-function",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
]
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nGet the AWS Lambda code for the custom m"
},
{
"info": {
"name": "✨ Update AWS custom metric Lambda",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://localhost:8000/api/projects/:id/aws-custom-function",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nCreate or update the AWS Lambda function"
},
{
"info": {
"name": "✨ Get AWS lambda logs for project",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/projects/:id/aws-custom-function-logs",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "End date for AWS logs filtering in format %Y-%m-%d"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit the number of logs to return"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Start date for AWS logs filtering in format %Y-%m-%d"
}
]
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nGet AWS lambda logs for project, includi"
},
{
"info": {
"name": "✨ Check custom matching function code",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://localhost:8000/api/projects/:id/check-function",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nValidate custom matching function code f"
},
{
"info": {
"name": "✨ Get custom metric code",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/projects/:id/custom-function",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
]
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nGet the custom metric function code for "
},
{
"info": {
"name": "✨ Deploy custom metric function",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://localhost:8000/api/projects/:id/custom-function",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nCreate or update the custom metric funct"
},
{
"info": {
"name": "✨ Get custom metric function logs",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/projects/:id/custom-function-logs",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "End date for log filtering in format %Y-%m-%d"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit the number of logs to return"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Start date for log filtering in format %Y-%m-%d"
}
]
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nGet execution logs for the custom metric"
},
{
"info": {
"name": "✨ Get GCP custom metric code",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/projects/:id/gcp-custom-function",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
]
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nGet the GCP Cloud Function code for the "
},
{
"info": {
"name": "✨ Update GCP custom metric Cloud Function",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://localhost:8000/api/projects/:id/gcp-custom-function",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nCreate or update the GCP Cloud Function "
}
]
},
{
"info": {
"name": "subpackage_projects.subpackage_projects/exports",
"type": "folder"
},
"items": [
{
"info": {
"name": "[Deprecated] Easy export of tasks and annotations",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/projects/:id/export",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "A unique integer value identifying this project."
},
{
"name": "download_all_tasks",
"value": "",
"type": "query",
"description": "If true, download all tasks regardless of status. If false, download only annotated tasks."
},
{
"name": "download_resources",
"value": "",
"type": "query",
"description": "If true, download all resource files such as images, audio, and others relevant to the tasks."
},
{
"name": "export_type",
"value": "",
"type": "query",
"description": "Selected export format (JSON by default)"
},
{
"name": "ids",
"value": "",
"type": "query",
"description": "Specify a list of task IDs to retrieve only the details for those tasks."
}
]
},
"docs": "\n This endpoint is deprecated in Enterprise. Use the async export API instead:\n POST /api/projects/{id}/exports/ (see [Create new export](/api#operation/api_projects_exports_create)).\n\n In Label Studio Enterprise, this endpoint will always return a 404 Not Found response with instructions to use the async export API.\n\n Note: if you have a large project it's recommended to use\n export snapshots, this easy export endpoint might have timeouts.
\n "
},
{
"info": {
"name": "[Deprecated] Get export formats",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/projects/:id/export/formats",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "A unique integer value identifying this project."
}
]
},
"docs": "\n This endpoint is deprecated in Enterprise. Use the async export API instead:\n POST /api/projects/{{id}}/exports/ (see [Create new export](/api#operation/api_projects_exports_create)).\n\n In Label Studio Enterprise, this endpoint will always return a 404 Not Found response with instructions to use the async export API.\n\n Retrieve the available export formats for the current project by ID."
},
{
"info": {
"name": "List all export snapshots",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/projects/:id/exports/",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "A unique integer value identifying this project."
},
{
"name": "ordering",
"value": "",
"type": "query",
"description": "Which field to use when ordering the results."
}
]
},
"docs": "Returns a list of exported files for a specific project by ID."
},
{
"info": {
"name": "Create new export snapshot",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://localhost:8000/api/projects/:id/exports/",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "A unique integer value identifying this project."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create a new export request to start a background task and generate an export file for a specific project by ID."
},
{
"info": {
"name": "Get export snapshot by ID",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/projects/:id/exports/:export_pk",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "export_pk",
"value": "",
"type": "path",
"description": "Primary key identifying the export file."
},
{
"name": "id",
"value": "",
"type": "path",
"description": "A unique integer value identifying this project."
}
]
},
"docs": "Retrieve information about an export file by export ID for a specific project."
},
{
"info": {
"name": "Delete export snapshot",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "http://localhost:8000/api/projects/:id/exports/:export_pk",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "export_pk",
"value": "",
"type": "path",
"description": "Primary key identifying the export file."
},
{
"name": "id",
"value": "",
"type": "path",
"description": "A unique integer value identifying this project."
}
]
},
"docs": "Delete an export file by specified export ID."
},
{
"info": {
"name": "Export conversion",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://localhost:8000/api/projects/:id/exports/:export_pk/convert",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "export_pk",
"value": "",
"type": "path",
"description": "Primary key identifying the export file."
},
{
"name": "id",
"value": "",
"type": "path",
"description": "A unique integer value identifying this project."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Convert export snapshot to selected format"
},
{
"info": {
"name": "Download export snapshot as file in specified format",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/projects/:id/exports/:export_pk/download",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "export_pk",
"value": "",
"type": "path",
"description": "Primary key identifying the export file."
},
{
"name": "id",
"value": "",
"type": "path",
"description": "A unique integer value identifying this project."
},
{
"name": "exportType",
"value": "",
"type": "query",
"description": "Selected export format"
}
]
},
"docs": "\n Download an export file in the specified format for a specific project. Specify the project ID with the `id`\n parameter in the path and the ID of the export file you want to download using the `export_pk` parameter\n in the path.\n\n Get the `export_pk` from the response of the request to [Create new export](/api#operation/api_projects_exports_create)\n or after [listing export files](/api#operation/api_projects_exports_list).\n "
}
]
},
{
"info": {
"name": "subpackage_projects.subpackage_projects/members",
"type": "folder"
},
"items": [
{
"info": {
"name": "✨ Add project member",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://localhost:8000/api/projects/:id/members/",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nAdd a member to a specific project."
},
{
"info": {
"name": "✨ Remove member from project",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "http://localhost:8000/api/projects/:id/members/",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
},
{
"name": "user",
"value": "",
"type": "query",
"description": "User ID to remove from the project. Optional for backward compatibility with DELETE body."
}
]
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nRemove a member from a specific project."
}
]
},
{
"info": {
"name": "subpackage_projects.subpackage_projects/members.subpackage_projects/members/bulk",
"type": "folder"
},
"items": [
{
"info": {
"name": "✨ Bulk assign project members",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://localhost:8000/api/projects/:id/members/bulk/",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
},
{
"name": "last_activity__gte",
"value": "",
"type": "query",
"description": "Filter by last activity (ISO 8601 formatted date). Only when all=True."
},
{
"name": "last_activity__lte",
"value": "",
"type": "query",
"description": "Filter by last activity upper bound (ISO 8601 formatted date). Only when all=True."
},
{
"name": "role",
"value": "",
"type": "query",
"description": "Filter by role, project roles take precedence over organization roles. Only when all=True. (comma-separated values)"
},
{
"name": "search",
"value": "",
"type": "query",
"description": "Search term for filtering members by name, email, or username. Only when all=True."
},
{
"name": "tags",
"value": "",
"type": "query",
"description": "Multiple values may be separated by commas. (comma-separated values)"
},
{
"name": "user_type",
"value": "",
"type": "query",
"description": "Multiple values may be separated by commas. (comma-separated values)"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nAssign project members in bulk."
},
{
"info": {
"name": "✨ Bulk unassign project members",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "http://localhost:8000/api/projects/:id/members/bulk/",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
},
{
"name": "all",
"value": "",
"type": "query",
"description": "Apply unassignment to all currently matched project members."
},
{
"name": "excluded",
"value": "",
"type": "query",
"description": "Comma-separated list of user IDs to keep assigned when `all=true`."
},
{
"name": "included",
"value": "",
"type": "query",
"description": "Comma-separated list of user IDs to unassign when `all=false`."
},
{
"name": "last_activity__gte",
"value": "",
"type": "query",
"description": "Filter by last activity (ISO 8601 formatted date). Only when all=True."
},
{
"name": "last_activity__lte",
"value": "",
"type": "query",
"description": "Filter by last activity upper bound (ISO 8601 formatted date). Only when all=True."
},
{
"name": "role",
"value": "",
"type": "query",
"description": "Filter by role, project roles take precedence over organization roles. Only when all=True. (comma-separated values)"
},
{
"name": "search",
"value": "",
"type": "query",
"description": "Search term for filtering members by name, email, or username. Only when all=True."
},
{
"name": "tags",
"value": "",
"type": "query",
"description": "Multiple values may be separated by commas. (comma-separated values)"
},
{
"name": "user_type",
"value": "",
"type": "query",
"description": "Multiple values may be separated by commas. (comma-separated values)"
}
]
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nUnassign project members in bulk. Pass s"
}
]
},
{
"info": {
"name": "subpackage_projects.subpackage_projects/members.subpackage_projects/members/paginated",
"type": "folder"
},
"items": [
{
"info": {
"name": "✨ Get project members paginated",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/projects/:id/members/paginated/",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
},
{
"name": "ids",
"value": "",
"type": "query",
"description": "Comma-separated list of user IDs to filter by"
},
{
"name": "implicit",
"value": "",
"type": "query",
"description": "Include/Exclude implicit project members in the results. If not provided, explicit + implicit members are returned."
},
{
"name": "last_activity__gte",
"value": "",
"type": "query",
"description": "Filter by last activity time (ISO 8601 datetime). Returns users with last activity greater than or equal to this time."
},
{
"name": "last_activity__lte",
"value": "",
"type": "query",
"description": "Filter by last activity time (ISO 8601 datetime). Returns users with last activity less than or equal to this time."
},
{
"name": "no_annotators",
"value": "",
"type": "query",
"description": "Exclude annotators from the results"
},
{
"name": "ordering",
"value": "",
"type": "query",
"description": "Ordering field. Prefix with \"-\" for descending order. Allowed fields: id, email, first_name, last_name, username, last_activity, role, date_joined\n\n**Note on role ordering:**\nWhen ordering by \"role\", the system uses the effective role:\n- Project-specific role if assigned (takes precedence)\n- Organization role if no project role is assigned\n\nRoles are sorted alphabetically by their code: AD (Administrator), AN (Annotator), DI (Disabled), MA (Manager), NO (Not Activated), OW (Owner), RE (Reviewer)"
},
{
"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": "role",
"value": "",
"type": "query",
"description": "Filter members by role. Accepts single role or comma-separated list of roles.\n\n**Format:**\n- Single role: `?role=RE`\n- Multiple roles: `?role=AN,RE` (users with ANY of these roles)\n\n**Role Codes:**\n- `OW` = Owner\n- `AD` = Administrator\n- `MA` = Manager\n- `RE` = Reviewer\n- `AN` = Annotator\n\n**Matching Logic:**\nReturns users who have any of the specified roles either:\n1. As their **project-specific role** (from project role assignments), OR\n2. As their **organization role** (if they have no project-specific role override)\n\n**Note:** Project-specific roles take precedence. If a user has a project role assigned, their organization role is ignored for filtering purposes."
},
{
"name": "search",
"value": "",
"type": "query",
"description": "Search term for filtering members by name, email, or username"
},
{
"name": "tags",
"value": "",
"type": "query",
"description": "Filter members by tags. Use a comma-separated list of tag IDs."
},
{
"name": "with_deleted",
"value": "",
"type": "query",
"description": "Include deleted members in the results"
}
]
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nRetrieve the members for a specific proj"
}
]
},
{
"info": {
"name": "subpackage_projects.subpackage_projects/stats",
"type": "folder"
},
"items": [
{
"info": {
"name": "✨ Get model-version overall agreement vs annotators",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/projects/:id/model-stats/:model_version/agreement",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
},
{
"name": "model_version",
"value": "",
"type": "path"
}
]
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nGet agreement between a given model vers"
},
{
"info": {
"name": "✨ Get model-version ground truth agreement",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/projects/:id/model-stats/:model_version/agreement-groundtruth",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
},
{
"name": "model_version",
"value": "",
"type": "path"
},
{
"name": "per_label",
"value": "",
"type": "query",
"description": "Calculate agreement per label"
}
]
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nGet agreement between a given model vers"
},
{
"info": {
"name": "✨ Get model-version prediction agreement",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/projects/:id/model-stats/:model_version/prediction",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
},
{
"name": "model_version",
"value": "",
"type": "path"
},
{
"name": "per_label",
"value": "",
"type": "query",
"description": "Calculate agreement per label"
}
]
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nGet agreement between a given model vers"
},
{
"info": {
"name": "✨ Get Inter-Annotator Agreement matrix",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/projects/:id/stats/IAA",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
},
{
"name": "expand",
"value": "",
"type": "query",
"description": "Comma-separated list of fields to expand"
},
{
"name": "per_label",
"value": "",
"type": "query",
"description": "Calculate IAA per label"
},
{
"name": "std",
"value": "",
"type": "query",
"description": "Include standard deviation in results"
},
{
"name": "task",
"value": "",
"type": "query",
"description": "Comma-separated list of task IDs to filter by"
}
]
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nGet Inter-Annotator Agreement (IAA) matr"
},
{
"info": {
"name": "✨ Get ground truth agreement for multiple users",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/projects/:id/stats/agreement-groundtruth",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
},
{
"name": "ids",
"value": "",
"type": "query",
"description": "Comma separated list of user IDs to get ground truth agreement for"
},
{
"name": "per_label",
"value": "",
"type": "query",
"description": "Per label"
}
]
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nGet ground truth agreement statistics fo"
},
{
"info": {
"name": "✨ Get individual annotator agreement stats",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/projects/:id/stats/agreement_annotator/:user_id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
},
{
"name": "user_id",
"value": "",
"type": "path"
}
]
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nGet agreement statistics for a specific "
},
{
"info": {
"name": "✨ Get agreement statistics for multiple annotators",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/projects/:id/stats/agreement_annotators",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
},
{
"name": "ids",
"value": "",
"type": "query",
"description": "Comma separated list of annotator user IDs to get agreement scores for"
}
]
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nGet agreement statistics for multiple an"
},
{
"info": {
"name": "✨ Get user data filter statistics",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/projects/:id/stats/data_filter",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
]
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nGet statistics about user data filters a"
},
{
"info": {
"name": "✨ Get finished tasks statistics",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/projects/:id/stats/finished",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
},
{
"name": "user_pk",
"value": "",
"type": "query",
"description": "User ID to filter statistics by (optional)"
}
]
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nGet statistics about finished tasks for "
},
{
"info": {
"name": "✨ Get label distribution counts",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/projects/:id/stats/label-distribution/counts",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
},
{
"name": "choice_keys",
"value": "",
"type": "query",
"description": "Explicit choice keys to fetch, joined by \"___PIPE___\" (for example: \"label___SEP___pos___PIPE___quality___SEP___4\"). When provided, pagination params are ignored."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Maximum number of choice keys to return for pagination. Ignored when `choice_keys` is provided."
},
{
"name": "offset",
"value": "",
"type": "query",
"description": "Zero-based offset into the structure `choice_keys` list. Used only when `choice_keys` is not provided."
}
]
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nReturns counts and percentages for reque"
},
{
"info": {
"name": "✨ Get label distribution structure",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/projects/:id/stats/label-distribution/structure",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
]
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nReturns dimensions and flattened `choice"
},
{
"info": {
"name": "✨ Get lead time statistics",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/projects/:id/stats/lead_time",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
]
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nGet lead time statistics across the proj"
},
{
"info": {
"name": "✨ Get paginated member performance rows",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/projects/:id/stats/member_performance_rows/",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
},
{
"name": "ids",
"value": "",
"type": "query",
"description": "Comma-separated user IDs to include. When omitted, members are derived from the project."
},
{
"name": "ordering",
"value": "",
"type": "query",
"description": "Sort field; prefix with \"-\" for descending (e.g. \"-finished\")."
},
{
"name": "page",
"value": "",
"type": "query",
"description": "1-based page index."
},
{
"name": "page_size",
"value": "",
"type": "query",
"description": "Page size (1–100)."
},
{
"name": "table",
"value": "",
"type": "query",
"description": "Which table to load: \"annotations\" or \"reviews\"."
}
]
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nPaginated, sortable member performance r"
},
{
"info": {
"name": "✨ Get total agreement for project",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/projects/:id/stats/total_agreement",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
},
{
"name": "per_label",
"value": "",
"type": "query",
"description": "Return agreement per label"
}
]
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nOverall or per-label total agreement acr"
},
{
"info": {
"name": "✨ Start stats recalculation",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/projects/:id/update-stats",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
},
{
"name": "stat_type",
"value": "",
"type": "query",
"description": "Stat type to recalculate. Possible values: label, stats"
}
]
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nStart stats recalculation for given proj"
},
{
"info": {
"name": "✨ Get prediction agreement statistics for multiple annotators",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/projects/:id/user-stats/prediction",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
},
{
"name": "ids",
"value": "",
"type": "query",
"description": "Comma separated list of annotator user IDs to get agreement scores for"
},
{
"name": "per_label",
"value": "",
"type": "query",
"description": "Per label"
}
]
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nGet prediction agreement statistics for "
},
{
"info": {
"name": "✨ Get review scores for multiple annotators",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/projects/:id/user-stats/review_score",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
},
{
"name": "ids",
"value": "",
"type": "query",
"description": "Comma separated list of annotator user IDs to get review scores for"
},
{
"name": "per_label",
"value": "",
"type": "query",
"description": "Per label"
}
]
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nGet review score and performance score s"
},
{
"info": {
"name": "✨ Get individual user prediction agreement",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/projects/:id/user-stats/:user_pk/prediction",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
},
{
"name": "user_pk",
"value": "",
"type": "path"
},
{
"name": "per_label",
"value": "",
"type": "query",
"description": "Calculate agreement per label"
}
]
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nGet prediction agreement statistics for "
},
{
"info": {
"name": "✨ Get individual user review scores",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/projects/:id/user-stats/:user_pk/review_score",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
},
{
"name": "user_pk",
"value": "",
"type": "path"
},
{
"name": "per_label",
"value": "",
"type": "query",
"description": "Calculate agreement per label"
}
]
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nGet review score statistics for a specif"
},
{
"info": {
"name": "✨ Get individual user ground truth agreement",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/projects/:id/users/:user_pk/stats/agreement-groundtruth",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
},
{
"name": "user_pk",
"value": "",
"type": "path"
},
{
"name": "per_label",
"value": "",
"type": "query",
"description": "Calculate agreement per label"
}
]
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nGet ground truth agreement statistics fo"
}
]
},
{
"info": {
"name": "subpackage_projects.subpackage_projects/reviewRoutingRules",
"type": "folder"
},
"items": [
{
"info": {
"name": "✨ List review routing rules",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/projects/:id/review-routing-rules/",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
},
{
"name": "ordering",
"value": "",
"type": "query",
"description": "Which field to use when ordering the results."
}
]
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nList ordered review routing rules for a "
},
{
"info": {
"name": "✨ Bulk replace review routing rules",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://localhost:8000/api/projects/:id/review-routing-rules/bulk/",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nAtomically replace the ordered review ro"
}
]
},
{
"info": {
"name": "subpackage_projects.subpackage_projects/assignments",
"type": "folder"
},
"items": [
{
"info": {
"name": "✨ Bulk assign users to tasks",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://localhost:8000/api/projects/:id/tasks/assignees",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nAssign multiple users to a collection of"
},
{
"info": {
"name": "✨ Get assigned tasks and assignees",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/projects/:id/tasks/:task_pk/assignees",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "A unique integer value identifying this project."
},
{
"name": "task_pk",
"value": "",
"type": "path",
"description": "A unique integer value identifying this task."
}
]
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nRetrieve a list of tasks and assignees f"
},
{
"info": {
"name": "✨ Create task assignee",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://localhost:8000/api/projects/:id/tasks/:task_pk/assignees",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "A unique integer value identifying this project."
},
{
"name": "task_pk",
"value": "",
"type": "path",
"description": "A unique integer value identifying this task."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nAssign a user to a task in a specific pr"
},
{
"info": {
"name": "✨ Update task assignee",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "http://localhost:8000/api/projects/:id/tasks/:task_pk/assignees",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "A unique integer value identifying this project."
},
{
"name": "task_pk",
"value": "",
"type": "path",
"description": "A unique integer value identifying this task."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nUpdate the assignee for a task in a spec"
},
{
"info": {
"name": "✨ Delete task assignments",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "http://localhost:8000/api/projects/:id/tasks/:task_pk/assignees",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "A unique integer value identifying this project."
},
{
"name": "task_pk",
"value": "",
"type": "path",
"description": "A unique integer value identifying this task."
},
{
"name": "type",
"value": "",
"type": "query",
"description": "Assignment type to delete (optional). If omitted, deletes all assignments for the task."
},
{
"name": "users",
"value": "",
"type": "query",
"description": "Comma separated list of user IDs to delete, as a string. If omitted, deletes all assignees for the given type."
}
]
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nRemove assignees for a task within a spe"
}
]
},
{
"info": {
"name": "subpackage_projects.subpackage_projects/pauses",
"type": "folder"
},
"items": [
{
"info": {
"name": "✨ List pauses",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/projects/:project_pk/members/:user_pk/pauses/",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "project_pk",
"value": "",
"type": "path"
},
{
"name": "user_pk",
"value": "",
"type": "path"
},
{
"name": "include_deleted",
"value": "",
"type": "query",
"description": "Include deleted pauses."
},
{
"name": "ordering",
"value": "",
"type": "query",
"description": "Which field to use when ordering the results."
}
]
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nRetrieve a list of all pauses."
},
{
"info": {
"name": "✨ Create pause",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://localhost:8000/api/projects/:project_pk/members/:user_pk/pauses/",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "project_pk",
"value": "",
"type": "path"
},
{
"name": "user_pk",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nCreate a new pause entry."
},
{
"info": {
"name": "✨ Get pause",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/projects/:project_pk/members/:user_pk/pauses/:id/",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
},
{
"name": "project_pk",
"value": "",
"type": "path"
},
{
"name": "user_pk",
"value": "",
"type": "path"
}
]
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nRetrieve a specific pause by ID."
},
{
"info": {
"name": "✨ Update pause",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "http://localhost:8000/api/projects/:project_pk/members/:user_pk/pauses/:id/",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
},
{
"name": "project_pk",
"value": "",
"type": "path"
},
{
"name": "user_pk",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nPartially update a pause entry by ID."
},
{
"info": {
"name": "✨ Delete pause",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "http://localhost:8000/api/projects/:project_pk/members/:user_pk/pauses/:id/",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
},
{
"name": "project_pk",
"value": "",
"type": "path"
},
{
"name": "user_pk",
"value": "",
"type": "path"
}
]
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nDelete a specific pause by ID."
}
]
},
{
"info": {
"name": "subpackage_ml",
"type": "folder"
},
"items": [
{
"info": {
"name": "List ML backends",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/ml/",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "project",
"value": "",
"type": "query",
"description": "Project ID"
}
]
},
"docs": "\n List all configured ML backends for a specific project by ID.\n Use the following cURL command:\n ```bash\n curl http://localhost:8000/api/ml?project={project_id} -H 'Authorization: Token abc123'\n "
},
{
"info": {
"name": "Add ML Backend",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://localhost:8000/api/ml/",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "\n Add an ML backend to a project using the Label Studio UI or by sending a POST request using the following cURL \n command:\n ```bash\n curl -X POST -H 'Content-type: application/json' http://localhost:8000/api/ml -H 'Authorization: Token abc123'\\\n --data '{\"url\": \"http://localhost:9090\", \"project\": {project_id}}' \n "
},
{
"info": {
"name": "Get ML Backend",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/ml/:id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
]
},
"docs": "\n Get details about a specific ML backend connection by ID. For example, make a GET request using the\n following cURL command:\n ```bash\n curl http://localhost:8000/api/ml/{ml_backend_ID} -H 'Authorization: Token abc123'\n "
},
{
"info": {
"name": "Update ML Backend",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "http://localhost:8000/api/ml/:id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "\n Update ML backend parameters using the Label Studio UI or by sending a PATCH request using the following cURL command:\n ```bash\n curl -X PATCH -H 'Content-type: application/json' http://localhost:8000/api/ml/{ml_backend_ID} -H 'Authorization: Token abc123'\\\n --data '{\"url\": \"http://localhost:9091\"}' \n "
},
{
"info": {
"name": "Remove ML Backend",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "http://localhost:8000/api/ml/:id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
]
},
"docs": "\n Remove an existing ML backend connection by ID. For example, use the\n following cURL command:\n ```bash\n curl -X DELETE http://localhost:8000/api/ml/{ml_backend_ID} -H 'Authorization: Token abc123'\n "
},
{
"info": {
"name": "Request Interactive Annotation",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://localhost:8000/api/ml/:id/interactive-annotating",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "A unique integer value identifying this ML backend."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "\n Send a request to the machine learning backend set up to be used for interactive preannotations to retrieve a\n predicted region based on annotator input. \n See [set up machine learning](https://labelstud.io/guide/ml.html#Get-interactive-preannotations) for more.\n "
},
{
"info": {
"name": "✨ Create predictions for all tasks",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://localhost:8000/api/ml/:id/predict",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "A unique integer value identifying this ML backend."
},
{
"name": "batch_size",
"value": "",
"type": "query",
"description": "Computed number of tasks without predictions that the ML backend needs to predict."
}
]
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \n\n\nCreate predictions for all tasks using"
},
{
"info": {
"name": "Train",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://localhost:8000/api/ml/:id/train",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "A unique integer value identifying this ML backend."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "\n After you add an ML backend, call this API with the ML backend ID to start training with \n already-labeled tasks. \n \n Get the ML backend ID by [listing the ML backends for a project](https://labelstud.io/api/#operation/api_ml_list).\n "
},
{
"info": {
"name": "Get model versions",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/ml/:id/versions",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
]
},
"docs": "Get available versions of the model."
}
]
},
{
"info": {
"name": "subpackage_modelProviders",
"type": "folder"
},
"items": [
{
"info": {
"name": "✨ List model provider connections",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/model-provider-connections/",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "ordering",
"value": "",
"type": "query",
"description": "Which field to use when ordering the results."
}
]
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nList all model provider connections."
},
{
"info": {
"name": "✨ Create model provider connection",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://localhost:8000/api/model-provider-connections/",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nCreate a new model provider connection."
},
{
"info": {
"name": "✨ List model provider choices",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/model-provider-connections/provider-choices",
"headers": [
{
"name": "Authorization",
"value": ""
}
]
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nList all possible model provider choices"
},
{
"info": {
"name": "✨ Get model provider connection",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/model-provider-connections/:id/",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
]
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nRetrieve a specific model provider conne"
},
{
"info": {
"name": "✨ Update model provider connection",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "http://localhost:8000/api/model-provider-connections/:id/",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nUpdate a specific model provider connect"
},
{
"info": {
"name": "✨ Delete model provider connection",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "http://localhost:8000/api/model-provider-connections/:id/",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
]
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nDelete a model provider connection by ID"
}
]
},
{
"info": {
"name": "subpackage_predictions",
"type": "folder"
},
"items": [
{
"info": {
"name": "List predictions",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/predictions/",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "project",
"value": "",
"type": "query",
"description": "Filter predictions by project ID"
},
{
"name": "task",
"value": "",
"type": "query",
"description": "Filter predictions by task ID"
}
]
},
"docs": "List all predictions and their IDs."
},
{
"info": {
"name": "Create prediction",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://localhost:8000/api/predictions/",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create a prediction for a specific task."
},
{
"info": {
"name": "Get prediction details",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/predictions/:id/",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Prediction ID"
}
]
},
"docs": "Get details about a specific prediction by its ID."
},
{
"info": {
"name": "Update prediction",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "http://localhost:8000/api/predictions/:id/",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Prediction ID"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update prediction data by prediction ID."
},
{
"info": {
"name": "Delete prediction",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "http://localhost:8000/api/predictions/:id/",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Prediction ID"
}
]
},
"docs": "Delete a prediction by prediction ID."
}
]
},
{
"info": {
"name": "subpackage_projectTemplates",
"type": "folder"
},
"items": [
{
"info": {
"name": "✨ Get project templates",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/project-templates/",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "ordering",
"value": "",
"type": "query",
"description": "Which field to use when ordering the results."
}
]
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nGet a list of all project templates for "
},
{
"info": {
"name": "✨ Create project template",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://localhost:8000/api/project-templates/",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nCreate a project template for an organiz"
},
{
"info": {
"name": "✨ Get a project template",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/project-templates/:id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
]
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nGet a specific project template by ID fo"
},
{
"info": {
"name": "✨ Update a project template",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "http://localhost:8000/api/project-templates/:id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nUpdate the details of a specific project"
},
{
"info": {
"name": "✨ Delete a project template",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "http://localhost:8000/api/project-templates/:id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
]
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nDelete a specific project template by ID"
},
{
"info": {
"name": "✨ Create project from template",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://localhost:8000/api/project-templates/:id/create-project",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nCreate a project from a specific project"
}
]
},
{
"info": {
"name": "subpackage_tasks",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get project import status ",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/projects/:id/imports/:import_pk/",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "A unique integer value identifying this project import."
},
{
"name": "import_pk",
"value": "",
"type": "path"
}
]
},
"docs": "\n Poll the status of an asynchronous project import operation.\n \n **Usage:**\n 1. When you POST to `/api/projects/{project_id}/import`, you'll receive a response like `{\"import\": }`\n 2. Use that `import_id` with this GET endpoint to check the import status\n 3. Poll this endpoint to see if the import has completed, is still processing, or has failed\n 4. **Import errors and failures will only be visible in this "
},
{
"info": {
"name": "Delete all tasks",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "http://localhost:8000/api/projects/:id/tasks/",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "A unique integer value identifying this project."
}
]
},
"docs": "Delete all tasks from a specific project."
},
{
"info": {
"name": "List tasks",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/tasks/",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "fields",
"value": "",
"type": "query",
"description": "Set to \"all\" if you want to include annotations and predictions in the response. Defaults to task_only"
},
{
"name": "include",
"value": "",
"type": "query",
"description": "Specify which fields to include in the response"
},
{
"name": "only_annotated",
"value": "",
"type": "query",
"description": "Filter to show only tasks that have annotations"
},
{
"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",
"value": "",
"type": "query",
"description": "Project ID"
},
{
"name": "query",
"value": "",
"type": "query",
"description": "Additional query to filter tasks. It must be JSON encoded string of dict containing one of the following parameters: {\"filters\": ..., \"selectedItems\": ..., \"ordering\": ...}. Check Data Manager > Create View > see data field for more details about filters, selectedItems and ordering.\n\nfilters: dict with \"conjunction\" string (\"or\" or \"and\") and list of filters in \"items\" array. Each filter is a dictionary with keys: \"filter\", \"operator\", \"type\", \"value\". Read more about available filters\nExample: {\"conjunction\": \"or\", \"items\": [{\"filter\": \"filter:tasks:completed_at\", \"operator\": \"greater\", \"type\": \"Datetime\", \"value\": \"2021-01-01T00:00:00.000Z\"}]}\nselectedItems: dictionary with keys: \"all\", \"included\", \"excluded\". If \"all\" is false, \"included\" must be used. If \"all\" is true, \"excluded\" must be used.\nExamples: {\"all\": false, \"included\": [1, 2, 3]} or {\"all\": true, \"excluded\": [4, 5]}\nordering: list of fields to order by. Currently, ordering is supported by only one parameter.\nExample: [\"completed_at\"]"
},
{
"name": "resolve_uri",
"value": "",
"type": "query",
"description": "Resolve task data URIs using Cloud Storage"
},
{
"name": "review",
"value": "",
"type": "query",
"description": "Get tasks for review"
},
{
"name": "selectedItems",
"value": "",
"type": "query",
"description": "JSON string of selected task IDs for review workflow"
},
{
"name": "view",
"value": "",
"type": "query",
"description": "View ID"
}
]
},
"docs": "Retrieve a paginated list of tasks. The response format varies based on the user's role in the organization:\n- **Admin/Owner**: Full task details with all annotations, reviews, and metadata\n- **Reviewer**: Task details optimized for review workflow\n- **Annotator**: Task details filtered to show only user's own annotations and assignments"
},
{
"info": {
"name": "Create a new task",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://localhost:8000/api/tasks/",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create a new task"
},
{
"info": {
"name": "Get task",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/tasks/:id/",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Task ID"
}
]
},
"docs": "Get task data, metadata, annotations and other attributes for a specific labeling task by task ID."
},
{
"info": {
"name": "Update task",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "http://localhost:8000/api/tasks/:id/",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Task ID"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update the attributes of an existing labeling task."
},
{
"info": {
"name": "Delete task",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "http://localhost:8000/api/tasks/:id/",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Task ID"
}
]
},
"docs": "Delete a task in Label Studio. This action cannot be undone!"
},
{
"info": {
"name": "Create task event",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://localhost:8000/api/tasks/:id/events/",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Task ID to associate the event with"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "\n Create a new task event to track user interactions and system events during annotation.\n\n This endpoint is designed to receive events from the frontend labeling interface to enable\n accurate lead time calculation and detailed annotation analytics.\n\n ## Event Types\n\n **Core Annotation Events:**\n - `annotation_loaded` - When annotation interface is loaded\n - `annotation_created` - When annotation is submitted\n - `annotation_updated` - When annotation is modified\n - `an"
}
]
},
{
"info": {
"name": "subpackage_tasks.subpackage_tasks/agreementMatrix",
"type": "folder"
},
"items": [
{
"info": {
"name": "✨ Get task agreement matrix",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/projects/:project_pk/tasks/:task_pk/agreement-matrix",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "project_pk",
"value": "",
"type": "path",
"description": "Project ID"
},
{
"name": "task_pk",
"value": "",
"type": "path",
"description": "Task ID"
},
{
"name": "dimension",
"value": "",
"type": "query",
"description": "Dimension ID to compute agreement for. If not provided, averages across all active dimensions."
},
{
"name": "selection",
"value": "",
"type": "query",
"description": "JSON object specifying which participants to include in the agreement matrix"
}
]
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nReturns a pairwise agreement matrix betw"
}
]
},
{
"info": {
"name": "subpackage_sso.subpackage_sso/saml",
"type": "folder"
},
"items": [
{
"info": {
"name": "✨ Retrieve SAML2 Settings",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/saml/settings",
"headers": [
{
"name": "Authorization",
"value": ""
}
]
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nRetrieve SAML2 settings for the currentl"
},
{
"info": {
"name": "✨ Update SAML2 Settings",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://localhost:8000/api/saml/settings",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nUpdate SAML2 settings for the currently "
},
{
"info": {
"name": "✨ Reset SAML2 Settings",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "http://localhost:8000/api/saml/settings",
"headers": [
{
"name": "Authorization",
"value": ""
}
]
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nReset SAML2 settings for the currently a"
},
{
"info": {
"name": "✨ Validate SAML Metadata URL",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://localhost:8000/api/saml/settings/validate-metadata-url",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nValidate a SAML metadata URL by fetching"
}
]
},
{
"info": {
"name": "subpackage_sso.subpackage_sso/scim",
"type": "folder"
},
"items": [
{
"info": {
"name": "✨ Retrieve SCIM Settings",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/scim/settings",
"headers": [
{
"name": "Authorization",
"value": ""
}
]
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nRetrieve SCIM settings for the currently"
},
{
"info": {
"name": "✨ Update SCIM Settings",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://localhost:8000/api/scim/settings",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nUpdate SCIM settings for the currently a"
}
]
},
{
"info": {
"name": "subpackage_sessionPolicy",
"type": "folder"
},
"items": [
{
"info": {
"name": "Retrieve Session Policy",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/session-policy/",
"headers": [
{
"name": "Authorization",
"value": ""
}
]
},
"docs": "Retrieve session timeout policy for the currently active organization."
},
{
"info": {
"name": "Update Session Policy",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "http://localhost:8000/api/session-policy/",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update session timeout policy for the currently active organization."
}
]
},
{
"info": {
"name": "subpackage_importStorage",
"type": "folder"
},
"items": [
{
"info": {
"name": "List all import storages types",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/storages/types",
"headers": [
{
"name": "Authorization",
"value": ""
}
]
},
"docs": "Retrieve a list of the import storages types."
}
]
},
{
"info": {
"name": "subpackage_importStorage.subpackage_importStorage/azure",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get all import storage",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/storages/azure/",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "ordering",
"value": "",
"type": "query",
"description": "Which field to use when ordering the results."
},
{
"name": "project",
"value": "",
"type": "query",
"description": "Project ID"
}
]
},
"docs": "Get list of all Azure import storage connections."
},
{
"info": {
"name": "Create new storage",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://localhost:8000/api/storages/azure/",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create new Azure import storage"
},
{
"info": {
"name": "Validate import storage",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://localhost:8000/api/storages/azure/validate",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Validate a specific Azure import storage connection."
},
{
"info": {
"name": "Get import storage",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/storages/azure/:id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
]
},
"docs": "Get a specific Azure import storage connection."
},
{
"info": {
"name": "Update import storage",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "http://localhost:8000/api/storages/azure/:id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update a specific Azure import storage connection."
},
{
"info": {
"name": "Delete import storage",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "http://localhost:8000/api/storages/azure/:id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
]
},
"docs": "Delete a specific Azure import storage connection."
},
{
"info": {
"name": "Sync import storage",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://localhost:8000/api/storages/azure/:id/sync",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Storage ID"
}
]
},
"docs": "Sync tasks from an Azure import storage connection."
}
]
},
{
"info": {
"name": "subpackage_importStorage.subpackage_importStorage/azureSpi",
"type": "folder"
},
"items": [
{
"info": {
"name": "✨ Get Azure SPI import storage",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/storages/azure_spi/",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "ordering",
"value": "",
"type": "query",
"description": "Which field to use when ordering the results."
},
{
"name": "project",
"value": "",
"type": "query",
"description": "Project ID"
}
]
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nGet list of all Azure import storage con"
},
{
"info": {
"name": "✨ Create Azure import storage with SPI",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://localhost:8000/api/storages/azure_spi/",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nCreate Azure import storage with Service"
},
{
"info": {
"name": "✨ Validate Azure SPI import storage",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://localhost:8000/api/storages/azure_spi/validate",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nValidate a specific Azure import storage"
},
{
"info": {
"name": "✨ Get Azure SPI import storage",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/storages/azure_spi/:id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
]
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nGet a specific Azure import storage conn"
},
{
"info": {
"name": "✨ Update Azure SPI import storage",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "http://localhost:8000/api/storages/azure_spi/:id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nUpdate a specific Azure import storage c"
},
{
"info": {
"name": "✨ Delete Azure SPI import storage",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "http://localhost:8000/api/storages/azure_spi/:id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
]
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nDelete a specific Azure import storage c"
},
{
"info": {
"name": "✨ Sync Azure SPI import storage",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://localhost:8000/api/storages/azure_spi/:id/sync",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
]
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nSync tasks from an Azure import storage "
}
]
},
{
"info": {
"name": "subpackage_importStorage.subpackage_importStorage/databricks",
"type": "folder"
},
"items": [
{
"info": {
"name": "✨ List Databricks import storages",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/storages/databricks/",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "ordering",
"value": "",
"type": "query",
"description": "Which field to use when ordering the results."
},
{
"name": "project",
"value": "",
"type": "query",
"description": "Project ID"
}
]
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nGet list of all Databricks Files import "
},
{
"info": {
"name": "✨ Create Databricks import storage",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://localhost:8000/api/storages/databricks/",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nCreate a Databricks Files import storage"
},
{
"info": {
"name": "✨ Validate Databricks import storage",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://localhost:8000/api/storages/databricks/validate",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nValidate a specific Databricks Files imp"
},
{
"info": {
"name": "✨ Get Databricks import storage",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/storages/databricks/:id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
]
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nGet a specific Databricks Files import s"
},
{
"info": {
"name": "✨ Update Databricks import storage",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "http://localhost:8000/api/storages/databricks/:id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nUpdate a specific Databricks Files impor"
},
{
"info": {
"name": "✨ Delete Databricks import storage",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "http://localhost:8000/api/storages/databricks/:id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
]
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nDelete a specific Databricks Files impor"
},
{
"info": {
"name": "✨ Sync Databricks import storage",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://localhost:8000/api/storages/databricks/:id/sync",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
]
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nSync tasks from a Databricks Files impor"
}
]
},
{
"info": {
"name": "subpackage_importStorage.subpackage_importStorage/gcs",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get all import storage",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/storages/gcs/",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "ordering",
"value": "",
"type": "query",
"description": "Which field to use when ordering the results."
},
{
"name": "project",
"value": "",
"type": "query",
"description": "Project ID"
}
]
},
"docs": "Get a list of all GCS import storage connections."
},
{
"info": {
"name": "Create import storage",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://localhost:8000/api/storages/gcs/",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create a new GCS import storage connection."
},
{
"info": {
"name": "Validate import storage",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://localhost:8000/api/storages/gcs/validate",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Validate a specific GCS import storage connection."
},
{
"info": {
"name": "Get import storage",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/storages/gcs/:id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
]
},
"docs": "Get a specific GCS import storage connection."
},
{
"info": {
"name": "Update import storage",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "http://localhost:8000/api/storages/gcs/:id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update a specific GCS import storage connection."
},
{
"info": {
"name": "Delete import storage",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "http://localhost:8000/api/storages/gcs/:id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
]
},
"docs": "Delete a specific GCS import storage connection."
},
{
"info": {
"name": "Sync import storage",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://localhost:8000/api/storages/gcs/:id/sync",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Storage ID"
}
]
},
"docs": "Sync tasks from a GCS import storage connection."
}
]
},
{
"info": {
"name": "subpackage_importStorage.subpackage_importStorage/gcsSa",
"type": "folder"
},
"items": [
{
"info": {
"name": "✨ Get all GCS SA import storages",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/storages/gcs_sa/",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "ordering",
"value": "",
"type": "query",
"description": "Which field to use when ordering the results."
},
{
"name": "project",
"value": "",
"type": "query",
"description": "Project ID"
}
]
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nGet list of all GCS import storage conne"
},
{
"info": {
"name": "✨ Create GCS import storage with SA Impersonation",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://localhost:8000/api/storages/gcs_sa/",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nCreate GCS import storage with Service A"
},
{
"info": {
"name": "✨ Validate GCS SA import storage",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://localhost:8000/api/storages/gcs_sa/validate",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nValidate a specific GCS import storage c"
},
{
"info": {
"name": "✨ Get GCS SA import storage",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/storages/gcs_sa/:id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
]
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nGet a specific GCS import storage connec"
},
{
"info": {
"name": "✨ Update GCS SA import storage",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "http://localhost:8000/api/storages/gcs_sa/:id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nUpdate a specific GCS import storage con"
},
{
"info": {
"name": "✨ Delete GCS SA import storage",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "http://localhost:8000/api/storages/gcs_sa/:id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
]
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nDelete a specific GCS import storage con"
},
{
"info": {
"name": "✨ Sync GCS SA import storage",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://localhost:8000/api/storages/gcs_sa/:id/sync",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
]
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nSync tasks from a GCS import storage con"
}
]
},
{
"info": {
"name": "subpackage_importStorage.subpackage_importStorage/gcswif",
"type": "folder"
},
"items": [
{
"info": {
"name": "✨ Get GCS WIF import storage",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/storages/gcswif/",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "ordering",
"value": "",
"type": "query",
"description": "Which field to use when ordering the results."
},
{
"name": "project",
"value": "",
"type": "query",
"description": "Project ID"
}
]
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nGet list of all GCS import storage conne"
},
{
"info": {
"name": "✨ Create GCS import storage with WIF",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://localhost:8000/api/storages/gcswif/",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nCreate GCS import storage with WIF."
},
{
"info": {
"name": "✨ Validate GCS WIF import storage",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://localhost:8000/api/storages/gcswif/validate",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nValidate a specific GCS import storage c"
},
{
"info": {
"name": "✨ Get GCS WIF import storage",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/storages/gcswif/:id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
]
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nGet a specific GCS import storage connec"
},
{
"info": {
"name": "✨ Update GCS WIF import storage",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "http://localhost:8000/api/storages/gcswif/:id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nUpdate a specific GCS import storage con"
},
{
"info": {
"name": "✨ Delete GCS WIF import storage",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "http://localhost:8000/api/storages/gcswif/:id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
]
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nDelete a specific GCS import storage con"
},
{
"info": {
"name": "✨ Sync GCS WIF import storage",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://localhost:8000/api/storages/gcswif/:id/sync",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
]
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nSync tasks from an GCS import storage co"
}
]
},
{
"info": {
"name": "subpackage_importStorage.subpackage_importStorage/local",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get all import storage",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/storages/localfiles/",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "ordering",
"value": "",
"type": "query",
"description": "Which field to use when ordering the results."
},
{
"name": "project",
"value": "",
"type": "query",
"description": "Project ID"
}
]
},
"docs": "Get a list of all local file import storage connections."
},
{
"info": {
"name": "Create import storage",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://localhost:8000/api/storages/localfiles/",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create a new local file import storage connection."
},
{
"info": {
"name": "Validate import storage",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://localhost:8000/api/storages/localfiles/validate",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Validate a specific local file import storage connection."
},
{
"info": {
"name": "Get import storage",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/storages/localfiles/:id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
]
},
"docs": "Get a specific local file import storage connection."
},
{
"info": {
"name": "Update import storage",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "http://localhost:8000/api/storages/localfiles/:id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update a specific local file import storage connection."
},
{
"info": {
"name": "Delete import storage",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "http://localhost:8000/api/storages/localfiles/:id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
]
},
"docs": "Delete a specific local file import storage connection."
},
{
"info": {
"name": "Sync import storage",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://localhost:8000/api/storages/localfiles/:id/sync",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Storage ID"
}
]
},
"docs": "Sync tasks from a local file import storage connection."
}
]
},
{
"info": {
"name": "subpackage_importStorage.subpackage_importStorage/redis",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get all import storage",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/storages/redis/",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "ordering",
"value": "",
"type": "query",
"description": "Which field to use when ordering the results."
},
{
"name": "project",
"value": "",
"type": "query",
"description": "Project ID"
}
]
},
"docs": "Get a list of all Redis import storage connections."
},
{
"info": {
"name": "Create import storage",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://localhost:8000/api/storages/redis/",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create a new Redis import storage connection."
},
{
"info": {
"name": "Validate import storage",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://localhost:8000/api/storages/redis/validate",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Validate a specific Redis import storage connection."
},
{
"info": {
"name": "Get import storage",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/storages/redis/:id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
]
},
"docs": "Get a specific Redis import storage connection."
},
{
"info": {
"name": "Update import storage",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "http://localhost:8000/api/storages/redis/:id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update a specific Redis import storage connection."
},
{
"info": {
"name": "Delete import storage",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "http://localhost:8000/api/storages/redis/:id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
]
},
"docs": "Delete a specific Redis import storage connection."
},
{
"info": {
"name": "Sync import storage",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://localhost:8000/api/storages/redis/:id/sync",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Storage ID"
}
]
},
"docs": "Sync tasks from a Redis import storage connection."
}
]
},
{
"info": {
"name": "subpackage_importStorage.subpackage_importStorage/s3",
"type": "folder"
},
"items": [
{
"info": {
"name": "List S3 import storage",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/storages/s3/",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "ordering",
"value": "",
"type": "query",
"description": "Which field to use when ordering the results."
},
{
"name": "project",
"value": "",
"type": "query",
"description": "Project ID"
}
]
},
"docs": "Get a list of all S3 import storage connections."
},
{
"info": {
"name": "Create new S3 storage",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://localhost:8000/api/storages/s3/",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create new S3 import storage"
},
{
"info": {
"name": "Validate import storage",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://localhost:8000/api/storages/s3/validate",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Validate a specific S3 import storage connection."
},
{
"info": {
"name": "Get import storage",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/storages/s3/:id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
]
},
"docs": "Get a specific S3 import storage connection."
},
{
"info": {
"name": "Update import storage",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "http://localhost:8000/api/storages/s3/:id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update a specific S3 import storage connection."
},
{
"info": {
"name": "Delete import storage",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "http://localhost:8000/api/storages/s3/:id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
]
},
"docs": "Delete a specific S3 import storage connection."
},
{
"info": {
"name": "Sync import storage",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://localhost:8000/api/storages/s3/:id/sync",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Storage ID"
}
]
},
"docs": "Sync tasks from an S3 import storage connection."
}
]
},
{
"info": {
"name": "subpackage_importStorage.subpackage_importStorage/s3S",
"type": "folder"
},
"items": [
{
"info": {
"name": "✨ List S3s import storage",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/storages/s3s/",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "ordering",
"value": "",
"type": "query",
"description": "Which field to use when ordering the results."
},
{
"name": "project",
"value": "",
"type": "query",
"description": "Project ID"
}
]
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nGet list of all S3 import storage connec"
},
{
"info": {
"name": "✨ Create import storage",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://localhost:8000/api/storages/s3s/",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nCreate S3 import storage with IAM role a"
},
{
"info": {
"name": "✨ Validate import storage",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://localhost:8000/api/storages/s3s/validate",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nValidate a specific S3 import storage co"
},
{
"info": {
"name": "✨ Get import storage",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/storages/s3s/:id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
]
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nGet a specific S3 import storage connect"
},
{
"info": {
"name": "✨ Update import storage",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "http://localhost:8000/api/storages/s3s/:id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nUpdate a specific S3 import storage conn"
},
{
"info": {
"name": "✨ Delete import storage",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "http://localhost:8000/api/storages/s3s/:id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
]
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nDelete a specific S3 import storage conn"
},
{
"info": {
"name": "✨ Sync import storage",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://localhost:8000/api/storages/s3s/:id/sync",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
]
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nSync tasks from an S3 import storage con"
}
]
},
{
"info": {
"name": "subpackage_exportStorage",
"type": "folder"
},
"items": [
{
"info": {
"name": "List all export storages types",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/storages/export/types",
"headers": [
{
"name": "Authorization",
"value": ""
}
]
},
"docs": "Retrieve a list of the export storages types."
}
]
},
{
"info": {
"name": "subpackage_exportStorage.subpackage_exportStorage/azure",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get all export storage",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/storages/export/azure",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "ordering",
"value": "",
"type": "query",
"description": "Which field to use when ordering the results."
},
{
"name": "project",
"value": "",
"type": "query",
"description": "Project ID"
}
]
},
"docs": "Get a list of all Azure export storage connections."
},
{
"info": {
"name": "Create export storage",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://localhost:8000/api/storages/export/azure",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create a new Azure export storage connection to store annotations."
},
{
"info": {
"name": "Validate export storage",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://localhost:8000/api/storages/export/azure/validate",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Validate a specific Azure export storage connection."
},
{
"info": {
"name": "Get export storage",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/storages/export/azure/:id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
]
},
"docs": "Get a specific Azure export storage connection."
},
{
"info": {
"name": "Update export storage",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "http://localhost:8000/api/storages/export/azure/:id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update a specific Azure export storage connection."
},
{
"info": {
"name": "Delete export storage",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "http://localhost:8000/api/storages/export/azure/:id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
]
},
"docs": "Delete a specific Azure export storage connection."
},
{
"info": {
"name": "Sync export storage",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://localhost:8000/api/storages/export/azure/:id/sync",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
]
},
"docs": "Sync tasks from an Azure export storage connection."
}
]
},
{
"info": {
"name": "subpackage_exportStorage.subpackage_exportStorage/azureSpi",
"type": "folder"
},
"items": [
{
"info": {
"name": "✨ Get all Azure SPI export storage",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/storages/export/azure_spi",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "ordering",
"value": "",
"type": "query",
"description": "Which field to use when ordering the results."
},
{
"name": "project",
"value": "",
"type": "query",
"description": "Project ID"
}
]
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nGet a list of all Azure export storage c"
},
{
"info": {
"name": "✨ Create Azure export storage with SPI authentication",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://localhost:8000/api/storages/export/azure_spi",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nCreate an Azure export storage connectio"
},
{
"info": {
"name": "✨ Validate Azure SPI export storage",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://localhost:8000/api/storages/export/azure_spi/validate",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nValidate a specific Azure export storage"
},
{
"info": {
"name": "✨ Get Azure SPI export storage",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/storages/export/azure_spi/:id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
]
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nGet a specific Azure export storage conn"
},
{
"info": {
"name": "✨ Update Azure SPI export storage",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "http://localhost:8000/api/storages/export/azure_spi/:id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nUpdate a specific Azure export storage c"
},
{
"info": {
"name": "✨ Delete Azure SPI export storage",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "http://localhost:8000/api/storages/export/azure_spi/:id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
]
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nDelete a specific Azure export storage c"
},
{
"info": {
"name": "✨ Sync Azure SPI export storage",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://localhost:8000/api/storages/export/azure_spi/:id/sync",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
]
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nSync tasks from an Azure SPI export stor"
}
]
},
{
"info": {
"name": "subpackage_exportStorage.subpackage_exportStorage/databricks",
"type": "folder"
},
"items": [
{
"info": {
"name": "✨ List Databricks export storages",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/storages/export/databricks",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "ordering",
"value": "",
"type": "query",
"description": "Which field to use when ordering the results."
},
{
"name": "project",
"value": "",
"type": "query",
"description": "Project ID"
}
]
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nGet a list of all Databricks Files expor"
},
{
"info": {
"name": "✨ Create Databricks export storage",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://localhost:8000/api/storages/export/databricks",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nCreate a Databricks Files export storage"
},
{
"info": {
"name": "✨ Validate Databricks export storage",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://localhost:8000/api/storages/export/databricks/validate",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nValidate a specific Databricks Files exp"
},
{
"info": {
"name": "✨ Get Databricks export storage",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/storages/export/databricks/:id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
]
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nGet a specific Databricks Files export s"
},
{
"info": {
"name": "✨ Update Databricks export storage",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "http://localhost:8000/api/storages/export/databricks/:id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nUpdate a specific Databricks Files expor"
},
{
"info": {
"name": "✨ Delete Databricks export storage",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "http://localhost:8000/api/storages/export/databricks/:id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
]
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nDelete a specific Databricks Files expor"
},
{
"info": {
"name": "✨ Sync Databricks export storage",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://localhost:8000/api/storages/export/databricks/:id/sync",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
]
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nExport annotations to a Databricks Files"
}
]
},
{
"info": {
"name": "subpackage_exportStorage.subpackage_exportStorage/gcs",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get all export storage",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/storages/export/gcs",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "ordering",
"value": "",
"type": "query",
"description": "Which field to use when ordering the results."
},
{
"name": "project",
"value": "",
"type": "query",
"description": "Project ID"
}
]
},
"docs": "Get a list of all GCS export storage connections."
},
{
"info": {
"name": "Create export storage",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://localhost:8000/api/storages/export/gcs",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create a new GCS export storage connection to store annotations."
},
{
"info": {
"name": "Validate export storage",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://localhost:8000/api/storages/export/gcs/validate",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Validate a specific GCS export storage connection."
},
{
"info": {
"name": "Get export storage",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/storages/export/gcs/:id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
]
},
"docs": "Get a specific GCS export storage connection."
},
{
"info": {
"name": "Update export storage",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "http://localhost:8000/api/storages/export/gcs/:id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update a specific GCS export storage connection."
},
{
"info": {
"name": "Delete export storage",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "http://localhost:8000/api/storages/export/gcs/:id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
]
},
"docs": "Delete a specific GCS export storage connection."
},
{
"info": {
"name": "Sync export storage",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://localhost:8000/api/storages/export/gcs/:id/sync",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
]
},
"docs": "Sync tasks from an GCS export storage connection."
}
]
},
{
"info": {
"name": "subpackage_exportStorage.subpackage_exportStorage/gcsSa",
"type": "folder"
},
"items": [
{
"info": {
"name": "✨ Get all GCS SA export storages",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/storages/export/gcs_sa",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "ordering",
"value": "",
"type": "query",
"description": "Which field to use when ordering the results."
},
{
"name": "project",
"value": "",
"type": "query",
"description": "Project ID"
}
]
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nGet a list of all GCS export storage con"
},
{
"info": {
"name": "✨ Create GCS export storage with SA Impersonation",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://localhost:8000/api/storages/export/gcs_sa",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nCreate a GCS export storage connection w"
},
{
"info": {
"name": "✨ Validate GCS SA export storage",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://localhost:8000/api/storages/export/gcs_sa/validate",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nValidate a specific GCS export storage c"
},
{
"info": {
"name": "✨ Get GCS SA export storage",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/storages/export/gcs_sa/:id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
]
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nGet a specific GCS export storage connec"
},
{
"info": {
"name": "✨ Update GCS SA export storage",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "http://localhost:8000/api/storages/export/gcs_sa/:id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nUpdate a specific GCS export storage con"
},
{
"info": {
"name": "✨ Delete GCS SA export storage",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "http://localhost:8000/api/storages/export/gcs_sa/:id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
]
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nDelete a specific GCS export storage con"
},
{
"info": {
"name": "✨ Sync GCS SA export storage",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://localhost:8000/api/storages/export/gcs_sa/:id/sync",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
]
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nSync annotations to a GCS SA export stor"
}
]
},
{
"info": {
"name": "subpackage_exportStorage.subpackage_exportStorage/gcswif",
"type": "folder"
},
"items": [
{
"info": {
"name": "✨ Get all GCS WIF export storage",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/storages/export/gcswif",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "ordering",
"value": "",
"type": "query",
"description": "Which field to use when ordering the results."
},
{
"name": "project",
"value": "",
"type": "query",
"description": "Project ID"
}
]
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nGet a list of all GCS export storage con"
},
{
"info": {
"name": "✨ Create GCS export storage with WIF authentication",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://localhost:8000/api/storages/export/gcswif",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nCreate an GCS export storage connection "
},
{
"info": {
"name": "✨ Validate GCS WIF export storage",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://localhost:8000/api/storages/export/gcswif/validate",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nValidate a specific GCS export storage c"
},
{
"info": {
"name": "✨ Get GCS WIF export storage",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/storages/export/gcswif/:id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
]
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nGet a specific GCS export storage connec"
},
{
"info": {
"name": "✨ Update GCS WIF export storage",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "http://localhost:8000/api/storages/export/gcswif/:id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nUpdate a specific GCS export storage con"
},
{
"info": {
"name": "✨ Delete GCS WIF export storage",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "http://localhost:8000/api/storages/export/gcswif/:id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
]
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nDelete a specific GCS export storage con"
},
{
"info": {
"name": "✨ Sync GCS WIF export storage",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://localhost:8000/api/storages/export/gcswif/:id/sync",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
]
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nSync tasks from an GCS WIF export storag"
}
]
},
{
"info": {
"name": "subpackage_exportStorage.subpackage_exportStorage/local",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get all export storage",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/storages/export/localfiles",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "ordering",
"value": "",
"type": "query",
"description": "Which field to use when ordering the results."
},
{
"name": "project",
"value": "",
"type": "query",
"description": "Project ID"
}
]
},
"docs": "Get a list of all local file export storage connections."
},
{
"info": {
"name": "Create export storage",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://localhost:8000/api/storages/export/localfiles",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create a new local file export storage connection to store annotations."
},
{
"info": {
"name": "Validate export storage",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://localhost:8000/api/storages/export/localfiles/validate",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Validate a specific local file export storage connection."
},
{
"info": {
"name": "Get export storage",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/storages/export/localfiles/:id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
]
},
"docs": "Get a specific local file export storage connection."
},
{
"info": {
"name": "Update export storage",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "http://localhost:8000/api/storages/export/localfiles/:id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update a specific local file export storage connection."
},
{
"info": {
"name": "Delete export storage",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "http://localhost:8000/api/storages/export/localfiles/:id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
]
},
"docs": "Delete a specific local file export storage connection."
},
{
"info": {
"name": "Sync export storage",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://localhost:8000/api/storages/export/localfiles/:id/sync",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
]
},
"docs": "Sync tasks from a local file export storage connection."
}
]
},
{
"info": {
"name": "subpackage_exportStorage.subpackage_exportStorage/redis",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get all export storage",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/storages/export/redis",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "ordering",
"value": "",
"type": "query",
"description": "Which field to use when ordering the results."
},
{
"name": "project",
"value": "",
"type": "query",
"description": "Project ID"
}
]
},
"docs": "Get a list of all Redis export storage connections."
},
{
"info": {
"name": "Create export storage",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://localhost:8000/api/storages/export/redis",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create a new Redis export storage connection to store annotations."
},
{
"info": {
"name": "Validate export storage",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://localhost:8000/api/storages/export/redis/validate",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Validate a specific Redis export storage connection."
},
{
"info": {
"name": "Get export storage",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/storages/export/redis/:id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
]
},
"docs": "Get a specific Redis export storage connection."
},
{
"info": {
"name": "Update export storage",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "http://localhost:8000/api/storages/export/redis/:id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update a specific Redis export storage connection."
},
{
"info": {
"name": "Delete export storage",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "http://localhost:8000/api/storages/export/redis/:id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
]
},
"docs": "Delete a specific Redis export storage connection."
},
{
"info": {
"name": "Sync export storage",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://localhost:8000/api/storages/export/redis/:id/sync",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
]
},
"docs": "Sync tasks from a Redis export storage connection."
}
]
},
{
"info": {
"name": "subpackage_exportStorage.subpackage_exportStorage/s3",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get all export storage",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/storages/export/s3",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "ordering",
"value": "",
"type": "query",
"description": "Which field to use when ordering the results."
},
{
"name": "project",
"value": "",
"type": "query",
"description": "Project ID"
}
]
},
"docs": "Get a list of all S3 export storage connections."
},
{
"info": {
"name": "Create export storage",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://localhost:8000/api/storages/export/s3",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create a new S3 export storage connection to store annotations."
},
{
"info": {
"name": "Validate export storage",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://localhost:8000/api/storages/export/s3/validate",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Validate a specific S3 export storage connection."
},
{
"info": {
"name": "Get export storage",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/storages/export/s3/:id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
]
},
"docs": "Get a specific S3 export storage connection."
},
{
"info": {
"name": "Update export storage",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "http://localhost:8000/api/storages/export/s3/:id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update a specific S3 export storage connection."
},
{
"info": {
"name": "Delete export storage",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "http://localhost:8000/api/storages/export/s3/:id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
]
},
"docs": "Delete a specific S3 export storage connection."
},
{
"info": {
"name": "Sync export storage",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://localhost:8000/api/storages/export/s3/:id/sync",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
]
},
"docs": "Sync tasks from an S3 export storage connection."
}
]
},
{
"info": {
"name": "subpackage_exportStorage.subpackage_exportStorage/s3S",
"type": "folder"
},
"items": [
{
"info": {
"name": "✨ List S3s export storage",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/storages/export/s3s",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "ordering",
"value": "",
"type": "query",
"description": "Which field to use when ordering the results."
},
{
"name": "project",
"value": "",
"type": "query",
"description": "Project ID"
}
]
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nGet a list of all S3 export storage conn"
},
{
"info": {
"name": "✨ Create export storage",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://localhost:8000/api/storages/export/s3s",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nCreate an S3 export storage connection w"
},
{
"info": {
"name": "✨ Validate export storage",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://localhost:8000/api/storages/export/s3s/validate",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nValidate a specific S3 export storage co"
},
{
"info": {
"name": "✨ Get export storage",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/storages/export/s3s/:id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
]
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nGet a specific S3 export storage connect"
},
{
"info": {
"name": "✨ Update export storage",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "http://localhost:8000/api/storages/export/s3s/:id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nUpdate a specific S3 export storage conn"
},
{
"info": {
"name": "✨ Delete export storage",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "http://localhost:8000/api/storages/export/s3s/:id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
]
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nDelete a specific S3 export storage conn"
},
{
"info": {
"name": "✨ Sync export storage",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://localhost:8000/api/storages/export/s3s/:id/sync",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
]
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nSync tasks from an S3 export storage."
}
]
},
{
"info": {
"name": "subpackage_tokens",
"type": "folder"
},
"items": [
{
"info": {
"name": "List API tokens",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/token/",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "ordering",
"value": "",
"type": "query",
"description": "Which field to use when ordering the results."
}
]
},
"docs": "List all API tokens for the current user."
},
{
"info": {
"name": "Create API token",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://localhost:8000/api/token/",
"headers": [
{
"name": "Authorization",
"value": ""
}
]
},
"docs": "Create a new API token for the current user."
},
{
"info": {
"name": "Blacklist a JWT refresh token",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://localhost:8000/api/token/blacklist/",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Adds a JWT refresh token to the blacklist, preventing it from being used to obtain new access tokens."
},
{
"info": {
"name": "Refresh JWT token",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://localhost:8000/api/token/refresh/",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Get a new access token, using a refresh token."
},
{
"info": {
"name": "Rotate JWT refresh token",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://localhost:8000/api/token/rotate/",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Creates a new JWT refresh token and blacklists the current one."
}
]
},
{
"info": {
"name": "subpackage_versions",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get version information",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/version/",
"headers": [
{
"name": "Authorization",
"value": ""
}
]
},
"docs": "Get version information about the Label Studio instance."
}
]
},
{
"info": {
"name": "subpackage_webhooks",
"type": "folder"
},
"items": [
{
"info": {
"name": "List all webhooks",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/webhooks/",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "project",
"value": "",
"type": "query",
"description": "Project ID"
}
]
},
"docs": "List all webhooks set up for your organization."
},
{
"info": {
"name": "Create a webhook",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://localhost:8000/api/webhooks/",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create a webhook for your organization."
},
{
"info": {
"name": "Get all webhook actions",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/webhooks/info/",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "organization-only",
"value": "",
"type": "query",
"description": "organization-only or not"
}
]
},
"docs": "Get descriptions of all available webhook actions to set up webhooks."
},
{
"info": {
"name": "Get webhook info",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/webhooks/:id/",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
]
},
"docs": "Get webhook info"
},
{
"info": {
"name": "Update webhook info",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "http://localhost:8000/api/webhooks/:id/",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update webhook info"
},
{
"info": {
"name": "Delete webhook info",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "http://localhost:8000/api/webhooks/:id/",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
]
},
"docs": "Delete webhook info"
}
]
},
{
"info": {
"name": "subpackage_workspaces",
"type": "folder"
},
"items": [
{
"info": {
"name": "✨ List workspaces",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/workspaces/",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "include_all_workspaces",
"value": "",
"type": "query",
"description": "Include all workspaces in the organization, including other users' personal workspaces. Only effective for users with Administrator or Owner role. When enabled, the response includes created_by_user info for personal workspaces."
},
{
"name": "is_archived",
"value": "",
"type": "query",
"description": "Filter by archived status. Set to false to exclude archived workspaces."
},
{
"name": "is_personal",
"value": "",
"type": "query",
"description": "Workspace is a personal user workspace."
},
{
"name": "ordering",
"value": "",
"type": "query",
"description": "Which field to use when ordering the results."
}
]
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nList all workspaces for your organizatio"
},
{
"info": {
"name": "✨ Create workspace",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://localhost:8000/api/workspaces/",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nCreate a new workspace. Workspaces in La"
},
{
"info": {
"name": "✨ Get workspace",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/workspaces/:id/",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
]
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nRetrieve details for a specific workspac"
},
{
"info": {
"name": "✨ Update workspace",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "http://localhost:8000/api/workspaces/:id/",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nUpdate settings for a specific workspace"
},
{
"info": {
"name": "✨ Delete workspace",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "http://localhost:8000/api/workspaces/:id/",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
]
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nDelete a specific workspace by ID."
}
]
},
{
"info": {
"name": "subpackage_workspaces.subpackage_workspaces/members",
"type": "folder"
},
"items": [
{
"info": {
"name": "✨ List workspace memberships",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/workspaces/:id/memberships/",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
]
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nGet a list of all members in a specific "
},
{
"info": {
"name": "✨ Create workspace membership",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://localhost:8000/api/workspaces/:id/memberships/",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nAdd a new workspace member by user ID."
},
{
"info": {
"name": "✨ Delete workspace membership",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "http://localhost:8000/api/workspaces/:id/memberships/",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
},
{
"name": "user_id",
"value": "",
"type": "query",
"description": "User ID to remove from the workspace."
}
]
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nRemove a specific member by ID from a wo"
}
]
},
{
"info": {
"name": "subpackage_workspaces.subpackage_workspaces/members.subpackage_workspaces/members/bulk",
"type": "folder"
},
"items": [
{
"info": {
"name": "✨ Bulk assign workspace members",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://localhost:8000/api/workspaces/:id/memberships/bulk/",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nAssign workspace members in bulk."
},
{
"info": {
"name": "✨ Bulk unassign workspace members",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "http://localhost:8000/api/workspaces/:id/memberships/bulk/",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
},
{
"name": "all",
"value": "",
"type": "query",
"description": "Apply unassignment to all currently matched workspace members."
},
{
"name": "excluded",
"value": "",
"type": "query",
"description": "Comma-separated list of user IDs to keep assigned when `all=true`."
},
{
"name": "ids",
"value": "",
"type": "query",
"description": "Comma-separated list of user IDs to filter matched members."
},
{
"name": "included",
"value": "",
"type": "query",
"description": "Comma-separated list of user IDs to unassign when `all=false`."
},
{
"name": "search",
"value": "",
"type": "query",
"description": "Search term for filtering matched members by name or email."
}
]
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nUnassign workspace members in bulk. Pass"
}
]
},
{
"info": {
"name": "subpackage_workspaces.subpackage_workspaces/members.subpackage_workspaces/members/paginated",
"type": "folder"
},
"items": [
{
"info": {
"name": "✨ Get workspace members paginated",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/workspaces/:id/memberships/paginated/",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
},
{
"name": "ids",
"value": "",
"type": "query",
"description": "Comma-separated list of user IDs to filter by"
},
{
"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": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nRetrieve the members for a specific work"
}
]
},
{
"info": {
"name": "subpackage_workspaces.subpackage_workspaces/projects",
"type": "folder"
},
"items": [
{
"info": {
"name": "✨ List workspace projects",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://localhost:8000/api/workspaces/:id/projects/",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
]
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nRetrieve a list of all projects in a spe"
},
{
"info": {
"name": "✨ Add workspace project",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://localhost:8000/api/workspaces/:id/projects/",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nAdd a project to a specific workspace."
},
{
"info": {
"name": "✨ Remove workspace project",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "http://localhost:8000/api/workspaces/:id/projects/",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
},
{
"name": "project",
"value": "",
"type": "query",
"description": "Project ID to remove from the workspace."
}
]
},
"docs": "\n \n \n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n
\n \nRemove a project from a specific workspa"
}
]
}
],
"bundled": true
}