Project Environment Agent Provider Settings

5 operations.

Method	Endpoint	Description
GET	`/api/v1/projects/{projectId}/environments/{environmentId}/agents/{agentId}/provider-settings`	List environment provider settings
POST	`/api/v1/projects/{projectId}/environments/{environmentId}/agents/{agentId}/provider-settings`	Create an environment provider setting
GET	`/api/v1/projects/{projectId}/environments/{environmentId}/agents/{agentId}/provider-settings/{settingId}`	Get an environment provider setting
PATCH	`/api/v1/projects/{projectId}/environments/{environmentId}/agents/{agentId}/provider-settings/{settingId}`	Update an environment provider setting
DELETE	`/api/v1/projects/{projectId}/environments/{environmentId}/agents/{agentId}/provider-settings/{settingId}`	Delete an environment provider setting

List environment provider settings

GET /api/v1/projects/{projectId}/environments/{environmentId}/agents/{agentId}/provider-settings

Parameters

path

Name	Type	Required	Description
`projectId`	`string`	required	Identifies the Project that owns the addressed resource. Applies to List environment provider settings.
`environmentId`	`string`	required	Identifies the Project environment addressed by the operation. Applies to List environment provider settings.
`agentId`	`string`	required	Identifies the Project Agent being addressed. Applies to List environment provider settings.

Responses

Status	Description	Body
`200`	Response for status 200	`application/json` — `object` — data: object (required)
`400`	The request is malformed or cannot be processed.	`application/json` — `PublicApiError` — error: object (required)
`401`	Authentication failed. The Authorization header is missing, or the credential is invalid or expired.	`application/json` — `PublicApiError` — error: object (required)
`403`	Access denied. The authenticated user does not have permission to perform this action.	`application/json` — `PublicApiError` — error: object (required)
`404`	Resource not found.	`application/json` — `PublicApiError` — error: object (required)
`409`	Request conflicts with current state of the resource, including safe deployment conflict classifications.	`application/json` — `PublicApiError` — error: object (required)
`422`	Request validation failed. Check the request body, query parameters, or path parameters.	`application/json` — `PublicApiError` — error: object (required)
`429`	Too many requests. The code foreign_resource_rate_limited means the caller made too many requests for Projects outside its reach: correct the Project id instead of retrying.	`application/json` — `PublicApiError` — error: object (required)
`500`	The server could not complete the request.	`application/json` — `PublicApiError` — error: object (required)
`503`	Service temporarily unavailable (e.g. execution capacity exhausted). The response carries a Retry-After header; retry with backoff.	`application/json` — `PublicApiError` — error: object (required)

Create an environment provider setting

POST /api/v1/projects/{projectId}/environments/{environmentId}/agents/{agentId}/provider-settings

Parameters

path

Name	Type	Required	Description
`projectId`	`string`	required	Identifies the Project that owns the addressed resource. Applies to Create an environment provider setting.
`environmentId`	`string`	required	Identifies the Project environment addressed by the operation. Applies to Create an environment provider setting.
`agentId`	`string`	required	Identifies the Project Agent being addressed. Applies to Create an environment provider setting.

Request body

Required — Request body for: Create an environment provider setting.

application/json

Name	Type	Required
`provider`	`"anthropic" \| "google" \| "openai" \| "deepseek" \| "azure-openai" \| "amazon-bedrock" \| "google-vertex" \| "fireworks" \| null`	optional
`model`	`string \| null`	optional
`settings`	`object`	optional
`providerCredentialId`	`string \| null`	optional
`providerCredentialVersion`	`integer \| null`	optional

Responses

Status	Description	Body
`200`	Response for status 200	`application/json` — `object` — data: object (required)
`400`	The request is malformed or cannot be processed.	`application/json` — `PublicApiError` — error: object (required)
`401`	Authentication failed. The Authorization header is missing, or the credential is invalid or expired.	`application/json` — `PublicApiError` — error: object (required)
`403`	Access denied. The authenticated user does not have permission to perform this action.	`application/json` — `PublicApiError` — error: object (required)
`404`	Resource not found.	`application/json` — `PublicApiError` — error: object (required)
`409`	Request conflicts with current state of the resource, including safe deployment conflict classifications.	`application/json` — `PublicApiError` — error: object (required)
`422`	Request validation failed. Check the request body, query parameters, or path parameters.	`application/json` — `PublicApiError` — error: object (required)
`429`	Too many requests. The code foreign_resource_rate_limited means the caller made too many requests for Projects outside its reach: correct the Project id instead of retrying.	`application/json` — `PublicApiError` — error: object (required)
`500`	The server could not complete the request.	`application/json` — `PublicApiError` — error: object (required)
`503`	Service temporarily unavailable (e.g. execution capacity exhausted). The response carries a Retry-After header; retry with backoff.	`application/json` — `PublicApiError` — error: object (required)

Get an environment provider setting

GET /api/v1/projects/{projectId}/environments/{environmentId}/agents/{agentId}/provider-settings/{settingId}

Parameters

path

Name	Type	Required	Description
`projectId`	`string`	required	Identifies the Project that owns the addressed resource. Applies to Get an environment provider setting.
`environmentId`	`string`	required	Identifies the Project environment addressed by the operation. Applies to Get an environment provider setting.
`agentId`	`string`	required	Identifies the Project Agent being addressed. Applies to Get an environment provider setting.
`settingId`	`integer`	required	Identifies the Environment provider setting being addressed. Applies to Get an environment provider setting.

Responses

