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

# ICopilotContext

- 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).
> 

Host facts used to resolve events, never application services.

**Signature:**

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

## Properties

| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [builderTarget?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-gen-ai/sdk-ui-gen-ai.icopilotcontext/index.md#icopilotcontextbuildertarget) | `readonly` | [ICopilotTarget](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-gen-ai/sdk-ui-gen-ai.icopilottarget/index.md)&lt;TBuild&gt; | **_(ALPHA)_** _(Optional)_ Object being displayed in a builder, if any. |
| [isEditing?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-gen-ai/sdk-ui-gen-ai.icopilotcontext/index.md#icopilotcontextisediting) | `readonly` | boolean | **_(ALPHA)_** _(Optional)_ Whether the host allows edits to the displayed object. |
| [objectId?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-gen-ai/sdk-ui-gen-ai.icopilotcontext/index.md#icopilotcontextobjectid) | `readonly` | string | **_(ALPHA)_** _(Optional)_ Currently displayed object. |
| [type?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-gen-ai/sdk-ui-gen-ai.icopilotcontext/index.md#icopilotcontexttype) | `readonly` | TBuild | **_(ALPHA)_** _(Optional)_ Currently displayed workflow. |

## Property details

### ICopilotContext.builderTarget

> **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).
> 

Object being displayed in a builder, if any.

**Signature:**

```typescript
readonly builderTarget?: ICopilotTarget<TBuild>;
```

### ICopilotContext.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).
> 

Whether the host allows edits to the displayed object.

**Signature:**

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

### ICopilotContext.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).
> 

Currently displayed object.

**Signature:**

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

### ICopilotContext.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).
> 

Currently displayed workflow.

**Signature:**

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