✨ Run prompt inference | API Reference

This endpoint is not available in Label Studio Community Edition. Learn more about Label Studio Enterprise

Run a prompt inference.

<Card href="https://humansignal.com/goenterprise"> <img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/> <p style="margin-top: 10px; font-size: 14px;"> This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) </p> </Card> Run a prompt inference.

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>

Path parameters

prompt_idintegerRequired

version_idintegerRequired

Request

This endpoint expects an object.

projectintegerRequired

filters_jsonany or nullOptional

DM filter group for Filtered subset. Stored for display/re-run purposes.

job_idstring or nullOptional<=255 characters

Job ID for inference job for a ModelRun e.g. Adala job ID

only_missing_predictionsbooleanOptionalDefaults to false

When true, only tasks without successful predictions for this prompt version are submitted for inference.

organizationinteger or nullOptional

predictions_updated_atdatetime or nullOptional

project_subsetenumOptional

All - All
HasGT - HasGT
Sample - Sample
Custom - Custom

Allowed values:

sample_subset_sizeinteger or nullOptional0-2147483647

Custom sample size for Sample subset. Uses PROMPTER_SAMPLE_SUBSET_SIZE if not set.

total_correct_predictionsinteger or nullOptional-2147483648-2147483647

total_predictionsinteger or nullOptional-2147483648-2147483647

total_tasksinteger or nullOptional-2147483648-2147483647

Response

completed_atdatetime or nullRead-only

created_atdatetimeRead-only

created_byobject

A ModelSerializer that takes additional arguments for "fields", "omit" and "expand" in order to control which fields are displayed, and whether to replace simple values with complex, nested serializations

idintegerRead-only

parent_modelintegerRead-only

projectinteger

source_model_runinteger or nullRead-only

statusenum

Pending - Pending
InProgress - InProgress
Completed - Completed
Failed - Failed
Canceled - Canceled

Allowed values:

task_idsany or nullRead-only

List of task IDs for Custom subset re-evaluation.

triggered_atdatetime or nullRead-only

filters_jsonany or null

DM filter group for Filtered subset. Stored for display/re-run purposes.

job_idstring or null<=255 characters

Job ID for inference job for a ModelRun e.g. Adala job ID

organizationinteger or null

predictions_updated_atdatetime or null

project_subsetenum

All - All
HasGT - HasGT
Sample - Sample
Custom - Custom

Allowed values:

sample_subset_sizeinteger or null0-2147483647

Custom sample size for Sample subset. Uses PROMPTER_SAMPLE_SUBSET_SIZE if not set.

total_correct_predictionsinteger or null-2147483648-2147483647

total_predictionsinteger or null-2147483648-2147483647

total_tasksinteger or null-2147483648-2147483647

1	curl -X POST http://localhost:8000/api/prompts/1/versions/1/inference-runs \
2	-H "Authorization: Token <api_key>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"project": 42
6	}'

1	{
2	"completed_at": "2024-06-10T14:45:00Z",
3	"created_at": "2024-06-10T14:00:00Z",
4	"created_by": {
5	"avatar": "https://example.com/avatars/jdoe.png",
6	"id": 7,
7	"username": "jdoe",
8	"email": "jdoe@example.com",
9	"first_name": "John",
10	"last_name": "Doe"
11	},
12	"id": 123,
13	"parent_model": 88,
14	"project": 42,
15	"source_model_run": 77,
16	"status": "Pending",
17	"triggered_at": "2024-06-10T14:00:00Z",
18	"job_id": "job_987654321",
19	"organization": 5,
20	"predictions_updated_at": "2024-06-10T14:30:00Z",
21	"project_subset": "All",
22	"sample_subset_size": 100,
23	"total_correct_predictions": 250,
24	"total_predictions": 300,
25	"total_tasks": 350
26	}