Mutations: Content generation

GraphQL mutations for content generation sessions, jobs, flows, and content review in the Amplience GraphQL Management API.

Sessions & messages

createContentGenerationSession

createContentGenerationSession(
  input: CreateContentGenerationSessionInput!
): ContentGenerationSession!

Returns: ContentGenerationSession!

Arguments:

Argument	Type	Default	Description
input	CreateContentGenerationSessionInput!

updateContentGenerationSession

updateContentGenerationSession(
  input: UpdateContentGenerationSessionInput!
): ContentGenerationSession!

Returns: ContentGenerationSession!

Arguments:

Argument	Type	Default	Description
input	UpdateContentGenerationSessionInput!

deleteContentGenerationSession

deleteContentGenerationSession(
  input: DeleteContentGenerationSessionInput!
): Boolean!

Returns: Boolean!

Arguments:

Argument	Type	Default	Description
input	DeleteContentGenerationSessionInput!

submitContentGenerationSessionMessage

This mutation uses Amplience Credits.

Submits a message to a Content Studio session. Returns the details of the submitted message and a URL to stream the LLM response from, ideal for user facing front ends.

Consumes Amplience credits.

Labs preview.

See also: Mutations that use Amplience Credits

submitContentGenerationSessionMessage(
  input: SubmitContentGenerationSessionMessageInput!
): SubmitContentGenerationSessionMessageResponse!

Returns: SubmitContentGenerationSessionMessageResponse!

Arguments:

Argument	Type	Default	Description
input	SubmitContentGenerationSessionMessageInput!

scoreContentGenerationSessionMessage

scoreContentGenerationSessionMessage(
  input: ScoreContentGenerationSessionMessageInput!
): ContentGenerationSessionMessage!

Returns: ContentGenerationSessionMessage!

Arguments:

Argument	Type	Default	Description
input	ScoreContentGenerationSessionMessageInput!

generateEditForContentGenerationSessionMessageProperty

This mutation uses Amplience Credits.

Submits a request to edit a selection of text. Returns a URL to stream the LLM response from.

Consumes Amplience credits.

Labs preview.

See also: Mutations that use Amplience Credits

generateEditForContentGenerationSessionMessageProperty(
  input: GenerateEditForContentGenerationSessionMessagePropertyInput!
): GenerateEditForContentGenerationSessionMessagePropertyResponse!

Returns: GenerateEditForContentGenerationSessionMessagePropertyResponse!

Arguments:

Argument	Type	Default	Description
input	GenerateEditForContentGenerationSessionMessagePropertyInput!

saveContentGenerationSessionMessageTextProperty

saveContentGenerationSessionMessageTextProperty(
  input: SaveContentGenerationSessionMessageTextPropertyInput!
): Boolean!

Returns: Boolean!

Arguments:

Argument	Type	Default	Description
input	SaveContentGenerationSessionMessageTextPropertyInput!

Briefs & templates

createContentGenerationBriefTemplate

createContentGenerationBriefTemplate(
  input: CreateContentGenerationBriefTemplateInput!
): ContentGenerationBriefTemplate!

Returns: ContentGenerationBriefTemplate!

Arguments:

Argument	Type	Default	Description
input	CreateContentGenerationBriefTemplateInput!

updateContentGenerationBriefTemplate

updateContentGenerationBriefTemplate(
  input: UpdateContentGenerationBriefTemplateInput!
): ContentGenerationBriefTemplate!

Returns: ContentGenerationBriefTemplate!

Arguments:

Argument	Type	Default	Description
input	UpdateContentGenerationBriefTemplateInput!

deleteContentGenerationBriefTemplate

deleteContentGenerationBriefTemplate(
  input: DeleteContentGenerationBriefTemplateInput!
): Boolean!

Returns: Boolean!

Arguments:

Argument	Type	Default	Description
input	DeleteContentGenerationBriefTemplateInput!

Audiences, brand voices & tones

createContentGenerationAudience

createContentGenerationAudience(
  input: CreateContentGenerationAudienceInput!
): ContentGenerationAudience!

Returns: ContentGenerationAudience!

Arguments:

Argument	Type	Default	Description
input	CreateContentGenerationAudienceInput!

updateContentGenerationAudience

updateContentGenerationAudience(
  input: UpdateContentGenerationAudienceInput!
): ContentGenerationAudience!

Returns: ContentGenerationAudience!

Arguments:

Argument	Type	Default	Description
input	UpdateContentGenerationAudienceInput!

deleteContentGenerationAudience

deleteContentGenerationAudience(
  input: DeleteContentGenerationAudienceInput!
): Boolean!

Returns: Boolean!

Arguments:

Argument	Type	Default	Description
input	DeleteContentGenerationAudienceInput!

createContentGenerationBrandVoice

createContentGenerationBrandVoice(
  input: CreateContentGenerationBrandVoiceInput!
): ContentGenerationBrandVoice!

Returns: ContentGenerationBrandVoice!

Arguments:

Argument	Type	Default	Description
input	CreateContentGenerationBrandVoiceInput!

updateContentGenerationBrandVoice

updateContentGenerationBrandVoice(
  input: UpdateContentGenerationBrandVoiceInput!
): ContentGenerationBrandVoice!

Returns: ContentGenerationBrandVoice!

Arguments:

Argument	Type	Default	Description
input	UpdateContentGenerationBrandVoiceInput!

deleteContentGenerationBrandVoice

deleteContentGenerationBrandVoice(
  input: DeleteContentGenerationBrandVoiceInput!
): Boolean!

Returns: Boolean!

Arguments:

Argument	Type	Default	Description
input	DeleteContentGenerationBrandVoiceInput!

createContentGenerationTone

createContentGenerationTone(
  input: CreateContentGenerationToneInput!
): ContentGenerationTone!

