> Documentation index: https://www.gooddata.ai/docs/gooddata-ui/llms.txt lists every page of these docs as Markdown.

# ICopilotScope

- Package: [@gooddata/sdk-ui-gen-ai](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-gen-ai/index.md)
- Kind: interface
- Stability: alpha
- Source: https://github.com/gooddata/gooddata-ui-sdk/blob/rel/11.68/libs/sdk-ui-gen-ai/src/copilot/types.ts

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Scope of a progress query.

**Signature:**

```typescript
export interface ICopilotScope<TBuild extends string = CopilotBuildType> 
```

## Properties

| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [isBuilder?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-gen-ai/sdk-ui-gen-ai.icopilotscope/index.md#icopilotscopeisbuilder) | `readonly` | boolean | **_(ALPHA)_** _(Optional)_ Include activated requests and an existing foreground edit build. |
| [isEditing?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-gen-ai/sdk-ui-gen-ai.icopilotscope/index.md#icopilotscopeisediting) | `readonly` | boolean | **_(ALPHA)_** _(Optional)_ Include activated edit requests. |
| [objectId?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-gen-ai/sdk-ui-gen-ai.icopilotscope/index.md#icopilotscopeobjectid) | `readonly` | string | **_(ALPHA)_** _(Optional)_ Restrict activated requests to this object. |
| [type](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-gen-ai/sdk-ui-gen-ai.icopilotscope/index.md#icopilotscopetype) | `readonly` | TBuild | **_(ALPHA)_** Workflow to query. |

## Property details

### ICopilotScope.isBuilder

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Include activated requests and an existing foreground edit build.

**Signature:**

```typescript
readonly isBuilder?: boolean;
```

### ICopilotScope.isEditing

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Include activated edit requests.

**Signature:**

```typescript
readonly isEditing?: boolean;
```

### ICopilotScope.objectId

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Restrict activated requests to this object.

**Signature:**

```typescript
readonly objectId?: string;
```

### ICopilotScope.type

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Workflow to query.

**Signature:**

```typescript
readonly type: TBuild;
```
