Turn an agent's goal off

DELETE
/v1/agents/{id}/goal

Stops scoring for the agent. Verdicts already given are kept, so the rates you have read do not move. Setting a goal again starts scoring again.

Requires an API key with the workspace:write scope.

Authorization

apiKey
headerAuthorizationBearer <token>

A secret API key from the dashboard (Developers → API keys): vl_live_…, or vl_test_… for test mode. Each operation says which scope the key needs.

Path Parameters

id*string

The agent id.

Response Body

Scoring is off; verdicts already given are kept

application/json
  1. response
cleared*boolean
Example Request
curl -X DELETE "https://api.vlayers.ai/v1/agents/$AGENT_ID/goal" \  -H "Authorization: Bearer $VOICELAYER_API_KEY"
Example Response
{  "cleared": true}