Model Armor API

Model Armor helps you protect against risks like prompt injection, harmful content, and data leakage in generative AI applications by letting you define policies that filter user prompts and model responses.

Service: modelarmor.googleapis.com

To call this service, we recommend that you use the Google-provided client libraries. If your application needs to use your own libraries to call this service, use the following information when you make the API requests.

Discovery document

A Discovery Document is a machine-readable specification for describing and consuming REST APIs. It is used to build client libraries, IDE plugins, and other tools that interact with Google APIs. One service may provide multiple discovery documents. This service provides the following discovery document:

Service endpoint

A service endpoint is a base URL that specifies the network address of an API service. One service might have multiple service endpoints. This service has the following service endpoint and all URIs below are relative to this service endpoint:

  • https://modelarmor.googleapis.com

Regional service endpoint

A regional service endpoint is a base URL that specifies the network address of an API service in a single region. A service that is available in multiple regions might have multiple regional endpoints. Select a location to see its regional service endpoint for this service.


REST Resource: v1.folders.locations

Methods
getFloorSetting GET /v1/{name=folders/*/locations/*/floorSetting}
Gets details of a single floor setting of a project
updateFloorSetting PATCH /v1/{floorSetting.name=folders/*/locations/*/floorSetting}
Updates the parameters of a single floor setting of a project

REST Resource: v1.organizations.locations

Methods
getFloorSetting GET /v1/{name=organizations/*/locations/*/floorSetting}
Gets details of a single floor setting of a project
updateFloorSetting PATCH /v1/{floorSetting.name=organizations/*/locations/*/floorSetting}
Updates the parameters of a single floor setting of a project

REST Resource: v1.projects.locations

Methods
get GET /v1/{name=projects/*/locations/*}
Gets information about a location.
getFloorSetting GET /v1/{name=projects/*/locations/*/floorSetting}
Gets details of a single floor setting of a project
list GET /v1/{name=projects/*}/locations
Lists information about the supported locations for this service.
updateFloorSetting PATCH /v1/{floorSetting.name=projects/*/locations/*/floorSetting}
Updates the parameters of a single floor setting of a project

REST Resource: v1.projects.locations.templates

Methods
create POST /v1/{parent=projects/*/locations/*}/templates
Creates a new Template in a given project and location.
delete DELETE /v1/{name=projects/*/locations/*/templates/*}
Deletes a single Template.
get GET /v1/{name=projects/*/locations/*/templates/*}
Gets details of a single Template.
list GET /v1/{parent=projects/*/locations/*}/templates
Lists Templates in a given project and location.
patch PATCH /v1/{template.name=projects/*/locations/*/templates/*}
Updates the parameters of a single Template.
sanitizeModelResponse POST /v1/{name=projects/*/locations/*/templates/*}:sanitizeModelResponse
Sanitizes Model Response.
sanitizeUserPrompt POST /v1/{name=projects/*/locations/*/templates/*}:sanitizeUserPrompt
Sanitizes User Prompt.