✨ List prompts | API Reference

List all prompts.

Authentication

Authorizationstring

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

orderingstringOptional

Which field to use when ordering the results.

Response

created_atdatetime

idinteger

titlestring<=500 characters

Model name

updated_atdatetime

associated_projectslist of objects or null

created_byobject or null

User who created Dataset

descriptionstring or null

Model description

input_fieldsany or null

organizationinteger or null

output_classesany or null

skill_nameenum or null

TextClassification - TextClassification
NamedEntityRecognition - NamedEntityRecognition

* `TextClassification` - TextClassification * `NamedEntityRecognition` - NamedEntityRecognition

Allowed values:

1	from label_studio_sdk import LabelStudio
2
3	client = LabelStudio(
4	api_key="YOUR_API_KEY",
5	)
6	client.prompts.list()

1	[
2	{
3	"created_at": "2024-01-15T09:30:00Z",
4	"id": 1,
5	"title": "string",
6	"updated_at": "2024-01-15T09:30:00Z",
7	"associated_projects": [
8	{
9	"id": 1,
10	"title": "string"
11	}
12	],
13	"created_by": {
14	"avatar": "string",
15	"id": 1,
16	"email": "string",
17	"first_name": "string",
18	"last_name": "string"
19	},
20	"description": "string",
21	"organization": 1,
22	"skill_name": "TextClassification"
23	}
24	]