Inputs: Content generation

GraphQL input types for content generation, content flow, content review, video transcoding, and AI image tools in the Amplience GraphQL Management API.

Video transcoding
Link copied!

VideoTranscodingProfileInput
Link copied!

Field	Type	Default	Description
`id`	`ID`!		ID of the asset
`profileIds`	[`ID`!]!		Ids of the video profiles

AI image tools
Link copied!

GenerateImagesFromTextInput
Link copied!

Field	Type	Default	Description
`organizationId`	`ID`!
`model`	GenerateImagesFromTextModel
`prompt`	`String`!
`size`	`String`!
`numberOfImages`	`Int`

MagicEraseImageJobInput
Link copied!

Field	Type	Default	Description
`organizationId`	`ID`!
`imageUrl`	`String`!
`maskUrl`	`String`!

RemoveBackgroundFromImageInput
Link copied!

Field	Type	Default	Description
`organizationId`	`ID`!		Organization ID
`imageUrl`	`String`!		Image URL

GenerateCaptionForImageInput
Link copied!

Field	Type	Default	Description
`organizationId`	`ID`!
`imageUrl`	`String`!
`params`	`String`

FindPointsOfInterestInImageInput
Link copied!

Field	Type	Default	Description
`organizationId`	`ID`!
`imageUrl`	`String`!
`thingsToFind`	[`String`!]!

PointsOfInterestInImageInput
Link copied!

Field	Type	Default	Description
`organizationId`	`ID`!
`imageUrl`	`String`!
`hints`	[`String`!]

Content generation
Link copied!

CreateContentGenerationAudienceInput
Link copied!

Field	Type	Default	Description
`cmsHubId`	`String`!
`label`	`String`!
`ageRangeMin`	`Int`!
`ageRangeMax`	`Int`!
`gender`	`String`!
`description`	`String`

UpdateContentGenerationAudienceInput
Link copied!

Field	Type	Default	Description
`id`	`ID`!
`label`	`String`!
`ageRangeMin`	`Int`!
`ageRangeMax`	`Int`!
`gender`	`String`!
`description`	`String`

DeleteContentGenerationAudienceInput
Link copied!

Field	Type	Default	Description
`id`	`ID`!

CreateContentGenerationBrandVoiceInput
Link copied!

Field	Type	Default	Description
`cmsHubId`	`String`!
`label`	`String`!
`brandName`	`String`
`locale`	ContentGenerationBrandVoiceLocale!
`tone`	`ID`
`brandValues`	[UpdateContentGenerationBrandVoiceValue!]!
`brandRuleExclusions`	[`String`!]!
`brandRuleSubstitutions`	[UpdateContentGenerationBrandVoiceRuleSubstitution!]!

UpdateContentGenerationBrandVoiceInput
Link copied!

Field	Type	Default	Description
`id`	`ID`!
`label`	`String`!
`brandName`	`String`
`locale`	ContentGenerationBrandVoiceLocale!
`tone`	`ID`
`brandValues`	[UpdateContentGenerationBrandVoiceValue!]!
`brandRuleExclusions`	[`String`!]!
`brandRuleSubstitutions`	[UpdateContentGenerationBrandVoiceRuleSubstitution!]!

DeleteContentGenerationBrandVoiceInput
Link copied!

Field	Type	Default	Description
`id`	`ID`!

UpdateContentGenerationBrandVoiceRuleSubstitution
Link copied!

Field	Type	Default	Description
`term`	`String`!
`substitute`	`String`!

UpdateContentGenerationBrandVoiceValue
Link copied!

Field	Type	Default	Description
`label`	`String`!
`description`	`String`!

CreateContentGenerationBriefTemplateInput
Link copied!

Field	Type	Default	Description
`defaultModelId`	`String`!
`label`	`String`!
`description`	`String`!
`imageUrl`	`String`
`category`	`String`!
`cmsHubId`	`ID`!
`inputFields`	[ContentGenerationBriefTemplateFieldInput!]!
`instructions`	`String`!

UpdateContentGenerationBriefTemplateInput
Link copied!

Field	Type	Default	Description
`defaultModelId`	`String`
`id`	`ID`!
`label`	`String`
`description`	`String`
`category`	`String`
`imageUrl`	`String`
`inputFields`	[ContentGenerationBriefTemplateFieldInput!]
`instructions`	`String`

DeleteContentGenerationBriefTemplateInput
Link copied!

