Delete Agent Config (hard delete)

agent_configs.delete() -> AgentConfigDeleteResponse

DELETE/v5/agent_configs/{agent_config_id}

Permanently delete an agent config; this is a hard delete, not an archive, so the row is removed and cannot be restored.

Because a config is only a template, deleting it does not stop or alter any task already created from it. A user caller can only delete a config they created unless fine-grained access control grants access. The response echoes the deleted id.

ParametersExpand Collapse

agent_config_id: str

ReturnsExpand Collapse

class AgentConfigDeleteResponse: …

id: str

deleted: bool

object: Optional[Literal["agent_config"]]

Delete Agent Config (hard delete)

import os
from scale_gp_beta import SGPClient

client = SGPClient(
    api_key=os.environ.get("SGP_API_KEY"),  # This is the default and can be omitted
)
agent_config = client.agent_configs.delete(
    "agent_config_id",
)
print(agent_config.id)

{
  "id": "id",
  "deleted": true,
  "object": "agent_config"
}

Returns Examples

{
  "id": "id",
  "deleted": true,
  "object": "agent_config"
}