✨ Update a project template | API Reference

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

Update the details of a specific project template by ID for an organization.

<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> Update the details of a specific project template by ID for an organization.

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>

Path parameters

idintegerRequired

Request

This endpoint expects an object.

assignment_settingsanyOptional

general dict serialized assignment settings

created_byinteger or nullOptional

custom_scriptstring or nullOptional>=1 character

custom script (Plugin) for projects created from this template

descriptionstring or nullOptional>=1 character

namestringOptional1-1000 characters

organizationinteger or nullOptional

project_idintegerOptional

project_settingsanyOptional

general dict serialized project settings

require_comment_on_skipbooleanOptional

flag to require comment on skip

review_settingsanyOptional

general dict serialized review settings

show_unused_data_columns_to_annotatorsboolean or nullOptional

tagsanyOptional

Response

created_atdatetime

idinteger

namestring<=1000 characters

updated_atdatetime

assignment_settingsany or null

general dict serialized assignment settings

created_byinteger or null

custom_scriptstring or null

custom script (Plugin) for projects created from this template

descriptionstring or null

organizationinteger or null

project_settingsany or null

general dict serialized project settings

require_comment_on_skipboolean or null

flag to require comment on skip

review_settingsany or null

general dict serialized review settings

show_unused_data_columns_to_annotatorsboolean or null

tagsany or null

1	from label_studio_sdk import LabelStudio
2
3	client = LabelStudio(
4	api_key="YOUR_API_KEY",
5	)
6	client.project_templates.update(
7	id=1,
8	)

1	{
2	"created_at": "2024-01-15T09:30:00Z",
3	"id": 1,
4	"name": "string",
5	"updated_at": "2024-01-15T09:30:00Z",
6	"assignment_settings": null,
7	"created_by": 1,
8	"custom_script": "string",
9	"description": "string",
10	"organization": 1,
11	"project_settings": null,
12	"require_comment_on_skip": true,
13	"review_settings": null,
14	"show_unused_data_columns_to_annotators": true
15	}