Field	Type	Default	Description
`id`	`ID`!

ContentGenerationBriefTemplateFieldInput
Link copied!

Field	Type	Default	Description
`text`	ContentGenerationBriefTemplateTextFieldInput
`image`	ContentGenerationBriefTemplateImageFieldInput
`keyValue`	ContentGenerationBriefTemplateKeyValueFieldInput

ContentGenerationBriefTemplateImageFieldInput
Link copied!

Field	Type	Default	Description
`label`	`String`!
`name`	`String`!

ContentGenerationBriefTemplateKeyValueFieldInput
Link copied!

Field	Type	Default	Description
`label`	`String`!
`name`	`String`!

ContentGenerationBriefTemplateTextFieldInput
Link copied!

Field	Type	Default	Description
`label`	`String`!
`name`	`String`!
`format`	ContentGenerationBriefTemplateTextFieldFormat!

CreateContentGenerationToneInput
Link copied!

Field	Type	Default	Description
`cmsHubId`	`String`!
`label`	`String`!
`description`	`String`!

UpdateContentGenerationToneInput
Link copied!

Field	Type	Default	Description
`id`	`ID`!
`label`	`String`!
`description`	`String`!

DeleteContentGenerationToneInput
Link copied!

Field	Type	Default	Description
`id`	`ID`!

CreateContentGenerationExampleInput
Link copied!

Field	Type	Default	Description
`brandVoiceId`	`ID`!
`briefTemplateId`	`ID`!
`label`	`String`!
`briefInputs`	`String`!
`output`	`String`!
`folderId`	`ID`

UpdateContentGenerationExampleInput
Link copied!

Field	Type	Default	Description
`id`	`ID`!
`label`	`String`
`briefInputs`	`String`
`output`	`String`
`folderId`	`ID`

DeleteContentGenerationExampleInput
Link copied!

Field	Type	Default	Description
`id`	`ID`!

CreateContentGenerationExampleFolderInput
Link copied!

Field	Type	Default	Description
`brandVoiceId`	`ID`!
`briefTemplateId`	`ID`!
`parentFolderId`	`ID`
`label`	`String`!

UpdateContentGenerationExampleFolderInput
Link copied!

Field	Type	Default	Description
`id`	`ID`!
`parentFolderId`	`ID`
`label`	`String`

DeleteContentGenerationExampleFolderInput
Link copied!

Field	Type	Default	Description
`id`	`ID`!

CreateContentGenerationSessionInput
Link copied!

Field	Type	Default	Description
`label`	`String`!
`briefTemplateId`	`ID`!
`cmsHubId`	`ID`!

UpdateContentGenerationSessionInput
Link copied!

Field	Type	Default	Description
`id`	`ID`!
`label`	`String`!

DeleteContentGenerationSessionInput
Link copied!

Field	Type	Default	Description
`id`	`ID`!

SubmitContentGenerationSessionMessageInput
Link copied!

Field	Type	Default	Description
`sessionId`	`ID`!
`parentId`	`ID`
`updateSessionLabel`	`Boolean`
`organizationId`	`ID`!
`content`	ContentGenerationSessionMessageBriefContentInput!

ContentGenerationSessionMessageBriefContentInput
Link copied!

Field	Type	Default	Description
`briefInputs`	`String`!
`modelId`	`String`!
`exampleIds`	[`String`]
`images`	[ContentGenerationSessionMessageBriefContentImageInput]

ContentGenerationSessionMessageBriefContentImageInput
Link copied!

Field	Type	Default	Description
`url`	`String`!
`id`	`String`!

ContentGenerationSessionMessageTextSelectionInput
Link copied!

Field	Type	Default	Description
`text`	`String`
`start`	`Int`
`end`	`Int`

SaveContentGenerationSessionMessageTextPropertyInput
Link copied!

Field	Type	Default	Description
`pointer`	`String`!
`value`	`String`!
`messageId`	`ID`!

ScoreContentGenerationSessionMessageInput
Link copied!

Field	Type	Default	Description
`messageId`	`ID`!
`pointer`	`String`!
`score`	ContentGenerationSessionMessageScore!

GenerateEditForContentGenerationSessionMessagePropertyInput
Link copied!

Field	Type	Default	Description
`organizationId`	`ID`!
`messageId`	`ID`!
`pointer`	`String`!
`fullText`	`String`!
`prompt`	`String`!
`modelId`	`String`!
`textSelection`	ContentGenerationSessionMessageTextSelectionInput

