Skip to main content

Delete environment template

Delete the specified environment template.

Endpoint

DELETE /agents/environments/templates/{template_id} Returns 200 and a delete envelope. After deletion, retrieving or deleting the same template returns 404.

Path parameters

template_id string (required)Environment template IDThis endpoint has no request body or query parameters.

Request example

curl -sS -X DELETE "$BASE_URL/agents/environments/templates/envtmpl_xxx" \
  -H "Authorization: Bearer $DASHSCOPE_API_KEY" \
  -H "OpenAI-Beta: agents=v1"

Response fields

id stringDeleted environment template IDobject stringEnvironment template deletion result object type, fixed as agent.environment.template.deleteddeleted booleanWhether deletion succeeded, true when deletion succeeds

Response example

{
  "id": "envtmpl_xxx",
  "object": "agent.environment.template.deleted",
  "deleted": true
}

Error codes

HTTP statusError type / codeSolution
401authentication_error / invalid_api_keySend a valid Authorization: Bearer $DASHSCOPE_API_KEY header
404not_found_error / not_found_errorUse an environment template ID that exists in the current workspace
500server_error / server_errorRetry later. If it keeps failing, submit a ticket with x-request-id