Delete Environment

Clean up an environment and its database schema

DELETE /api/platform/env/{envId}

Delete Environment

cURL

curl --request DELETE \
  --url https://api.example.com/api/platform/env/{envId}

200

{
  "environmentId": "<string>",
  "status": "<string>"
}

Request

DELETE /api/platform/env/{envId}

Path Parameters

envId · string · required

Environment ID from initEnv

Example Request

curl -X DELETE https://api.agentdiff.dev/api/platform/env/abc123def456 \
  -H "X-API-Key: ad_live_sk_..."

Response

environmentId · string

Environment identifier that was deleted

status · string

Status: "deleted"

Example Response

{
  "environmentId": "abc123def456",
  "status": "deleted"
}

What Happens

1. Schema dropped: PostgreSQL schema and all data deleted
2. Record updated: Environment marked as deleted in database
3. Resources freed: Pool slot recycled for reuse

Always delete environments when done to free up resources. Environments auto-expire after their TTL, but explicit deletion is faster.

Errors

Error	Status	Description
environment_not_found	404	Environment doesn’t exist
environment_already_deleted	400	Environment was already deleted

SDK Usage

Python

# Delete environment
client.delete_env(envId=env.environmentId)
print("Environment cleaned up")

Best Practices

Always clean up in finally blocks

env = client.init_env(...)
try:
    run = client.start_run(envId=env.environmentId)
    # ... your test code ...
finally:
    client.delete_env(envId=env.environmentId)

Use context managers (Python)

# Coming soon: context manager support
# with client.environment(...) as env:
#     ...