SubmitContentGenerationJobInput
Link copied!

Field	Type	Default	Description
`organizationId`	`ID`!
`hubId`	`ID`!
`briefTemplateId`	`ID`!
`content`	ContentGenerationJobBriefContentInput!

ContentGenerationJobBriefContentInput
Link copied!

If 'modelId' is not provided it will fallback to the default model on the brief template if available. Otherwise it will fallback to the Amplience default model.

Field	Type	Default	Description
`briefInputs`	`String`!
`modelId`	`String`
`exampleIds`	[`String`]
`images`	[ContentGenerationJobBriefContentImageInput]

ContentGenerationJobBriefContentImageInput
Link copied!

Field	Type	Default	Description
`url`	`String`!
`id`	`String`!

EnableContentGenerationModelInput
Link copied!

Field	Type	Default	Description
`id`	`ID`!
`cmsHubId`	`ID`!

DisableContentGenerationModelInput
Link copied!

Field	Type	Default	Description
`id`	`ID`!
`cmsHubId`	`ID`!

RichTextGenerationInput
Link copied!

Field	Type	Default	Description
`organizationId`	`ID`!
`prompts`	[RichTextGenerationPrompt!]!

RichTextGenerationPrompt
Link copied!

Field	Type	Default	Description
`role`	RichTextGenerationRole!
`content`	`String`!

SEOGenerationInput
Link copied!

Field	Type	Default	Description
`organizationId`	`ID`!
`variants`	`Int`!
`prompts`	[SEOGenerationPrompt!]!

SEOGenerationPrompt
Link copied!

Field	Type	Default	Description
`role`	RichTextGenerationRole!
`content`	`String`!

Content review
Link copied!

SubmitContentReviewInput
Link copied!

Field	Type	Default	Description
`reviewTaskId`	`ID`!
`type`	ContentReviewType!
`comment`	`String`
`suggestedBody`	`String`

ContentReviewTaskFilterInput
Link copied!

Field	Type	Description
`status`	[ContentReviewTaskStatus!]
`tags`	[`String`!]
`attributes`	[ContentReviewTaskAttributeFilter!]
`reviewerIds`	[`ID`!]	Can be User or Team IDs
`reviewedByUserIds`	[`ID`!]
`createdDate`	DateTimeRangeInput
`expiryDate`	DateTimeRangeInput
`dueDate`	DateTimeRangeInput

ContentReviewTaskAttributeFilter
Link copied!

Field	Type	Default	Description
`key`	`String`!
`value`	`String`!

ContentReviewTaskFacetFilterInput
Link copied!

Field	Type	Description
`status`	[ContentReviewTaskStatus]
`attributes`	[ContentReviewTaskAttributeFilter!]
`reviewerIds`	[`ID`!]	Can be User or Team IDs
`createdDate`	DateTimeRangeInput
`expiryDate`	DateTimeRangeInput
`dueDate`	DateTimeRangeInput

ContentReviewTaskSearchFilterInput
Link copied!

Field	Type	Description
`status`	[ContentReviewTaskStatus]
`attributes`	[ContentReviewTaskAttributeFilter!]
`reviewerIds`	[`ID`!]	Can be User or Team IDs
`createdDate`	DateTimeRangeInput
`expiryDate`	DateTimeRangeInput
`dueDate`	DateTimeRangeInput

ContentReviewTaskSortInput
Link copied!

Field	Type	Default	Description
`key`	ContentReviewTaskSortKey!
`order`	SortOrder!

DateTimeRangeInput
Link copied!

A range of date-time values used for filtering. Both bounds are optional and inclusive.

Field	Type	Default	Description
`start`	`DateTime`		The start of the date range (inclusive). When provided without `end`, acts as an "on or after" filter.
`end`	`DateTime`		The end of the date range (inclusive). When provided without `start`, acts as an "on or before" filter.

Content flow
Link copied!

CreateContentFlowInput
Link copied!

Field	Type	Default	Description
`label`	`String`!
`description`	`String`!
`flow`	`String`!
`cmsHubId`	`ID`!

UpdateContentFlowInput
Link copied!

Field	Type	Default	Description
`id`	`ID`!
`label`	`String`
`description`	`String`
`flow`	`String`

DeleteContentFlowInput
Link copied!

Field	Type	Default	Description
`id`	`ID`!

RunContentFlowInput
Link copied!

