✨ List projects compatible with prompt

GET

http://localhost:8000/api/prompts/compatible-projects

GET

/api/prompts/compatible-projects

$ curl http://localhost:8000/api/prompts/compatible-projects \
>      -H "Authorization: Token  <api_key>"

200Retrieved

1 {
2   "count": 123,
3   "results": [
4     {
5       "allow_stream": true,
6       "assignment_settings": {
7         "id": 1,
8         "label_stream_task_distribution": "auto_distribution",
9         "project": 1
10       },
11       "blueprints": [
12         {
13           "created_at": "2024-01-15T09:30:00Z",
14           "id": 1,
15           "share_id": "string",
16           "short_url": "string",
17           "task_count": 1,
18           "description": "string",
19           "title": "string"
20         }
21       ],
22       "config_has_control_tags": true,
23       "config_suitable_for_bulk_annotation": true,
24       "created_at": "2024-01-15T09:30:00Z",
25       "data_types": {},
26       "description_short": "string",
27       "finished_task_number": 1,
28       "ground_truth_number": 1,
29       "id": 1,
30       "internal_description": [
31         null
32       ],
33       "internal_description_short": "string",
34       "is_dimensions_enabled": true,
35       "members": [
36         {}
37       ],
38       "members_count": 1,
39       "num_tasks_with_annotations": 1,
40       "parsed_label_config": {},
41       "prompts": [
42         {}
43       ],
44       "queue_done": 1,
45       "queue_left": 1,
46       "queue_total": 1,
47       "ready": true,
48       "rejected": 1,
49       "review_settings": {
50         "id": 1,
51         "requeue_rejected_tasks_to_annotator": true,
52         "anonymize_annotations": true,
53         "instruction": "string",
54         "only_finished_tasks": true,
55         "project": 1,
56         "requeue_rejected_tasks_mode": "requeue",
57         "require_comment_on_reject": true,
58         "review_criteria": "all",
59         "review_only_manual_assignments": true,
60         "review_task_limit_percent": "string",
61         "sampling": "task_id",
62         "show_agreement_to_reviewers": true,
63         "show_data_manager_to_reviewers": true,
64         "show_instruction": true,
65         "show_unused_data_columns_to_reviewers": true
66       },
67       "review_total_tasks": 1,
68       "reviewed_number": 1,
69       "reviewer_queue_total": 1,
70       "skipped_annotations_number": 1,
71       "start_training_on_annotation_update": true,
72       "state": "string",
73       "task_number": 1,
74       "total_annotations_number": 1,
75       "total_predictions_number": 1,
76       "useful_annotation_number": 1,
77       "workspace": 1,
78       "workspace_title": "string",
79       "agreement_methodology": "consensus",
80       "agreement_threshold": "string",
81       "annotation_limit_count": 1,
82       "annotation_limit_percent": "string",
83       "annotator_evaluation_continuous_tasks": 0,
84       "annotator_evaluation_enabled": true,
85       "annotator_evaluation_minimum_score": "95.00",
86       "annotator_evaluation_minimum_tasks": 10,
87       "annotator_evaluation_onboarding_tasks": 0,
88       "color": "string",
89       "comment_classification_config": "string",
90       "control_weights": {},
91       "created_by": {
92         "avatar": "string",
93         "id": 1,
94         "username": "string",
95         "email": "string",
96         "first_name": "string",
97         "last_name": "string"
98       },
99       "custom_interface_code": "string",
100       "custom_interface_compiled": "string",
101       "custom_interface_params": null,
102       "custom_script": "string",
103       "custom_task_lock_ttl": 1,
104       "description": "string",
105       "duplication_done": false,
106       "duplication_status": "string",
107       "enable_empty_annotation": true,
108       "evaluate_predictions_automatically": true,
109       "expert_instruction": "string",
110       "input_schema": null,
111       "is_draft": true,
112       "is_published": true,
113       "label_config": "string",
114       "max_additional_annotators_assignable": 1,
115       "maximum_annotations": 1,
116       "min_annotations_to_start_training": 1,
117       "model_version": "string",
118       "organization": 1,
119       "output_schema": null,
120       "overlap_cohort_percentage": 1,
121       "pause_on_failed_annotator_evaluation": false,
122       "pinned_at": "2024-01-15T09:30:00Z",
123       "require_comment_on_skip": false,
124       "reveal_preannotations_interactively": true,
125       "sampling": "Sequential sampling",
126       "show_annotation_history": true,
127       "show_collab_predictions": true,
128       "show_instruction": true,
129       "show_overlap_first": true,
130       "show_skip_button": true,
131       "show_unused_data_columns_to_annotators": true,
132       "skip_queue": "REQUEUE_FOR_ME",
133       "source_interface_id": 1,
134       "source_interface_version": 1,
135       "strict_task_overlap": true,
136       "title": "string",
137       "use_custom_interface": false,
138       "show_ground_truth_first": true
139     }
140   ],
141   "next": "http://api.example.org/accounts/?page=4",
142   "previous": "http://api.example.org/accounts/?page=2"
143 }

Retrieve a list of compatible project for prompt.

Authentication

AuthorizationToken

The token (or API key) must be passed as a request header. You can find your user token on the User Account page in Label Studio. Example:

curl https://label-studio-host/api/projects -H “Authorization: Token [your-token]”

The token (or API key) must be passed as a request header. You can find your user token on the User Account page in Label Studio. Example: <br><pre><code class="language-bash">curl https://label-studio-host/api/projects -H "Authorization: Token [your-token]"</code></pre>

Query parameters

archivedbooleanOptional

Filter by projects that belong to archived workspaces

idslist of integersOptional

Multiple values may be separated by commas.

orderingstringOptional

Which field to use when ordering the results.

pageintegerOptional

A page number within the paginated result set.

page_sizeintegerOptional

Number of results to return per page.

project_typeenumOptionalDefaults to TextClassification

Skill to filter by

Allowed values:

source_interface_iddoubleOptional

statestringOptional

titlestringOptional

workspacesintegerOptional

Response

countinteger

resultslist of objects

nextstring or nullformat: "uri"

previousstring or nullformat: "uri"