Returns: ContentGenerationTone!

Arguments:

Argument	Type	Default	Description
input	CreateContentGenerationToneInput!

updateContentGenerationTone

updateContentGenerationTone(
  input: UpdateContentGenerationToneInput!
): ContentGenerationTone!

Returns: ContentGenerationTone!

Arguments:

Argument	Type	Default	Description
input	UpdateContentGenerationToneInput!

deleteContentGenerationTone

deleteContentGenerationTone(
  input: DeleteContentGenerationToneInput!
): Boolean!

Returns: Boolean!

Arguments:

Argument	Type	Default	Description
input	DeleteContentGenerationToneInput!

Examples

createContentGenerationExample

createContentGenerationExample(
  input: CreateContentGenerationExampleInput!
): ContentGenerationExample!

Returns: ContentGenerationExample!

Arguments:

Argument	Type	Default	Description
input	CreateContentGenerationExampleInput!

updateContentGenerationExample

updateContentGenerationExample(
  input: UpdateContentGenerationExampleInput!
): ContentGenerationExample!

Returns: ContentGenerationExample!

Arguments:

Argument	Type	Default	Description
input	UpdateContentGenerationExampleInput!

deleteContentGenerationExample

deleteContentGenerationExample(
  input: DeleteContentGenerationExampleInput!
): Boolean!

Returns: Boolean!

Arguments:

Argument	Type	Default	Description
input	DeleteContentGenerationExampleInput!

createContentGenerationExampleFolder

createContentGenerationExampleFolder(
  input: CreateContentGenerationExampleFolderInput!
): ContentGenerationExampleFolder!

Returns: ContentGenerationExampleFolder!

Arguments:

Argument	Type	Default	Description
input	CreateContentGenerationExampleFolderInput!

updateContentGenerationExampleFolder

updateContentGenerationExampleFolder(
  input: UpdateContentGenerationExampleFolderInput!
): ContentGenerationExampleFolder!

Returns: ContentGenerationExampleFolder!

Arguments:

Argument	Type	Default	Description
input	UpdateContentGenerationExampleFolderInput!

deleteContentGenerationExampleFolder

deleteContentGenerationExampleFolder(
  input: DeleteContentGenerationExampleFolderInput!
): Boolean!

Returns: Boolean!

Arguments:

Argument	Type	Default	Description
input	DeleteContentGenerationExampleFolderInput!

Jobs & models

submitContentGenerationJob

This mutation uses Amplience Credits.

Submits a content generation job and returns the details of the submitted job. Full LLM text response retrievable without streaming, by accessing the job.

Best for programmatic access to an LLM.

Consumes Amplience credits.

Labs preview.

See also: Mutations that use Amplience Credits

submitContentGenerationJob(
  input: SubmitContentGenerationJobInput!
): ContentGenerationJob!

Returns: ContentGenerationJob!

Arguments:

Argument	Type	Default	Description
input	SubmitContentGenerationJobInput!

enableContentGenerationModel

enableContentGenerationModel(
  input: EnableContentGenerationModelInput!
): Boolean!

Returns: Boolean!

Arguments:

Argument	Type	Default	Description
input	EnableContentGenerationModelInput!

disableContentGenerationModel

disableContentGenerationModel(
  input: DisableContentGenerationModelInput!
): Boolean!

Returns: Boolean!

Arguments:

Argument	Type	Default	Description
input	DisableContentGenerationModelInput!

Text & SEO generation

generateRichText

This mutation uses Amplience Credits.

See also: Mutations that use Amplience Credits

generateRichText(
  input: RichTextGenerationInput!
): RichTextGenerationTicket

Returns: RichTextGenerationTicket

Arguments:

Argument	Type	Default	Description
input	RichTextGenerationInput!

generateSEOText

This mutation uses Amplience Credits.

See also: Mutations that use Amplience Credits

generateSEOText(
  input: SEOGenerationInput!
): SEOGenerationResponse

Returns: SEOGenerationResponse

Arguments:

Argument	Type	Default	Description
input	SEOGenerationInput!

Content review

submitContentReview

submitContentReview(
  input: SubmitContentReviewInput!
): SubmitContentReviewResponse!

Returns: SubmitContentReviewResponse!

Arguments:

Argument	Type	Default	Description
input	SubmitContentReviewInput!

Content flow

createContentFlow

createContentFlow(
  input: CreateContentFlowInput!
): ContentFlow!

Returns: ContentFlow!

Arguments:

Argument	Type	Default	Description
input	CreateContentFlowInput!

updateContentFlow

updateContentFlow(
  input: UpdateContentFlowInput!
): ContentFlow!

Returns: ContentFlow!

Arguments:

Argument	Type	Default	Description
input	UpdateContentFlowInput!

deleteContentFlow

deleteContentFlow(
  input: DeleteContentFlowInput!
): Boolean!

Returns: Boolean!

Arguments:

Argument	Type	Default	Description
input	DeleteContentFlowInput!

runContentFlow

runContentFlow(
  input: RunContentFlowInput!
): String!

Returns: String!

Arguments:

Argument	Type	Default	Description
input	RunContentFlowInput!

testContentFlow

testContentFlow(
  input: RunContentFlowInput!
): String!

Returns: String!

Arguments:

Argument	Type	Default	Description
input	RunContentFlowInput!

cancelContentFlowRun

cancelContentFlowRun(
  input: CancelContentFlowRunInput!
): Boolean!

Returns: Boolean!

Arguments:

Argument	Type	Default	Description
input	CancelContentFlowRunInput!

setContentFlowStatus

setContentFlowStatus(
  input: SetContentFlowStatusInput!
): Boolean!

Returns: Boolean!

Arguments:

Argument	Type	Default	Description
input	SetContentFlowStatusInput!