Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1494674591.3 KB

Creates an Amazon Q in Connect AI Prompt.

post/assistants/{assistantId}/aiprompts

Path parameters

assistantIdstring required

The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

Request body

clientTokenstring

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href="http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>..

namestring required

The name of the AI Prompt.

type'ANSWER_GENERATION' | 'INTENT_LABELING_GENERATION' | 'QUERY_REFORMULATION' | 'SELF_SERVICE_PRE_PROCESSING' | 'SELF_SERVICE_ANSWER_GENERATION' | 'EMAIL_RESPONSE' | 'EMAIL_OVERVIEW' | 'EMAIL_GENERATIVE_ANSWER' | 'EMAIL_QUERY_REFORMULATION' | 'ORCHESTRATION' | 'NOTE_TAKING' | 'CASE_SUMMARIZATION' required

The type of this AI Prompt.

visibilityStatus'SAVED' | 'PUBLISHED' required

The visibility status of the AI Prompt.

templateType'TEXT' required

The type of the prompt template for this AI Prompt.

modelIdstring required
<p>The identifier of the model used for this AI Prompt.</p> <note> <p>For information about which models are supported in each Amazon Web Services Region, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/create-ai-prompts.html#cli-create-aiprompt">Supported models for system/custom prompts</a>.</p> </note>
apiFormat'ANTHROPIC_CLAUDE_MESSAGES' | 'ANTHROPIC_CLAUDE_TEXT_COMPLETIONS' | 'MESSAGES' | 'TEXT_COMPLETIONS' required
<p>The API Format of the AI Prompt.</p> <p>Recommended values: <code>MESSAGES | TEXT_COMPLETIONS</code> </p> <note> <p>The values <code>ANTHROPIC_CLAUDE_MESSAGES | ANTHROPIC_CLAUDE_TEXT_COMPLETIONS</code> will be deprecated.</p> </note>
tagsobject

The tags used to organize, track, or control access for this resource.

descriptionstring

The description of the AI Prompt.

Response

Success