---
title: "GET /assistants/{assistantId}"
method: GET
path: "/assistants/{assistantId}"
---

# GET /assistants/{assistantId}

`GET /assistants/{assistantId}`

Retrieves information about an assistant.

## Path parameters

- `assistantId` string, required

## Response `200`

Success

- GetAssistantResponse
  - `assistant` object — Information about the assistant.
    - `assistantId` string, required — The identifier of the Amazon Q in Connect assistant.
    - `assistantArn` string, required — The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
    - `name` string, required — The name.
    - `type` 'AGENT', required — The type of assistant.
    - `status` 'CREATE_IN_PROGRESS' | 'CREATE_FAILED' | 'ACTIVE' | 'DELETE_IN_PROGRESS' | 'DELETE_FAILED' | 'DELETED', required — The status of the assistant.
    - `description` string — The description.
    - `tags` object — The tags used to organize, track, or control access for this resource.
    - `serverSideEncryptionConfiguration` object — <p>The configuration information for the customer managed key used for encryption. </p> <p>This KMS key must have a policy that allows <code>kms:CreateGrant</code>, <code>kms:DescribeKey</code>, <code>kms:Decrypt</code>, and <code>kms:GenerateDataKey*</code> permissions to the IAM identity using the key to invoke Amazon Q in Connect. To use Amazon Q in Connect with chat, the key policy must also allow <code>kms:Decrypt</code>, <code>kms:GenerateDataKey*</code>, and <code>kms:DescribeKey</code> permissions to the <code>connect.amazonaws.com</code> service principal. </p> <p>For more information about setting up a customer managed key for Amazon Q in Connect, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/enable-q.html">Enable Amazon Q in Connect for your instance</a>.</p>
      - `kmsKeyId` string — The customer managed key used for encryption. For more information about setting up a customer managed key for Amazon Q in Connect, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/enable-q.html">Enable Amazon Q in Connect for your instance</a>. For information about valid ID values, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id">Key identifiers (KeyId)</a>.
    - `integrationConfiguration` object — The configuration information for the Amazon Q in Connect assistant integration.
      - `topicIntegrationArn` string — The Amazon Resource Name (ARN) of the integrated Amazon SNS topic used for streaming chat messages.
    - `capabilityConfiguration` object — The configuration information for the Amazon Q in Connect assistant capability.
      - `type` 'V1' | 'V2' — The type of Amazon Q in Connect assistant capability.
    - `aiAgentConfiguration` object — The configuration of the AI Agents (mapped by AI Agent Type to AI Agent version) that is set on the Amazon Q in Connect Assistant.
    - `orchestratorConfigurationList` OrchestratorConfigurationEntry[] — The list of orchestrator configurations for the assistant.
      - `aiAgentId` string — The identifier of the AI Agent in the orchestrator configuration.
      - `orchestratorUseCase` string, required — The use case for the orchestrator configuration. (for example Connect.SelfService, Connect.AgentAssistance)

## Other responses

- `480` — ValidationException
- `481` — UnauthorizedException
- `482` — AccessDeniedException
- `483` — ResourceNotFoundException

---

[API](https://skmtc.net/aws/apis/qconnect.md) · [All operations](https://skmtc.net/aws/apis/qconnect/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/qconnect/versions/833f5de92023/schema)