OBJECT
Mutations
link GraphQL Schema definition
- type Mutations {
- # UpdateUserPreference Mutation to update a User's preference settings
- #
- # Arguments
- # defaultLlm: [Not documented]
- # id: [Not documented]
- (: String, : ID!): UpdateUserPreference
- # UpdateMyUserPreference Mutation to update the currently logged in User's
- # preference settings
- #
- # Arguments
- # defaultLlm: [Not documented]
- (: String): UpdateMyUserPreference
- # Arguments
- # projectId: [Not documented]
- # title: [Not documented]
- (: ID!, : String!): CreateSuggestion
- # Arguments
- # projectId: [Not documented]
- # suggestionId: [Not documented]
- (: ID!, : ID!): DeleteSuggestion
- # Arguments
- # projectId: [Not documented]
- (: ID!): DeleteAllSuggestions
- # Arguments
- # projectId: [Not documented]
- # suggestionId: [Not documented]
- (: ID!, : ID!): ApplySuggestion
- # Arguments
- # projectId: [Not documented]
- # storyTextId: [Not documented]
- (: ID!, : ID): GenerateSuggestion
- # Arguments
- # agentId: [Not documented]
- # agentResults: [Not documented]
- # errors: [Not documented]
- # id: [Not documented]
- # inputTokensUsed: [Not documented]
- # outputTokensUsed: [Not documented]
- # processTime: [Not documented]
- # status: [Not documented]
- # statusMessage: [Not documented]
- (
- : String,
- : String,
- : String,
- : ID!,
- : Int,
- : Int,
- : Int,
- : String,
- : String
- ): UpdateAgentTask
- # Arguments
- # id: [Not documented]
- (: ID!): DeleteAgentTask
- # Arguments
- # id: [Not documented]
- (: ID!): ResetAgentTask
- # RegisterAuthorStyle Mutation to create a new AuthorStyle
- #
- # Arguments
- # archived: [Not documented]
- # isGlobal: [Not documented]
- # name: [Not documented]
- # promptText: [Not documented]
- (
- : Boolean,
- : Boolean,
- : String!,
- : String!
- ): RegisterAuthorStyle
- # DeleteAuthorStyle Mutation to delete an AuthorStyle
- #
- # Arguments
- # id: [Not documented]
- (: ID!): Boolean
- # UpdateAuthorStyle Mutation to update an Author Style's name or prompt text
- #
- # Arguments
- # archived: [Not documented]
- # id: [Not documented]
- # isGlobal: [Not documented]
- # name: [Not documented]
- # promptText: [Not documented]
- (
- : Boolean,
- : ID!,
- : Boolean,
- : String,
- : String
- ): UpdateAuthorStyle
- # Arguments
- # priceId: [Not documented]
- (: String!): UpdateSubscription
- # Arguments
- # country: [Not documented]
- # email: [Not documented]
- # name: [Not documented]
- # phone: [Not documented]
- # token: [Not documented]
- (
- : String,
- : String,
- : String,
- : String,
- : String!
- ): UpdatePaymentMethod
- # RegisterUser Mutation to create a new User
- #
- # Arguments
- # email: [Not documented]
- # firstName: [Not documented]
- # lastName: [Not documented]
- # password: [Not documented]
- (
- : String!,
- : String,
- : String,
- : String!
- ): RegisterUser
- # DeleteUser Mutation to delete a User
- #
- # Arguments
- # id: [Not documented]
- (: ID!): Boolean
- # UpdateUser Mutation to update a User's email or password
- #
- # Arguments
- # email: [Not documented]
- # firstName: [Not documented]
- # id: [Not documented]
- # lastName: [Not documented]
- # password: [Not documented]
- (
- : String,
- : String,
- : ID!,
- : String,
- : String
- ): UpdateUser
- # UpdateMe Mutation to update the currently logged in User's account settings
- #
- # Arguments
- # email: [Not documented]
- # firstName: [Not documented]
- # lastName: [Not documented]
- # password: [Not documented]
- (: String, : String, : String, : String): UpdateMe
- # Arguments
- # email: [Not documented]
- # password: [Not documented]
- (: String!, : String!): LoginMutation
- : LogoutMutation
- : SendEmailVerificationMutation
- # Arguments
- # code: [Not documented]
- (: String!): VerifyEmailMutation
- # Arguments
- # email: [Not documented]
- (: String!): PasswordResetRequestMutation
- # Arguments
- # email: [Not documented]
- # newPassword: [Not documented]
- # resetCode: [Not documented]
- (: String!, : String!, : String!): PasswordResetMutation
- # Arguments
- # provider: [Not documented]
- (: String!): SocialLoginMutation
- # Arguments
- # code: [Not documented]
- # provider: [Not documented]
- (: String!, : String!): FinalizeSocialLoginMutation
- # Arguments
- # projectId: [Not documented]
- # sceneKey: [Not documented]
- # scriptTextId: [Not documented]
- # versionNumber: [Not documented]
- (
- : ID!,
- : ID!,
- : ID,
- : Int
- ): RebaseScriptText
- # Arguments
- # projectId: [Not documented]
- # sceneKey: [Not documented]
- # scriptTextId: [Not documented]
- # versionLabel: [Not documented]
- # versionNumber: [Not documented]
- (
- : ID!,
- : ID!,
- : ID,
- : String!,
- : Int
- ): UpdateScriptTextVersionLabel
- # Arguments
- # projectId: [Not documented]
- # sceneTextId: [Not documented]
- # textContent: [Not documented]
- # textId: [Not documented]
- # textNotes: [Not documented]
- (
- : ID!,
- : ID!,
- : String,
- : ID!,
- : String
- ): UpdateScriptText
- # Arguments
- # authorStyleId: [Not documented]
- # includeBeatSheet: [Not documented]
- # projectId: [Not documented]
- # sceneKey: [Not documented]
- # sceneTextId: [Not documented]
- # screenplayFormat: [Not documented]
- # scriptDialogFlavorId: [Not documented]
- # styleGuidelineId: [Not documented]
- # textId: [Not documented]
- (
- : ID,
- : Boolean,
- : ID!,
- : ID!,
- : ID!,
- : Boolean,
- : ID,
- : ID,
- : ID!
- ): GenerateScriptTextFromScene
- # Arguments
- # authorStyleId: [Not documented]
- # includeBeatSheet: [Not documented]
- # projectId: [Not documented]
- # sceneKey: [Not documented]
- # screenplayFormat: [Not documented]
- # scriptDialogFlavorId: [Not documented]
- # selectTextEnd: [Not documented]
- # selectTextStart: [Not documented]
- # styleGuidelineId: [Not documented]
- # textId: [Not documented]
- # textNotes: [Not documented]
- (
- : ID,
- : Boolean,
- : ID!,
- : ID!,
- : Boolean,
- : ID,
- : Int,
- : Int,
- : ID,
- : ID!,
- : String
- ): GenerateScriptTextWithNotes
- # Arguments
- # authorStyleId: [Not documented]
- # projectId: [Not documented]
- # sceneKey: [Not documented]
- # sceneTextId: [Not documented]
- # screenplayFormat: [Not documented]
- # scriptDialogFlavorId: [Not documented]
- # styleGuidelineId: [Not documented]
- (
- : ID,
- : ID!,
- : ID!,
- : ID!,
- : Boolean,
- : ID,
- : ID
- ): GenerateScriptAndBeatSheet
- # Arguments
- # metadata: [Not documented]
- # textSeed: [Not documented]
- # title: [Not documented]
- (
- : ProjectMetadataInput,
- : String,
- : String!
- ): CreateProject
- # Arguments
- # metadata: [Not documented]
- # projectId: [Not documented]
- # title: [Not documented]
- (
- : ProjectMetadataInput,
- : ID!,
- : String
- ): UpdateProject
- # Arguments
- # projectId: [Not documented]
- (: ID!): ArchiveProject
- # Arguments
- # projectId: [Not documented]
- (: ID!): RestoreProject
- # Arguments
- # projectId: [Not documented]
- (: ID!): CloneProject
- # Arguments
- # locationOrderAfter: [Not documented]
- # name: [Not documented]
- # projectId: [Not documented]
- # textSeed: [Not documented]
- (
- : Int,
- : String!,
- : ID!,
- : String
- ): CreateLocationProfile
- # Arguments
- # newLocationOrder: [Not documented]
- # projectId: [Not documented]
- # textId: [Not documented]
- (: Int!, : ID!, : ID!): ReorderLocation
- # Arguments
- # locationKey: [Not documented]
- # projectId: [Not documented]
- (: String!, : ID!): DeleteLocationByKey
- # Arguments
- # locationKey: [Not documented]
- # locationProfileId: [Not documented]
- # projectId: [Not documented]
- # versionNumber: [Not documented]
- (
- : String,
- : ID,
- : ID!,
- : Int
- ): RebaseLocationProfile
- # Arguments
- # locationKey: [Not documented]
- # locationProfileId: [Not documented]
- # projectId: [Not documented]
- # versionLabel: [Not documented]
- # versionNumber: [Not documented]
- (
- : String,
- : ID,
- : ID!,
- : String!,
- : Int
- ): UpdateLocationVersionLabel
- # Arguments
- # name: [Not documented]
- # projectId: [Not documented]
- # textContent: [Not documented]
- # textId: [Not documented]
- # textNotes: [Not documented]
- # textSeed: [Not documented]
- (
- : String,
- : ID!,
- : String,
- : ID!,
- : String,
- : String
- ): UpdateLocationProfile
- # Arguments
- # projectId: [Not documented]
- # textId: [Not documented]
- # textSeed: [Not documented]
- (
- : ID!,
- : ID!,
- : String
- ): GenerateLocationFromSeed
- # Arguments
- # projectId: [Not documented]
- # selectTextEnd: [Not documented]
- # selectTextStart: [Not documented]
- # textId: [Not documented]
- # textNotes: [Not documented]
- (
- : ID!,
- : Int,
- : Int,
- : ID!,
- : String
- ): GenerateLocationWithNotes
- # RegisterStyleGuideline Mutation to create a new StyleGuideline
- #
- # Arguments
- # archived: [Not documented]
- # isGlobal: [Not documented]
- # name: [Not documented]
- # promptText: [Not documented]
- (
- : Boolean,
- : Boolean,
- : String!,
- : String!
- ): RegisterStyleGuideline
- # DeleteStyleGuideline Mutation to delete an StyleGuideline
- #
- # Arguments
- # id: [Not documented]
- (: ID!): Boolean
- # UpdateStyleGuideline Mutation to update an Style Guideline's name or prompt text
- #
- # Arguments
- # archived: [Not documented]
- # id: [Not documented]
- # isGlobal: [Not documented]
- # name: [Not documented]
- # promptText: [Not documented]
- (
- : Boolean,
- : ID!,
- : Boolean,
- : String,
- : String
- ): UpdateStyleGuideline
- # RegisterScriptDialogFlavor Mutation to create a new ScriptDialogFlavor
- #
- # Arguments
- # archived: [Not documented]
- # isGlobal: [Not documented]
- # name: [Not documented]
- # promptText: [Not documented]
- (
- : Boolean,
- : Boolean,
- : String!,
- : String!
- ): RegisterScriptDialogFlavor
- # DeleteScriptDialogFlavor Mutation to delete an ScriptDialogFlavor
- #
- # Arguments
- # id: [Not documented]
- (: ID!): Boolean
- # UpdateScriptDialogFlavor Mutation to update an Script Dialog Flavor's name or
- # prompt text
- #
- # Arguments
- # archived: [Not documented]
- # id: [Not documented]
- # isGlobal: [Not documented]
- # name: [Not documented]
- # promptText: [Not documented]
- (
- : Boolean,
- : ID!,
- : Boolean,
- : String,
- : String
- ): UpdateScriptDialogFlavor
- # Arguments
- # priceId: [Not documented]
- (: String!): UpdateInvoice
- # RegisterPromptTemplate Mutation to create a new PromptTemplate
- #
- # Arguments
- # name: [Not documented]
- # promptText: [Not documented]
- # referenceKey: [Not documented]
- (
- : String!,
- : String!,
- : String!
- ): RegisterPromptTemplate
- # DeletePromptTemplate Mutation to delete an PromptTemplate
- #
- # Arguments
- # id: [Not documented]
- (: ID!): Boolean
- # UpdatePromptTemplate Mutation to update an Prompt Template's name or prompt text
- #
- # Arguments
- # id: [Not documented]
- # name: [Not documented]
- # promptText: [Not documented]
- # referenceKey: [Not documented]
- (
- : ID!,
- : String,
- : String,
- : String!
- ): UpdatePromptTemplate
- # Arguments
- # active: [Not documented]
- # beatSheetPrompt: [Not documented]
- # name: [Not documented]
- # orderRank: [Not documented]
- # sceneTextPrompt: [Not documented]
- # scriptTextPrompt: [Not documented]
- # storyTextPrompt: [Not documented]
- (
- : Boolean,
- : String,
- : String!,
- : Int,
- : String,
- : String,
- : String
- ): CreateMagicNoteCritic
- # Arguments
- # active: [Not documented]
- # beatSheetPrompt: [Not documented]
- # criticId: [Not documented]
- # name: [Not documented]
- # orderRank: [Not documented]
- # sceneTextPrompt: [Not documented]
- # scriptTextPrompt: [Not documented]
- # storyTextPrompt: [Not documented]
- (
- : Boolean,
- : String,
- : ID!,
- : String,
- : Int,
- : String,
- : String,
- : String
- ): UpdateMagicNoteCritic
- # Arguments
- # criticId: [Not documented]
- (: ID!): DeleteMagicNoteCritic
- # Arguments
- # criticIds: [Not documented]
- # documentId: [Not documented]
- # documentType: [Not documented]
- # projectId: [Not documented]
- (
- : [ID],
- : ID!,
- : String!,
- : ID!
- ): GenerateMagicNotes
- # Arguments
- # documentId: [Not documented]
- # documentType: [Not documented]
- # projectId: [Not documented]
- (
- : ID!,
- : String!,
- : ID!
- ): GenerateExpansiveNotes
- # Arguments
- # projectId: [Not documented]
- # storyTextId: [Not documented]
- # versionNumber: [Not documented]
- (: ID!, : ID, : Int): RebaseStoryText
- # Arguments
- # projectId: [Not documented]
- # storyTextId: [Not documented]
- # versionLabel: [Not documented]
- # versionNumber: [Not documented]
- (
- : ID!,
- : ID,
- : String!,
- : Int
- ): UpdateStoryVersionLabel
- # Arguments
- # projectId: [Not documented]
- # textContent: [Not documented]
- # textId: [Not documented]
- # textNotes: [Not documented]
- # textSeed: [Not documented]
- (
- : ID!,
- : String,
- : ID!,
- : String,
- : String
- ): UpdateStoryText
- # Arguments
- # projectId: [Not documented]
- # textId: [Not documented]
- # textSeed: [Not documented]
- (
- : ID!,
- : ID!,
- : String
- ): GenerateStoryFromSeed
- # Arguments
- # projectId: [Not documented]
- # selectTextEnd: [Not documented]
- # selectTextStart: [Not documented]
- # textId: [Not documented]
- # textNotes: [Not documented]
- (
- : ID!,
- : Int,
- : Int,
- : ID!,
- : String
- ): GenerateStoryWithNotes
- # Arguments
- # characterOrderAfter: [Not documented]
- # name: [Not documented]
- # projectId: [Not documented]
- # textSeed: [Not documented]
- (
- : Int,
- : String!,
- : ID!,
- : String
- ): CreateCharacterProfile
- # Arguments
- # newCharacterOrder: [Not documented]
- # projectId: [Not documented]
- # textId: [Not documented]
- (
- : Int!,
- : ID!,
- : ID!
- ): ReorderCharacter
- # Arguments
- # characterKey: [Not documented]
- # projectId: [Not documented]
- (: String!, : ID!): DeleteCharacterByKey
- # Arguments
- # characterKey: [Not documented]
- # characterProfileId: [Not documented]
- # projectId: [Not documented]
- # versionNumber: [Not documented]
- (
- : String,
- : ID,
- : ID!,
- : Int
- ): RebaseCharacterProfile
- # Arguments
- # characterKey: [Not documented]
- # characterProfileId: [Not documented]
- # projectId: [Not documented]
- # versionLabel: [Not documented]
- # versionNumber: [Not documented]
- (
- : String,
- : ID,
- : ID!,
- : String!,
- : Int
- ): UpdateCharacterVersionLabel
- # Arguments
- # name: [Not documented]
- # projectId: [Not documented]
- # textContent: [Not documented]
- # textId: [Not documented]
- # textNotes: [Not documented]
- # textSeed: [Not documented]
- (
- : String,
- : ID!,
- : String,
- : ID!,
- : String,
- : String
- ): UpdateCharacterProfile
- # Arguments
- # projectId: [Not documented]
- # textId: [Not documented]
- # textSeed: [Not documented]
- (
- : ID!,
- : ID!,
- : String
- ): GenerateCharacterFromSeed
- # Arguments
- # projectId: [Not documented]
- # selectTextEnd: [Not documented]
- # selectTextStart: [Not documented]
- # textId: [Not documented]
- # textNotes: [Not documented]
- (
- : ID!,
- : Int,
- : Int,
- : ID!,
- : String
- ): GenerateCharacterWithNotes
- # Arguments
- # beatSheetId: [Not documented]
- # projectId: [Not documented]
- # sceneKey: [Not documented]
- # versionNumber: [Not documented]
- (
- : ID,
- : ID!,
- : ID!,
- : Int
- ): RebaseBeatSheet
- # Arguments
- # beatSheetId: [Not documented]
- # projectId: [Not documented]
- # sceneKey: [Not documented]
- # versionLabel: [Not documented]
- # versionNumber: [Not documented]
- (
- : ID,
- : ID!,
- : ID!,
- : String!,
- : Int
- ): UpdateBeatSheetVersionLabel
- # Arguments
- # projectId: [Not documented]
- # sceneTextId: [Not documented]
- # textContent: [Not documented]
- # textId: [Not documented]
- # textNotes: [Not documented]
- (
- : ID!,
- : ID!,
- : String,
- : ID!,
- : String
- ): UpdateBeatSheet
- # Arguments
- # authorStyleId: [Not documented]
- # projectId: [Not documented]
- # sceneKey: [Not documented]
- # sceneTextId: [Not documented]
- # screenplayFormat: [Not documented]
- # scriptDialogFlavorId: [Not documented]
- # styleGuidelineId: [Not documented]
- # textId: [Not documented]
- (
- : ID,
- : ID!,
- : ID!,
- : ID!,
- : Boolean,
- : ID,
- : ID,
- : ID!
- ): GenerateBeatSheetFromScene
- # Arguments
- # authorStyleId: [Not documented]
- # projectId: [Not documented]
- # sceneKey: [Not documented]
- # screenplayFormat: [Not documented]
- # scriptDialogFlavorId: [Not documented]
- # selectTextEnd: [Not documented]
- # selectTextStart: [Not documented]
- # styleGuidelineId: [Not documented]
- # textId: [Not documented]
- # textNotes: [Not documented]
- (
- : ID,
- : ID!,
- : ID!,
- : Boolean,
- : ID,
- : Int,
- : Int,
- : ID,
- : ID!,
- : String
- ): GenerateBeatSheetWithNotes
- # Arguments
- # projectId: [Not documented]
- # sceneOrderAfter: [Not documented]
- # textSeed: [Not documented]
- # title: [Not documented]
- (
- : ID!,
- : Int,
- : String,
- : String!
- ): CreateSceneText
- # Arguments
- # newSceneOrder: [Not documented]
- # projectId: [Not documented]
- # textId: [Not documented]
- (: Int!, : ID!, : ID!): ReorderScene
- # Arguments
- # projectId: [Not documented]
- # sceneKey: [Not documented]
- (: ID!, : String!): DeleteSceneByKey
- # Arguments
- # projectId: [Not documented]
- # sceneKey: [Not documented]
- # sceneTextId: [Not documented]
- # versionNumber: [Not documented]
- (
- : ID!,
- : String,
- : ID,
- : Int
- ): RebaseSceneText
- # Arguments
- # projectId: [Not documented]
- # sceneKey: [Not documented]
- # sceneTextId: [Not documented]
- # versionLabel: [Not documented]
- # versionNumber: [Not documented]
- (
- : ID!,
- : String,
- : ID,
- : String!,
- : Int
- ): UpdateSceneVersionLabel
- # Arguments
- # projectId: [Not documented]
- # textContent: [Not documented]
- # textId: [Not documented]
- # textNotes: [Not documented]
- # textSeed: [Not documented]
- # title: [Not documented]
- (
- : ID!,
- : String,
- : ID!,
- : String,
- : String,
- : String
- ): UpdateSceneText
- # Arguments
- # projectId: [Not documented]
- # textId: [Not documented]
- # textSeed: [Not documented]
- (
- : ID!,
- : ID!,
- : String
- ): GenerateSceneFromSeed
- # Arguments
- # projectId: [Not documented]
- # selectTextEnd: [Not documented]
- # selectTextStart: [Not documented]
- # textId: [Not documented]
- # textNotes: [Not documented]
- (
- : ID!,
- : Int,
- : Int,
- : ID!,
- : String
- ): GenerateSceneWithNotes
- # Arguments
- # projectId: [Not documented]
- # sceneCount: [Not documented]
- # storyTextId: [Not documented]
- (
- : ID!,
- : Int,
- : ID!
- ): GenerateMakeScenes
- # UpdatePlatformSetting Mutation to update a platform setting's value.
- #
- # Arguments
- # key: [Not documented]
- # value: [Not documented]
- (: String!, : String!): UpdatePlatformSetting
- }
link Require by
This element is not required by anyone