Field	Type	Default	Description
`flowId`	`ID`!
`label`	`String`
`flow`	`String`
`trigger`	RunContentFlowTriggerInput!
`attributes`	[RunContentFlowAttributeInput!]!
`tags`	[`String`!]!

RunContentFlowAttributeInput
Link copied!

Field	Type	Default	Description
`key`	`String`!
`value`	`String`!

RunContentFlowTriggerInput
Link copied!

Field	Type	Default	Description
`actionId`	`String`!
`portName`	`String`!
`payload`	`String`

CancelContentFlowRunInput
Link copied!

Field	Type	Default	Description
`id`	`ID`!

SetContentFlowStatusInput
Link copied!

Field	Type	Default	Description
`id`	`ID`!
`status`	ContentFlowStatus!

Video transcodingLink copied!

VideoTranscodingProfileInputLink copied!

AI image toolsLink copied!

GenerateImagesFromTextInputLink copied!

MagicEraseImageJobInputLink copied!

RemoveBackgroundFromImageInputLink copied!

GenerateCaptionForImageInputLink copied!

FindPointsOfInterestInImageInputLink copied!

PointsOfInterestInImageInputLink copied!

Content generationLink copied!

CreateContentGenerationAudienceInputLink copied!

UpdateContentGenerationAudienceInputLink copied!

DeleteContentGenerationAudienceInputLink copied!

CreateContentGenerationBrandVoiceInputLink copied!

UpdateContentGenerationBrandVoiceInputLink copied!

DeleteContentGenerationBrandVoiceInputLink copied!

UpdateContentGenerationBrandVoiceRuleSubstitutionLink copied!

UpdateContentGenerationBrandVoiceValueLink copied!

CreateContentGenerationBriefTemplateInputLink copied!

UpdateContentGenerationBriefTemplateInputLink copied!

DeleteContentGenerationBriefTemplateInputLink copied!

ContentGenerationBriefTemplateFieldInputLink copied!

ContentGenerationBriefTemplateImageFieldInputLink copied!

ContentGenerationBriefTemplateKeyValueFieldInputLink copied!

ContentGenerationBriefTemplateTextFieldInputLink copied!

CreateContentGenerationToneInputLink copied!

UpdateContentGenerationToneInputLink copied!

DeleteContentGenerationToneInputLink copied!

CreateContentGenerationExampleInputLink copied!

UpdateContentGenerationExampleInputLink copied!

DeleteContentGenerationExampleInputLink copied!

CreateContentGenerationExampleFolderInputLink copied!

UpdateContentGenerationExampleFolderInputLink copied!

DeleteContentGenerationExampleFolderInputLink copied!

CreateContentGenerationSessionInputLink copied!

UpdateContentGenerationSessionInputLink copied!

DeleteContentGenerationSessionInputLink copied!

SubmitContentGenerationSessionMessageInputLink copied!

ContentGenerationSessionMessageBriefContentInputLink copied!

ContentGenerationSessionMessageBriefContentImageInputLink copied!

ContentGenerationSessionMessageTextSelectionInputLink copied!

SaveContentGenerationSessionMessageTextPropertyInputLink copied!

ScoreContentGenerationSessionMessageInputLink copied!

GenerateEditForContentGenerationSessionMessagePropertyInputLink copied!

SubmitContentGenerationJobInputLink copied!

ContentGenerationJobBriefContentInputLink copied!

ContentGenerationJobBriefContentImageInputLink copied!

EnableContentGenerationModelInputLink copied!

DisableContentGenerationModelInputLink copied!

RichTextGenerationInputLink copied!

RichTextGenerationPromptLink copied!

SEOGenerationInputLink copied!

SEOGenerationPromptLink copied!

Content reviewLink copied!

SubmitContentReviewInputLink copied!

ContentReviewTaskFilterInputLink copied!

ContentReviewTaskAttributeFilterLink copied!

ContentReviewTaskFacetFilterInputLink copied!

ContentReviewTaskSearchFilterInputLink copied!

ContentReviewTaskSortInputLink copied!

DateTimeRangeInputLink copied!

Content flowLink copied!

CreateContentFlowInputLink copied!

UpdateContentFlowInputLink copied!

DeleteContentFlowInputLink copied!

RunContentFlowInputLink copied!

RunContentFlowAttributeInputLink copied!

RunContentFlowTriggerInputLink copied!

CancelContentFlowRunInputLink copied!

SetContentFlowStatusInputLink copied!