API Documentation
Admin
- POSTChange account iser id of particular account
- POSTChange owner iser id of particular account
- POSTGet Iser account details
- POSTUpdate Iser account details
- POSTGets the list of all accounts
- POSTGet all pending adjudications (Verb | Conjunction | Displaymode)
- POSTGet adjudication count
- POSTGets a specific agreement by ID.
- POSTGet all agreements by filter params.
- POSTGets agreement by Code.
- POSTGet all agreements list params.
- POSTSaves a new legal agreement.
- POSTRestores a specific agreement by ID.
- POSTGet all previous versions of a specific agreement history ID.
- POSTGets the details of AI Model types by Id
- POSTAI treatments assign a labels
- POSTAI treatments unassign a labels
- POSTGets all image detections for a specific media ID.
- POSTGets all image detections by filter params.
- POSTPerforms an ad-hoc image detection on a specific MediaID.
- POSTGets the details of AI Model types by Id
- POSTSaves or updates the AIModelType and its value
- POSTSaves/sets a single ai model's possible utilization across all utilization types.
- POSTSaves/sets a single ai model utilization with a specific desired percentage usage value.
- POSTGets the list of all AI Model types
- POSTGets the list ai platforms
- POSTSaves or updates the AIPlatform and its value
- POSTRetrieves AI prompts by filter params
- POSTRetrieves the LLM AI call history
- POSTSaves the AI Prompts and its value
- POSTRetrieves AI prompts Version by filter params
- POSTRestores a previous version of a dynamic AI prompt
- POSTGet alternate image treatment summary info by media log id
- POSTGet image treatment detail by media log id
- POSTGet image treatment detail by media id
- POSTGet image treatments by origin media id
- POSTDelete the failed item for image treatments.
- POSTFilters the failed atempts for image treatments.
- POSTGet list of all ImageGenreReleaseMediaLog
- POSTGet list of all ImageGenreReleaseMediaLog by date
- POSTGet list of all ImageGenreReleaseMediaLog by image-genre
- POSTFilter the list of ImageGenreReleaseMediaLog
- POSTPurge the ImageGenreRelease MediaLog
- POSTGets the list of Usage Type
- POSTGenerate notify template with Auth0 liquid syntax translations, based on the HTML snippet and Shared Notify Template.
- POSTGet the Shared Notify Template.
- POSTSave changes to the Shared Notify Template.
- POSTDelete the candidate list.
- POSTSave the list of words within candidate list.
- POSTGets the word candidate list
- POSTFilter categories.
- POSTAssign the children to category.
- POSTRemoves the child(ren) categories from a given category.
- POSTAdd new category
- POSTDelete the category
- POSTGets the details of category
- POSTGets the list of Parent category
- POSTAssign the parent to category.
- POSTListing categories that are pending, awaiting approval
- POSTDeletes and replaces a category with another one.
- POSTUpdates the category
- POSTGet concat details
- POSTAllows admins to feature an ism and pair it instantly with an image genre release ID in one click.
- POSTAllows admins to perform extremely limited updates to concats such as featuring them.
- POSTListing conjunctions that are pending, awaiting approval
- POSTFilter the stories
- POSTReturn all information required for Admin Dashboard Adjudication Feed page
- POSTReturn all information required for Admin Dashboard Generation Feed page
- POSTReturn all information required for Admin Dashboard Moderation Feed page
- POSTGet DB cache table statistics
- POSTDisplayMode status approve.
- POSTDisplayMode Image Genre status approve.
- POSTDisplayMode Image Genre limited update by admin.
- POSTMake generic, limited, and exposure related updates to the data relating to a display mode from the admin side.
- POSTRejects a display mode release.
- POSTRestores a display mode release to active status.
- POSTSuspends a display mode release.
- POSTGet list of DMCA Request
- POSTSave DMCA Request.
- POSTGet all Editions where verb and conjunctions are proposed.
- POSTGets a list of all API endpoint areas
- POSTGets a list of all API endpoints
- POSTSaves an admin comment for a given entity
- POSTDe-escalates an entity by ID and type.
- POSTGet all details for a verb|conjunction|word.
- POSTEscalates an entity by ID and type.
- POSTGets all activity for any entity
- POSTReturns the history data for an entity
- POSTEntity label save
- POSTEntity label filter
- POSTPerforms a moderation event on an entity.
- POSTEntity restore
- POSTReturns the review Data for Entity like (Displaymode|Category|Topic|Verb|Conjunction|ExploreGroup|IsmList)
- POSTSave the review data for certain types of entities
- POSTSaves general info for a verb|conjunction|word.
- POSTEntity suspend
- POSTReturns the existing and missing rranslation data for an entity
- POSTRe translate the notify template pharse.
- POSTVerify word translations by its source and target languages.
- POSTGets the details of all exploreGroups
- POSTGets the list of all explore groups
- POSTExplore groups set item sequence.
- POSTRemoves the background image from the explore group.
- POSTGets the list of ExploreGroup items
- POSTExplore groups set sequence.
- POSTGet the exploregroup style
- POSTUpdate the exploregroup style
- POSTUpdate the exploregroup
- POSTReturns all flag types for content moderation.
- POSTGets the details of child category
- POSTGets the child of topic
- POSTGets the list of all trending categories
- POSTHome Page details
- POSTGet detailed data for a given iser.
- POSTGet the list of Search iser or word
- POSTUpdate iser details.
- POSTGet Iser account details
- POSTGets isers based on filter parameters
- POSTGets the list of all account roles for a specific iser.
- POSTAdds role(s) to a specific iser
- POSTRemoves role(s) from a specific iser
- POSTGet Isms by Filter Params
- POSTremove/delete Selected-Items from ism-list
- POSTGets all isms within an ism list
- POSTIsm list set item sequence.
- POSTRemoves the background image from the ism list.
- POSTIsm list set sequence.
- POSTUpdate Ism List Style by Id
- POSTUpdate Ism List history by id.
- POSTReturns the list of job runs by filter
- POSTReturns the count of job runs by filter, but grouped by date.
- POSTReturns the count of job runs by filter, but grouped by date and potentially type.
- POSTReturns the list of job runs log by filter
- POSTReturns the list of job runs by calendar period type by filter
- POSTReturns the list of job runs type by filter
- POSTGet list of all Language Family
- POSTGet all language with pagination
- POSTGet language details
- POSTSave or update language details
- POSTVendor call log filter
- POSTVendor call log filter
- POSTFeature a media item.
- POSTUnfeature a media item
- POSTReturn all information required for Admin Queue Adjudicate Feed page
- POSTCreate a Clone Notify template.
- POSTDelete a Notify template.
- POSTGet Preview for Notify Template Editor Text
- POSTFilter notify templates.
- POSTReturn the notify template by ID.
- POSTReturn the Notify template History.
- POSTReturn the Notify template History by ID.
- POSTDelete the Notify Template phrase.
- POSTGet dependent Notify Template list for particular Phrase
- POSTGet list of all Phrases for Notify Template
- POSTSubmit words for Re translation for selected languages.
- POSTCreate Notify Template Merge Field.
- POSTGet the Notify template's phrase translation by ID.
- POSTNotify template Restore.
- POSTSaves the new or updated template
- POSTSends the notify template preview to the Iser.
- POSTSend the notify template over Email.
- POSTGet overall Statistics of concat details
- POSTGet all the trending items, both paired and unpaired.
- POSTSave pairing headlineIsm.
- POSTSave pairing
- POSTSave pairing
- POSTSave a Permission.
- POSTGets the list of all permission groups.
- POSTGets the list of all permission.
- POSTReturn all information required for Admin Queue Adjudicate Feed page
- POSTRole Iser Add.
- POSTPermission Add To Role.
- POSTPermission Remove To Role.
- POSTSave a Role.
- POSTGets the list of all roles in the system.
- POSTGet all the scores
- POSTSave score
- POSTFilter the stories
- POSTFilter the stories
- POSTReturn all information required for Admin System Performance.
- POSTReturn all information required for Admin System Performance Statistics.
- POSTGet a Particular API Call details.
- POSTGet Average API Elapsed Time
- POSTClear Cache of particular APIs
- POSTGets all support ticket categories
- POSTGets the details of iser ticket
- POSTGet list of support tickets
- POSTSave ticket details
- POSTAssign the children to the topic.
- POSTRemoves the child(ren) topics from a given topic.
- POSTCreates the new Topic
- POSTDelete the topic
- POSTGets the details of topic
- POSTAssign the parent to topic.
- POSTListing topics that are pending, awaiting approval
- POSTDeletes and replaces a topic with another one.
- POSTUpdate the topic
- POSTGets the list of all topics
- POSTReset translation registry cached counts
- POSTDelete Translation Registry
- POSTGets the details of a specific translation registry.
- POSTGet list of translation registry by filter
- POSTGets the translation registry available tables.
- POSTGets the integer columns for a given language translation table.
- POSTGets the available string translatable columns for a given language translation table.
- POSTTranslation registry item type code get
- POSTGets/filters the list of pending items to be translated
- POSTTranslate pending items
- POSTSave Translation Registry
- POSTDelete Translations in Translation Registry
- POSTGets the translation source for a given record.
- POSTSaves/overrides a value for a single translation
- POSTSaves/overrides a value for a single translation with a specific word or phrase other than what was translated.
- POSTSets a record as being the new translation source for the rest of the translations to be derived from.
- POSTDelete all non origin Translations in Translation Registry
- POSTGet list of translations in translation registry by filter
- POSTVendor type filter
- POSTListing verbs that are pending, awaiting approval
- POSTGet adjudications verb settings
- POSTCreate a clone word rule.
- POSTDelete word usage rule details
- POSTSave or update word usage rule details
- POSTGets the list supplied words usage rule
- POSTSave the word.
- POSTGet definition for word
- POSTGet details for word
- POSTGet example for word
- POSTGet Synonyms for word
- POSTGets the list of all words
Auth
- POSTSends a new password to change user's old password.
- POSTCheck if email and/or phone number exists.
- POSTCreates an url to open Login for social media providers.
- POSTCreates an url to open signup for social media providers.
- POSTLogin call.
- POSTGets and refresh a new access token for remember me functionality.
- POSTSends an email for the forgot password step.
- POSTSends an text message through sms service for the forgot password step.
- POSTSign up call.
- POSTGets access token to Login using social media providers.
- POSTGets access token to signup using social media providers.
- POSTVerify sms service text code for the forgot password step.
Candidates
- POSTGets a filterable list of all AI Model types.
- POSTConcat candidate convert and post.
- POSTConcat candidate convert to draft.
- POSTGets a filterable list of all emotion types.
- POSTKicks off secondary calls to continue generating new candidate concats for a given generation event ID.
- POSTFilters already-generated candidate concats by specific seed stage IDs.
- POSTFilters already-created generation events by specific filter criterion.
- POSTConcat candidate hide
- POSTAdds a related seed stage to an existing generation event.
- POSTGets or generates related seed stages by specific filter criterion.
Categories
- POSTGets a list of categories which match the input text.
- POSTAdds a new category, if parent category id is null then the category inserted will be parent, if not, then it's a child category.
- POSTGets the featured categories.
- POSTFilter categories.
- POSTGets the category hierarchy and topics associated to the category
Comments
Concats
- POSTGet concat details including child isms and all associated media
- POSTGet alternate items for the specified concat (e.g. NFTs are Expensive -> NFTs are dumb, NFTs are TheFuture, etc).
- POSTAssign a concat to a category
- POSTLink an existing ism to a concat.
- POSTAssign media usage right for particular concat.
- POSTAssign a categorys to concat
- POSTAuto Assign categories to a concat
- POSTRemove category from concat
- POSTChaining a concat will create a new draft concat with a pointer to the Chain-To concat.
- POSTReturns the central concat feed, for chained to concats by slug.
- POSTGet list of concat categorywise.
- POSTGet concat details including child isms and all associated media using Slug
- POSTGet concat or ism details by a slug
- POSTGet concat corner data
- POSTGet corner details by corner wise.
- POSTDelete draft concat by Iser.
- POSTReturns the central concat feed, used on the home page and elsewhere.
- POSTReturns the central concat feed, for the slug of a category, topic, word, or word-combination used on the home page and elsewhere.
- POSTFork a concat to clone it, ready to be edited.
- POSTHide iser concat.
- POSTGet list media those are connected to pertucular concat.
- POSTGet list of concat medias.
- POSTAllows an iser to 'plus-ism' the specified concat.
- POSTSaves a concat along with its child isms and returns the newly created concat along with its id Also post/publish the concat
- POSTGet concat feed for this iser, ordered by highest ranked, descending.
- POSTGet related items for the specified concat.
- POSTGet related items for a series of concats, each with their own optional display mode release ID.
- POSTRemove media from a concat.
- POSTReorders media within isms and concats.
- POSTReorders news articles within isms and concats.
- POSTSaves a concat and returns the newly created concat along with its id.
- POSTSaves a concat along with its child isms and returns the newly created concat along with its id.
- POSTEdit concat or ism as schedule by Iser.
- POSTUnschedule ism or concat by Iser.
- POSTGet Selected template and update concatId with that template
- POSTSet Concat Corner data
- POSTSet cover image of concat.
- POSTSet cover image of concat.
- POSTGet concat style by concat code.
- POSTRemoving a background image and removing the style records at the same time.
- POSTReset concat style.
- POSTSet concat background image.
- POSTReset concat style.
- POSTSave concat style.
- POSTSaves multiple concat style.
- POSTGet list of draft concats with formatting templates.
- POSTToggle corner visibility on or off.
- POSTTo unchain the Concat.
- POSTAllows an iser to 'un-plus' the specified concat.
- GETGets the default settings for the feed filter, including last used settings by this iser.
- POSTGet content like verb, conjunction, position1, position2 most used.
Conjunction Types
Countries
Display Modes
- POSTGet display mode animation types.
- POSTGets the details for a display mode ID.
- POSTRemove display mode filler object of type 'media'.
- POSTSave display mode filler object of type 'media'.
- POSTSave display mode filler object of type 'media' from a public image URL.
- POSTdisplay mode filler objects by filter
- POSTRemove display mode filler object.
- POSTSave display mode filler object.
- POSTSave display mode filler object of type 'svg'.
- POSTRemove display mode filler pattern.
- POSTSave display mode filler pattern.
- POSTSave display mode filler pattern.
- POSTdisplay mode filler patterns by filter
- POSTGets display modes based on filters.
- POSTGets Image Genre Release details.
- POSTGets Image Genre releases based on filters.
- POSTImage genre releases used in display mode list
- POSTFor an AI-generated video, the completed webhook callback is received here and save to database and cache.
- POSTGets all action config entries for a given image genre release ID.
- POSTDeletes a single action configuration entry for an Image Genre Release ID.
- POSTGet action config settings value
- POSTDisplay mode Image-Genre Action-Config Prompt Auto-complete
- POSTEnriches a prompt with more detail, based on an existing typed phrase.
- POSTSaves one (or many) action configuration entries for an Image Genre Release ID.
- POSTDelete image genre action config template group
- POSTFilter image genre action config template group
- POSTSave image genre action config template group
- POSTGet a set of applicable images with same detected types of an image genre release's action config template.
- POSTDelete image genre action config template
- POSTdisplay mode image genre action config template by filter
- POSTGenerates image treatment tests for a specific action config template.
- POSTSave image genre action config template
- POSTGet the random images (media items) for use in testing an image genre release's action configs.
- POSTAssigns an image genre to a display mode release.
- POSTAttach images to Image-Genre
- POSTDisplay mode Image Genre Clone
- POSTDeactivates an image genre for a given display mode.
- POSTGets Image Genre details.
- POSTGet display mode detected type groups data.
- POSTGet display mode detected types data.
- POSTGets Image Genre based on filters.
- POSTGet the data for Image Genre insert objects.
- POSTGet image genre groups data.
- POSTGets the created or altered image for this concat using a specified image genre.
- POSTRetrieves images already processed for a given image genre ID, based on filter params.
- POSTPerform the actual processing of an image against all active action configs of a single image genre release.
- POSTGenerate a created or altered image for this concat using a specified image genre.
- POSTGenerate a created or altered image for this concat using a comma-delimited list of multiple image genres.
- POSTDisplay mode image genre name availability check
- POSTCreates a real-time image genre image to preview its outcome.
- POSTSave image genre prompts.
- POSTCreate image genre release
- POSTGet Image genre release versions details.
- POSTGet all Render Effect Type.
- POSTSave image genre data.
- POSTGet image genre settings data.
- POSTSubmit Image Genre with checks.
- POSTUnassigns any assigned image genre from a specific display mode release.
- POSTImage genres used in display mode list
- POSTGet image genre Version History.
- POSTGets the created or altered image for this concat under the image genre of a specific display mode.
- POSTGenerate a created or altered image for this concat under the image genre of a specified display mode.
- POSTGenerate a created or altered image for this concat under the image genre of a comma-delimited list of display modes.
- POSTCreate a new release for a given display mode.
- POSTGets the details for a display mode release ID.
- POSTGets display mode releases based on filters.
- POSTSave display mode release style data.
- POSTGet display mode release style data.
- POSTGet display mode release versions details
- POSTCreate or update display mode with limited details.
- POSTSave display mode media designations.
- POSTSave display mode media ReleaseNotes.
- POSTReassign media to Display Mode Slots.
- POSTCreate new slot.
- POSTSave new slot with an initial media item attached to it.
- POSTSave new slot with an initial style attached to it.
- POSTSave new slot style.
- POSTRemoves display mode slot style(s) based on slot style type IDs.
- POSTReset/clear a given display mode slot styles.
- POSTGet display mode all slots with styles.
- POSTGet display mode Status.
- POSTUpdate display mode Status.
- POSTRemove display mode style.
- POSTRemove display mode style.
- POSTSubmit display mode with checks.
- POSTGet Display mode usage.
- POSTGet display mode Version History.
- POSTGets all widgets.
Editions
- POSTGets a list of all configured featured items for an edition.
- POSTAssigns the specific isms within isms for the intro sequence to leverage.
- POSTAdd Entity in Edition Config.
- POSTRemove Entity in Edition Config.
- POSTDelete all entries for a certain edition and a certain config type
- POSTGets a list of all editions filtered by language.
Entity
Explore Groups
Filters
Help Content
- POSTHelp content article associate.
- POSTGet the list of help content article attached based on filter params.
- POSTDelete help content article.
- POSTGet help content article details by ID.
- POSTHelp content article disassociate.
- POSTGet the list of help content article exposure area based on filter params.
- POSTGet the list of help content article based on filter params.
- POSTSave help content article.
- POSTGet Help Content Categories.
- POSTSave help content category.
Isers
- POSTCheck If Social Media account exists or not.
- POSTRetrieves activity for a given iser.
- POSTSave latest agreement information.
- POSTGet latest pending agreement for acceptance.
- POSTAdded Iser alert.
- POSTList of All alerted Iser.
- POSTRemoved Iser alert.
- POSTAssign handle to particular Iser.
- POSTDownload iser bill.
- POSTTo block the particular Iser.
- POSTReturns a list of Blocked Iser for particular iser.
- POSTAssign a list of categories to an iser.
- POSTUnassign any assigned categories from a iser.
- POSTRetrieves the current iser's concats, filtering by status, text, and language.
- POSTGet iser details.
- POSTGet iser details.
- POSTGet iser details.
- POSTGets display mode releases authored by the current iser.
- POSTGets display modes authored by the current iser.
- POSTAdded Iser Favorite.
- POSTList of All Favorite Iser.
- POSTRemoved Iser Favorite.
- POSTGet candidate words for iser profile.
- POSTDelete follow words for iser profile.
- POSTGet follow words for iser profile.
- POSTFollow words for iser profile.
- POSTSave follow words for iser profile.
- POSTUnfollow words for iser profile.
- POSTGet Iser Editor Rules.
- POSTGets user information.
- POSTGet limited data for a given iser.
- POSTGets user information.
- POSTCheck If Iser handle already exists or not.
- POSTGets image genre authored by the current iser.
- POSTRegisters a new iser using the specified parameters
- POSTGet iser details.
- POSTGet Iser Notification Settings.
- POSTGets the original items (isms and concats) created by the specified isers (one or many), and returns one set of data for all of them combined.
- POSTGets the original items (isms and concats) created by the specified isers (one or many), and returns an array of isers, each with their own set of original items.
- POSTGet iser details.
- POSTGet Iser list of Iser Plans.
- POSTGets the plus'd items (isms and concats) that the specified iser has plus-ism'd.
- POSTGet iser details.
- GETGet list of available handles for a given user email alias.
- POSTGets recent searches for the current iser.
- POSTClear Iser all recent search.
- POSTRetrieves a list of *all* isers that the current iser has recently interacted with somehow from the history log data.
- POSTRetrieves a list of isers that the current iser has recently interacted with somehow based on a filter mode parameter, from the actual root data.
- POSTRemove media like avatar and background images from iser.
- POSTSave Iser Editor Rules.
- POSTSave Iser Notification Settings.
- POSTGets list of isers by search text.
- POSTSends an email for the verification of a new user.
- GETSends an text message for the verification step.
- POSTGets the Iser settings.
- POSTSaves the Iser settings.
- POSTGet iser details.
- POSTGet iser details.
- GETGet iser details.
- POSTGet a text based avatar from specified initials
- POSTGet Total Isms of the Iser.
- POSTTo unblock the particular Blocked Iser.
- POSTUpdate iser details.
- POSTVerify text code for the verification step.
Isms
- POSTGet ism details including all associated media
- POSTGet alternate items for the specified ism (e.g. NFTs are Expensive -> NFTs are dumb, NFTs are TheFuture, etc).
- POSTAssign media usage right for particular ism.
- POSTClaims a pre-created ism (1-liner) as an 'original' and posts it on behalf of that iser as a concat.
- POSTDelete draft ism by Iser.
- POSTGet ism details including all associated media
- POSTGet list of structured Isms and Concats for a Given position 1 text that the user typed in
- POSTFunction for getting related ism position 1 text.
- POSTFunction for getting related ism position 2 text.
- POSTSaves & Publish an ism and returns the newly created ism along with its id.
- POSTGet related items for the specified ism.
- POSTFunction for getting related ism in position 1 or 2.
- POSTRemove media from an Ism.
- POSTSaves an ism and returns the newly created ism along with its id.
- POSTSet cover image of ism.
- POSTSave a single style for a specific ism within a specific concat.
- POSTGets all style entries for a specific ism within a specific concat.
- POSTResets all style entries for a specific ism within a specific concat.
- POSTSave an array of styles for a specific ism within a specific concat.
- POSTAutocomplete and suggestion function for ism position 1 and position 2 text from AI.
- POSTAutocomplete and suggestion function for ism position 1 and position 2 text from the database.
- POSTAssign media to ism.
- POSTAssign media to ism.
Ism Lists
- POSTDelete a Ism List.
- POSTFilter Ism List.
- POSTGet Details by Slug for Ism List.
- POSTAdds a single item into a given ism list.
- POSTAdds multiple items into a given ism list.
- POSTDelete an ism from a Ism List.
- POSTReorder an ism from the Ism List.
- POSTSaving new Ism List.
- POSTGet ism style by ism list id.
- POSTSaves multiple ism list style.
Languages
Link Previews
Media
- GETGet list media extensions those are allowed to media.
- POSTAssigns an SVG file to a specific entity (explore group, ism list, etc).
- POSTGenerates prompts that can be used to generate AI based images for concat slugs.
- POSTGenerates prompts that can be used to generate AI based images for a given display mode release.
- POSTGenerates prompts that can be used to generate AI based images for a given generic use case.
- POSTGenerates ai-based images for a given prompt.
- POSTRemove an SVG file from a specific entity (explore group, ism list, etc).
- POSTConverts the chunk-saved media item(s) into a database record for specific entity types.
- POSTConverts the chunk-saved image/video into a (static) blob-storage file and database record.
- POSTConverts the chunk-saved SVG item into a database record.
- POSTSearch for emojis for the ism.
- POSTSearch for gifs for the ism.
- POSTSearch for images for the ism.
- POSTSearch for stickers for the ism.
- POSTSearch for svg for the ism.
- POSTSearch for videos for the ism.
- POSTSaves a new media item (in chunks) for the specified ism, concat, or iser.
- POSTSaves a thumbnail media item (in chunks) for the specified media.
- POSTDelete a static media item (image)
- POSTMedia static get by filter
- POSTSave a SVG file
- POSTUploads and saves an SVG file.
News
- POSTAttach news articles to concat.
- POSTRemove news articles from concat
- POSTSearch news entities by entity type and ID.
- POSTAttach news articles to ism.
- POSTRemove news articles from ism
- POSTPreview news articles.
- POSTGet all recents news articles.
- POSTClear recents news articles.
- POSTClear all recents news articles.
- POSTSearch a list of news articles.
- POSTNews translate.
Public
- POSTGets agreement by Code.
- POSTGet all agreements list params.
- POSTPublic version of the filtering of already-generated candidate concats by specific seed stage IDs.
- POSTPublic version of the Kicks off secondary calls to continue generating new candidate concats for a given generation event ID.
- POSTPublic version of the filtering of already-created generation events by specific filter criterion.
- POSTPublic version of the featured categories API call
- POSTpublic gets the category hierarchy and topics associated to the category.
- POSTPublic version of the concat for chained to by slug.
- POSTPublic version of the comments for a concat.
- POSTPublic version of the concat/feed API call, used for non-authenticated preview experiences on the home page.
- POSTPublic version of the concat/feed-by-slug API call, used for non-authenticated preview experiences on the home page.
- POSTPublic version of the concat/concat-details-by-slug API call, Get concat details including child isms and all associated media using Slug
- POSTPublic version of get related items for a series of concats, each with their own optional display mode release ID.
- POSTPublic version of gets display modes based on filters.
- POSTPublic Save DMCA Request
- POSTRetrieves the public edition-based configuration data used to showcase isms on the public external site.
- POSTRetrieves only the absolute minimum required public edition-based configuration data to load isms on the external site.
- POSTPublic help content articles details.
- POSTPublic help content articles filter.
- POSTPublic help content categories.
- POSTpublic get follow words for iser profile.
- POSTPublic version of gets the original items (isms and concats) created by the specified isers (one or many).
- POSTpublic Retrieves a list of isers that the current iser has recently interacted with somehow based on a filter mode parameter, from the actual root data.
- POSTpublic Get a link preview for the specified url.
- POSTpublic Saves a link preview for the specified url under a specific ism or concat.
- POSTPublic version of the explore/nav-items API call, used for non-authenticated preview experiences on the home page.
- POSTpublic Search news entities by entity type and ID.
- POSTpublic Preview news articles.
- POSTpublic Search a list of news articles.
- POSTGet related items for the specified concat, for use on the publicly accessible concat detail page.
- POSTpublic Perform a search of all types of content passing in a single text phrase.
- POSTGenerates a public session token that can be used for just a few very limited, public (unauthenticated) API calls.
- POSTPublic version of gets the trending items.
PushNotifications
Stacks
- POSTAdd a Concat to a Stack.
- POSTStack details with all Concat present.
- POSTCreate a new Stack.
- POSTDelete a Stack.
- POSTDelete a Concat in Stack.
- POSTEdit a Stack name.
- POSTList all stacks for the current iser.
- POSTMove concats from one stack to another.
- POSTSearches within an iser's stacks for a given text or specific stack itself.
Styles
- POSTDeletes a font family.
- POSTReturns an array of font families.
- POSTSaves a font family.
- POSTDelete fonts attachments.
- POSTConverts the chunk-saved font attachment file (typically a PDF file) into a generic blob-storage file and database record.
- POSTGet fonts attachments by filter.
- POSTDelete fonts.
- POSTGet fonts details.
- POSTGet fonts files by filter.
- POSTSave fonts.
- POSTSaves a reference URL for a given Font.
- POSTDelete fonts file.
- POSTConverts the chunk-saved font file (otf, ttf, woff, woff2, etc) into a (static) blob-storage file and database record.
- POSTReturns an array of font types for a given font family.
- POSTReturns an array of gradient families.
- POSTReturns an array of gradient families.
Style Templates
Timezones
Topics
Trending
public Perform a search of all types of content passing in a single text phrase.
Copy
curl --request POST \
--url https://api.example.com/public/search/combo-search \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"publicSessionToken": "<string>",
"languageID": 1,
"page": 1,
"pageSize": 10,
"searchWordOrPhrase": "cats",
"constrainByEntityTypes": null,
"constrainByEditions": null,
"constrainByIsmLines": null,
"constrainByIsmIDs": null,
"constrainByConcatIDs": null,
"constrainByHasChains": false,
"sortBy": "popularity"
}
'Copy
{
"success": true,
"data": "<unknown>"
}Public
public Perform a search of all types of content passing in a single text phrase.
public Returns matching concats, topics, words, isers, concats, and isms. This is used in many places in the app, including the backend admin dashboard.
ConstrainByEntityTypes: (string)
A comma-delimited list of entity type IDs to constrain the results by. Example: ‘1,5,6’ for Category, Word, and Iser.
-
1 = Category -
2 = Topic -
5 = Word -
6 = Iser -
7 = Concat -
8 = Ism -
14 = Display Mode
Leave null to omit and return all types.
SortBy: (string)
A string value of either:
'popularity''date''trending'Leave null to omit and it will use the default (popularity).
ConstrainByIsmLines: (string)
A comma-delimited list of integers (‘1,2,3’, etc) to constrain the concat results by. Used only if you are interested in getting back concats with a specific number of isms. Leave null to omit and return concats with all numbers of isms.
POST
/
public
/
search
/
combo-search
public Perform a search of all types of content passing in a single text phrase.
Copy
curl --request POST \
--url https://api.example.com/public/search/combo-search \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"publicSessionToken": "<string>",
"languageID": 1,
"page": 1,
"pageSize": 10,
"searchWordOrPhrase": "cats",
"constrainByEntityTypes": null,
"constrainByEditions": null,
"constrainByIsmLines": null,
"constrainByIsmIDs": null,
"constrainByConcatIDs": null,
"constrainByHasChains": false,
"sortBy": "popularity"
}
'Copy
{
"success": true,
"data": "<unknown>"
}Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Body
application/json
Get related items for the specified concat, for use on the publicly accessible concat detail page.Generates a public session token that can be used for just a few very limited, public (unauthenticated) API calls.
⌘I