## StopAgentExecution

`client.agents.stopExecution(AgentStopExecutionParamsbody, RequestOptionsoptions?): AgentStopExecutionResponse`

**post** `/gitpod.v1.AgentService/StopAgentExecution`

Stops an active agent execution.

Use this method to:

- Stop an agent that is currently running
- Prevent further processing or resource usage

### Examples

- Stop an agent execution by ID:

  ```yaml
  agentExecutionId: "6fa1a3c7-fbb7-49d1-ba56-1890dc7c4c35"
  ```

### Parameters

- `body: AgentStopExecutionParams`

  - `agentExecutionId?: string`

### Returns

- `AgentStopExecutionResponse = unknown`

### Example

```typescript
import Gitpod from '@gitpod/sdk';

const client = new Gitpod({
  bearerToken: process.env['GITPOD_API_KEY'], // This is the default and can be omitted
});

const response = await client.agents.stopExecution({
  agentExecutionId: '6fa1a3c7-fbb7-49d1-ba56-1890dc7c4c35',
});

console.log(response);
```

#### Response

```json
{}
```