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

# ICopilotRequest

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

A potentially editing response, including provisional requests without a skill.

**Signature:**

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

## Properties

| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [applicationIds](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-gen-ai/sdk-ui-gen-ai.icopilotrequest/index.md#icopilotrequestapplicationids) | `readonly` | readonly string[] | **_(ALPHA)_** In-progress host applications. |
| [awaitingClarification?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-gen-ai/sdk-ui-gen-ai.icopilotrequest/index.md#icopilotrequestawaitingclarification) | `readonly` | boolean | **_(ALPHA)_** _(Optional)_ Whether this response awaits clarification. |
| [conversationId?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-gen-ai/sdk-ui-gen-ai.icopilotrequest/index.md#icopilotrequestconversationid) | `readonly` | string | **_(ALPHA)_** _(Optional)_ Originating local conversation. |
| [generation?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-gen-ai/sdk-ui-gen-ai.icopilotrequest/index.md#icopilotrequestgeneration) | `readonly` | TBuild | **_(ALPHA)_** _(Optional)_ Creation workflow requested for this response, even before skill activation. |
| [intent?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-gen-ai/sdk-ui-gen-ai.icopilotrequest/index.md#icopilotrequestintent) | `readonly` | "create" \| "edit" | **_(ALPHA)_** _(Optional)_ Workflow intent captured at skill activation, independent of the selected conversation. |
| [objectId?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-gen-ai/sdk-ui-gen-ai.icopilotrequest/index.md#icopilotrequestobjectid) | `readonly` | string | **_(ALPHA)_** _(Optional)_ Resolved object identifier. |
| [pendingClarificationIds?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-gen-ai/sdk-ui-gen-ai.icopilotrequest/index.md#icopilotrequestpendingclarificationids) | `readonly` | readonly string[] | **_(ALPHA)_** _(Optional)_ Unanswered clarification item identifiers for this response. |
| [responseFinished?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-gen-ai/sdk-ui-gen-ai.icopilotrequest/index.md#icopilotrequestresponsefinished) | `readonly` | boolean | **_(ALPHA)_** _(Optional)_ Response ended; waiting for a user reply or in-progress definition application. |
| [revision](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-gen-ai/sdk-ui-gen-ai.icopilotrequest/index.md#icopilotrequestrevision) | `readonly` | number | **_(ALPHA)_** Monotonic request revision, distinguishing follow-ups in the same conversation. |
| [superseded?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-gen-ai/sdk-ui-gen-ai.icopilotrequest/index.md#icopilotrequestsuperseded) | `readonly` | boolean | **_(ALPHA)_** _(Optional)_ Another conversation activated this workflow; late events must not regain ownership. |
| [threadId?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-gen-ai/sdk-ui-gen-ai.icopilotrequest/index.md#icopilotrequestthreadid) | `readonly` | string | **_(ALPHA)_** _(Optional)_ Backend thread assigned to the request. |
| [type?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-gen-ai/sdk-ui-gen-ai.icopilotrequest/index.md#icopilotrequesttype) | `readonly` | TBuild | **_(ALPHA)_** _(Optional)_ Resolved skill's workflow; absent until activation. |

## Property details

### ICopilotRequest.applicationIds

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

In-progress host applications.

**Signature:**

```typescript
readonly applicationIds: readonly string[];
```

### ICopilotRequest.awaitingClarification

> **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 this response awaits clarification.

**Signature:**

```typescript
readonly awaitingClarification?: boolean;
```

### ICopilotRequest.conversationId

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

Originating local conversation.

**Signature:**

```typescript
readonly conversationId?: string;
```

### ICopilotRequest.generation

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

Creation workflow requested for this response, even before skill activation.

**Signature:**

```typescript
readonly generation?: TBuild;
```

### ICopilotRequest.intent

> **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 intent captured at skill activation, independent of the selected conversation.

**Signature:**

```typescript
readonly intent?: "create" | "edit";
```

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

Resolved object identifier.

**Signature:**

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

### ICopilotRequest.pendingClarificationIds

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

Unanswered clarification item identifiers for this response.

**Signature:**

```typescript
readonly pendingClarificationIds?: readonly string[];
```

### ICopilotRequest.responseFinished

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

Response ended; waiting for a user reply or in-progress definition application.

**Signature:**

```typescript
readonly responseFinished?: boolean;
```

### ICopilotRequest.revision

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

Monotonic request revision, distinguishing follow-ups in the same conversation.

**Signature:**

```typescript
readonly revision: number;
```

### ICopilotRequest.superseded

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

Another conversation activated this workflow; late events must not regain ownership.

**Signature:**

```typescript
readonly superseded?: boolean;
```

### ICopilotRequest.threadId

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

Backend thread assigned to the request.

**Signature:**

```typescript
readonly threadId?: string;
```

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

Resolved skill's workflow; absent until activation.

**Signature:**

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