Status	Description	Body
`200`	Response for status 200	`application/json` — `object` — data: object (required)
`400`	The request is malformed or cannot be processed.	`application/json` — `PublicApiError` — error: object (required)
`401`	Authentication failed. The Authorization header is missing, or the credential is invalid or expired.	`application/json` — `PublicApiError` — error: object (required)
`403`	Access denied. The authenticated user does not have permission to perform this action.	`application/json` — `PublicApiError` — error: object (required)
`404`	Resource not found.	`application/json` — `PublicApiError` — error: object (required)
`409`	Request conflicts with current state of the resource, including safe deployment conflict classifications.	`application/json` — `PublicApiError` — error: object (required)
`422`	Request validation failed. Check the request body, query parameters, or path parameters.	`application/json` — `PublicApiError` — error: object (required)
`429`	Too many requests. The code foreign_resource_rate_limited means the caller made too many requests for Projects outside its reach: correct the Project id instead of retrying.	`application/json` — `PublicApiError` — error: object (required)
`500`	The server could not complete the request.	`application/json` — `PublicApiError` — error: object (required)
`503`	Service temporarily unavailable (e.g. execution capacity exhausted). The response carries a Retry-After header; retry with backoff.	`application/json` — `PublicApiError` — error: object (required)

Update an environment provider setting

PATCH /api/v1/projects/{projectId}/environments/{environmentId}/agents/{agentId}/provider-settings/{settingId}

Parameters

path

Name	Type	Required	Description
`projectId`	`string`	required	Identifies the Project that owns the addressed resource. Applies to Update an environment provider setting.
`environmentId`	`string`	required	Identifies the Project environment addressed by the operation. Applies to Update an environment provider setting.
`agentId`	`string`	required	Identifies the Project Agent being addressed. Applies to Update an environment provider setting.
`settingId`	`integer`	required	Identifies the Environment provider setting being addressed. Applies to Update an environment provider setting.

Request body

Required — Request body for: Update an environment provider setting.

application/json

Name	Type	Required
`provider`	`"anthropic" \| "google" \| "openai" \| "deepseek" \| "azure-openai" \| "amazon-bedrock" \| "google-vertex" \| "fireworks" \| null`	optional
`model`	`string \| null`	optional
`settings`	`object`	optional
`providerCredentialId`	`string \| null`	optional
`providerCredentialVersion`	`integer \| null`	optional

Responses

Status	Description	Body
`200`	Response for status 200	`application/json` — `object` — data: object (required)
`400`	The request is malformed or cannot be processed.	`application/json` — `PublicApiError` — error: object (required)
`401`	Authentication failed. The Authorization header is missing, or the credential is invalid or expired.	`application/json` — `PublicApiError` — error: object (required)
`403`	Access denied. The authenticated user does not have permission to perform this action.	`application/json` — `PublicApiError` — error: object (required)
`404`	Resource not found.	`application/json` — `PublicApiError` — error: object (required)
`409`	Request conflicts with current state of the resource, including safe deployment conflict classifications.	`application/json` — `PublicApiError` — error: object (required)
`422`	Request validation failed. Check the request body, query parameters, or path parameters.	`application/json` — `PublicApiError` — error: object (required)
`429`	Too many requests. The code foreign_resource_rate_limited means the caller made too many requests for Projects outside its reach: correct the Project id instead of retrying.	`application/json` — `PublicApiError` — error: object (required)
`500`	The server could not complete the request.	`application/json` — `PublicApiError` — error: object (required)
`503`	Service temporarily unavailable (e.g. execution capacity exhausted). The response carries a Retry-After header; retry with backoff.	`application/json` — `PublicApiError` — error: object (required)

Delete an environment provider setting

DELETE /api/v1/projects/{projectId}/environments/{environmentId}/agents/{agentId}/provider-settings/{settingId}

Parameters

path

Name	Type	Required	Description
`projectId`	`string`	required	Identifies the Project that owns the addressed resource. Applies to Delete an environment provider setting.
`environmentId`	`string`	required	Identifies the Project environment addressed by the operation. Applies to Delete an environment provider setting.
`agentId`	`string`	required	Identifies the Project Agent being addressed. Applies to Delete an environment provider setting.
`settingId`	`integer`	required	Identifies the Environment provider setting being addressed. Applies to Delete an environment provider setting.

Responses

Status	Description	Body
`200`	Response for status 200	`application/json` — `object` — data: object (required)
`400`	The request is malformed or cannot be processed.	`application/json` — `PublicApiError` — error: object (required)
`401`	Authentication failed. The Authorization header is missing, or the credential is invalid or expired.	`application/json` — `PublicApiError` — error: object (required)
`403`	Access denied. The authenticated user does not have permission to perform this action.	`application/json` — `PublicApiError` — error: object (required)
`404`	Resource not found.	`application/json` — `PublicApiError` — error: object (required)
`409`	Request conflicts with current state of the resource, including safe deployment conflict classifications.	`application/json` — `PublicApiError` — error: object (required)
`422`	Request validation failed. Check the request body, query parameters, or path parameters.	`application/json` — `PublicApiError` — error: object (required)
`429`	Too many requests. The code foreign_resource_rate_limited means the caller made too many requests for Projects outside its reach: correct the Project id instead of retrying.	`application/json` — `PublicApiError` — error: object (required)
`500`	The server could not complete the request.	`application/json` — `PublicApiError` — error: object (required)
`503`	Service temporarily unavailable (e.g. execution capacity exhausted). The response carries a Retry-After header; retry with backoff.	`application/json` — `PublicApiError` — error: object (required)