Skip to navigation
SDK ReferenceProject

Update project

Set hyperedges_enabled to true to enable extraction. A member needs the project.edit permission. Project API keys receive 403 permission_denied.

Authentication

AuthorizationApi-Key

Type “Api-Key” followed by a space and the project API key.

Request

Request body
default_time_zonestringOptional
The project's IANA fallback time zone. Set to null to clear the existing value.
hyperedges_enabledbooleanOptional

Set to true to enable hyperedge extraction. This setting cannot be disabled. A member needs project.edit. Project API keys receive 403 permission_denied.

include_policy_violating_episodesbooleanOptional
When true, episode reads on graphs with a content policy include the episodes that violated the policy.

Response

OK
created_atstringOptional
The time the project was created.
default_time_zonestringOptional
The project's default IANA time zone, used as the fallback when a resource does not set its own.
descriptionstringOptional

A human-readable description of the project.

hyperedges_enabledbooleanOptional

True when hyperedge extraction is enabled for this project. This setting is one-way.

include_policy_violating_episodesbooleanOptional
When true, episode reads on graphs with a content policy include the episodes that violated the policy. The default is false.
namestringOptional
The name of the project.
uuidstringOptional
The unique identifier of the project.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error