Platform APIProjects

Update project

Update a specific project

Authentication

AuthorizationBearer

Bearer authentication using API key. Generate an API key from the AI Guardrails Dashboard. Example: Bearer sk_123…

Path parameters

projectIdstringRequired

Request

This endpoint expects an object.
namestringRequired
A descriptive name for the project
policy_idstringOptional
ID of the policy to be applied to this project. If not provided, uses default policy.
project_metadatamap from strings to stringsOptional
Custom metadata tags for analysis and cross referencing
actionenumOptional

Controls whether Guard enforces flagging on this project. flag (the default) means full enforcement: the top-level flagged in a guard response is true whenever any of the enabled detectors triggers. detect surfaces detections in the breakdown but forces the top-level flagged to false, letting you observe detector behavior without blocking traffic. Always returned when reading a project. Optional when creating — defaults to flag. Optional when updating — omit to keep the existing value. More information in Project Mode.

Response

Project updated
namestring
A descriptive name for the project
policy_idstringOptional
ID of the policy to be applied to this project. If not provided, uses default policy.
project_metadatamap from strings to stringsOptional
Custom metadata tags for analysis and cross referencing
actionenumOptional

Controls whether Guard enforces flagging on this project. flag (the default) means full enforcement: the top-level flagged in a guard response is true whenever any of the enabled detectors triggers. detect surfaces detections in the breakdown but forces the top-level flagged to false, letting you observe detector behavior without blocking traffic. Always returned when reading a project. Optional when creating — defaults to flag. Optional when updating — omit to keep the existing value. More information in Project Mode.