![](\"https://lh7-us.googleusercontent.com/FkFTYC06AAQUn2_cUYnjYwDckDLYYAxw2XmkrRUW6b7TPS0krypXivE0BpFLZUAnMf2UMd54nc5qCJQ7TiKNt-FBT-9faCI9T5MPyKVfpL8_bK3eMmETzfS5tsFFhH0LtbSNylDxgRHeh7_G-M2CSOE\")
\n\nThe Powerbeans player is the flagship product of Powerbeans. It consists of an AI solution for any editorial online publisher to transform their already existing content into Audio in a simple way, while providing the user with the option to consume the full content or a summary.
\nThe player was conceived with an API-first approach to allow the developers around the world to make the most out of it.
\nThe main concepts to learn before getting started are:
\nPublisher: The entity behind a website where the player will be implemented. (Example: CNN)
\nSite: The entity that represents the website itself, a domain or subdomain. (Example: https://cnnespanol.cnn.com )
\nContent: Any article that the player is implemented on. The content should be unique based on its URL. (Example: https://cnnespanol.cnn.com/2024/01/11/estados-unidos-ataques-aereos-hutes-iran-yemen-trax/)
\nPowerbeans Publisher API gives the publisher different endpoints to manage their content, including creating new audios, retreive generated summaries and full-article audios, regenerate content texts and summaries.
\nBase URL of the API:
\nhttps://api.powerbeans-ai.com/private\n\nThe Powerbeans team will generate and provide you with a PRIVATE API KEY for each site where the player is set up.
\nThe API KEY is tied to the publisher and a site. This means that the scope of the requests is limited to that site.
\n\n\nIt's important not to confuse this key with the PUBLIC API KEY provided to be used in the player.
\n
There are two ways of adding the API KEY to the API calls:
\nQuery parameter: https://api.powerbeans-ai.com/private/...?apiKey={{API_KEY}}
\nHeader: add a header x-api-key with the API KEY as the value.
\nRate limits are restrictions that our API imposes on the number of times you can access our services within a specified period of time.
\nRate limits are imposed at the API KEY level, not publisher level.
\nThe current rate limit is 500 req/sec.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"1. Introduction","slug":"1-introduction"},{"content":"2. Authorization","slug":"2-authorization"},{"content":"3. Rate limit","slug":"3-rate-limit"}],"owner":"33953332","collectionId":"68359411-b3fe-4bcf-915a-026646a07d76","publishedId":"2sA35HXMFC","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"19E852"},"publishDate":"2024-04-11T12:00:49.000Z"},"item":[{"name":"Site","item":[{"name":"Update Site Description","id":"aca9dcc6-77cf-4f8c-9156-56c8982d8155","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"description\": \"Some description\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.powerbeans-ai.com/private/site","description":"This endpoint allows you to update the description for a specific site.
\ndescription (string, default: \"\"): description of the site. Used mostly for identification purposes.The response for this request is the site updated with the new description.
\n{\n \"_id\": string, // Id of the site updated \n \"publisherId\": string, // Id of the publisher associated to the site\n \"url\": string, // Url of the site\n \"description\": string, // Description of the site\n \"createdAt\": string, // Date of site creation\n \"updatedAt\": string, // Date of last time the site data was updated\n \"configuration\": { // Configurations of the sites\n \"checkSummaryBeforeAudioGeneration\": boolean,\n \"replaceDictionaryUrl\": string, \n \"replaceNumbersWithTexts\": boolean,\n \"disableSummaryInPlayer\": boolean,\n \"autoGenerateSummaryText\": boolean,\n \"autoGenerateSummaryAudio\": boolean,\n \"autoGenerateFullAudio\": boolean,\n \"enableCompanionBanner\": boolean,\n \"disableMultipleVoices\": boolean,\n \"contentLengthLimitsInChars\": {\n \"min\": number,\n \"max\": number\n },\n \"_id\": \"660848545e52d851ff020cc1\"\n }\n}\n\nThis endpoint allows you to update the updatable fields and configuration of the publisher site
\n{\n \"description\": \"string\",\n \"configuration\": {\n \"checkSummaryBeforeAudioGeneration\": \"boolean\",\n \"replaceNumbersWithTexts\": \"boolean\",\n \"contentLengthLimitsInChars\": {\n \"min\": \"number\",\n \"max\": \"number\"\n },\n \"autoGenerateFullAudio\": \"boolean\",\n \"autoGenerateSummaryText\": \"boolean\",\n \"autoGenerateSummaryAudio\": \"boolean\"\n \"textElements\": {\n \"en\": {\n \"toggleSummaryText\": \"string\",\n \"toggleFullContentText\": \"string\",\n \"onlySummaryText\": \"string\",\n \"onlyFullContentText\": \"string\",\n \"listenTo\": \"string\",\n \"extraLabel\": \"string\"\n }\n }\n }\n}\n\nThe response for this request is the site updated with the new config.
\n{\n \"_id\": \"string\", // ID of the site\n \"publisherId\": \"string\", // ID of the publisher\n \"url\": \"string\", // URL of the site\n \"description\": \"string\", // Description of the site\n \"createdAt\": \"string\", // Creation timestamp\n \"updatedAt\": \"string\", // Last update timestamp\n \"configuration\": {\n \"checkSummaryBeforeAudioGeneration\": \"boolean\", // Whether to check summary before audio generation\n \"replaceDictionaryUrl\": \"string\", // URL of the dictionary for replacement\n \"replaceNumbersWithTexts\": \"boolean\", // Whether to replace numbers with text\n \"disableSummaryInPlayer\": \"boolean\", // Whether to disable summary in the player\n \"autoGenerateSummaryText\": \"boolean\", // Whether to auto-generate summary text\n \"autoGenerateSummaryAudio\": \"boolean\", // Whether to auto-generate summary audio\n \"autoGenerateFullAudio\": \"boolean\", // Whether to auto-generate full audio\n \"autoGenerateContentFor\": \"array\", // Array of content types for auto-generation\n \"enableCompanionBanner\": \"boolean\", // Whether to enable a companion banner\n \"preventAnyFullAudioGeneration\": \"boolean\", // Whether to prevent any full audio generation\n \"disableMultipleVoices\": \"boolean\", // Whether to disable multiple voices\n \"disableSummaryLink\": \"boolean\", // Whether to disable the summary link\n \"defaultOriginalLanguage\": \"string|null\", // Default original language, null if not set\n \"defaultVoiceName\": \"string|null\", // Default voice name, null if not set\n \"scrapingIntegration\": {\n \"enabled\": \"boolean\" // Whether scraping integration is enabled\n },\n \"contentLengthLimitsInChars\": {\n \"min\": \"number\", // Minimum content length in characters\n \"max\": \"number\" // Maximum content length in characters\n },\n \"textElements\": {\n \"en\": {\n \"toggleSummaryText\": \"string\", // Text for toggling summary\n \"toggleFullContentText\": \"string\", // Text for toggling full content\n \"onlySummaryText\": \"string\", // Text for only summary\n \"onlyFullContentText\": \"string\", // Text for only full content\n \"listenTo\": \"string\", // Text for listen to\n \"extraLabel\": \"string\" // Additional label text\n }\n }\n },\n \"player\": \"string\", // ID of the player\n \"defaultOriginalLanguage\": \"string\", // Default original language\n \"defaultVoiceName\": \"string\" // Default voice name\n}\n\nThis endpoint returns the details for all your sites.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apiKey"},{"key":"value","value":"{{privateApiKey}}"}]},"isInherited":true,"source":{"_postman_id":"68359411-b3fe-4bcf-915a-026646a07d76","id":"68359411-b3fe-4bcf-915a-026646a07d76","name":"Powerbeans Publisher API","type":"collection"}},"urlObject":{"protocol":"https","path":["private","sites"],"host":["api.powerbeans-ai.com"],"query":[],"variable":[]}},"response":[{"id":"129c5c04-ac72-4d69-abd1-c9c62e5b39ff","name":"200 Get Sites","originalRequest":{"method":"GET","header":[],"url":"https://api.powerbeans-ai.com/private/sites"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 30 Jul 2024 08:45:04 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"735"},{"key":"Connection","value":"keep-alive"},{"key":"Apigw-Requestid","value":"bt8yiiXQIAMEYOQ="}],"cookie":[],"responseTime":null,"body":"[\n {\n \"_id\": \"659eeb20d3d7d3e95df00e2b\",\n \"publisherId\": \"659ee92b8266a5439b779a19\",\n \"url\": \"www.rapturegrowth.com\",\n \"description\": \"Some description\",\n \"createdAt\": \"2024-01-10T19:08:16.249Z\",\n \"updatedAt\": \"2024-07-30T08:43:54.652Z\",\n \"configuration\": {\n \"checkSummaryBeforeAudioGeneration\": true,\n \"replaceDictionaryUrl\": \"https://s3.us-east-1.amazonaws.com/parrot-prod-contents/659eeb20d3d7d3e95df00e2b/replaceAudioDictionary\",\n \"replaceNumbersWithTexts\": false,\n \"disableSummaryInPlayer\": false,\n \"autoGenerateSummaryText\": true,\n \"autoGenerateSummaryAudio\": true,\n \"autoGenerateFullAudio\": true,\n \"autoGenerateContentFor\": [],\n \"enableCompanionBanner\": false,\n \"disableMultipleVoices\": false,\n \"contentLengthLimitsInChars\": {\n \"min\": 100,\n \"max\": 10000\n },\n \"_id\": \"660848545e52d851ff020cc1\"\n }\n }\n]"}],"_postman_id":"3845b2c3-eb12-496c-85e1-9544c494a95f"},{"name":"Update Replace Dictionary","id":"81db396f-6f36-4850-a291-515b72337ee3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"dictionary\": [\n {\n \"from\": \"USD\",\n \"to\": \"dólares\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.powerbeans-ai.com/private/site/dictionary","description":"This endpoint allows you to update the dictionary of replacement words to be used by the player in all of its audios within the site.
\ndictionary ({from: string, to: string}, default: [])
dictionary.from (string): word to be replaced.
dictionary.to (string): word to replace with.
The response for this request is the updated dictionary.
\n[\n {\n \"from\": string, // Word to be replaced \n \"to\": string // Word to replace with\n } \n]\n\nThis endpoint allows you to get the dictionary of replacement words to be used by the player in all of its audios within the site.
\nThe response for this request is the site updated with the new config.
\n[\n {\n \"from\": string, // Word to be replaced \n \"to\": string // Word to replace with\n \"caseSensitive\": boolean // Indicates whether the replacement should be case-sensitive\n } \n]\n\nThis is going to remove ( by content ID ) the audio data ref document from the db and also will remove the audio files from the S3 Bucket
\ncontentId (required: true): string ID of the Content Audioto be deleted.
The response for this request is the content object with the updated softRemoved property.
[\n {\n \"deletedFromS3\": { \n \"$metadata\": {\n \"httpStatusCode\": number, // HTTP status code returned from the S3 deletion request\n \"requestId\": string, // Unique request ID for the S3 deletion operation\n \"extendedRequestId\": string, // Extended request ID for additional tracing in AWS\n \"attempts\": number, // Number of attempts made for the S3 deletion request\n \"totalRetryDelay\": number // Total delay time due to retries (in milliseconds)\n },\n \"Deleted\": [\n {\n \"Key\": string // Key of the deleted object in the S3 bucket\n }\n ]\n },\n \"deletedFromRepository\": { \n \"_id\": string, // ID of the document in the repository\n \"softRemoved\": boolean, // Indicates whether the content is soft-deleted\n \"publisherId\": string, // ID of the publisher associated with the content\n \"contentId\": string, // ID of the content associated with the deletion\n \"siteId\": string, // ID of the site associated with the content\n \"voiceId\": string, // ID of the voice associated with the content\n \"language\": string, // Language of the content (e.g., \"es\" for Spanish)\n \"fullAudioUrl\": string, // URL of the full audio in the S3 bucket\n \"status\": string, // Current status of the content\n \"createdAt\": string, // Timestamp of when the content was created\n \"updatedAt\": string, // Timestamp of the last update made to the content\n \"__v\": number // Version key for document revision tracking in MongoDB\n }\n }\n]\n\nThis endpoint returns all the content of the site associated with your API KEY.
\nlimit (number, optional, max: 100): a limit on the number of objects to return, ranging between 1 and 100.
page (number, optional): the page number for paginated results. Used with the limit parameter to retrieve a specific subset of objects.
The response for this request is an array containing all of the site's content.
\n[\n {\n \"_id\": string, // Id of the content\n \"url\": string, // Url of the content\n \"originalLanguage\": string, // Language of the content (valid values: 'es', 'en)\n \"contentText\": string, // Url of the file that contains the full version in text of the content\n \"summaryText\": string, // Url of the file that contains the summary version in text of the content\n \"status\": string, // Status of the content (valid values: 'active', 'inactive'). Only active contents will display the player in the site.\n \"audios\": [ // Audios associated to the content\n {\n \"voice\": string, // Name of the voice used for the audio (example: 'Sergio')\n \"language\": \"es\", // Language of the audio\n \"summaryAudioUrl\": string, // Url of the file that contains the summary version of the content in audio, based on the summaryText\n \"fullAudioUrl\": string, // Url of the file that contains the full version of the content in audio, based on the summaryText\n }\n ],\n \"contentProcesses\": [ // Not finished processes associated to the content\n {\n \"type\": string, // Type of process (possible values: 'summary', 'summary-audio', 'full-audio') \n \"language\": string,\n \"voice\": string, // In case the process is audio-related, the voice used to fulfill the process.\n \"status\": string // Status of the process (possible values: 'pending', 'failed')\n }\n ],\n \"voiceIds\": [], // List of id for the voices used in the content\n \"categories\": [], // List of manually-provided categories associated with the content\n \"iabCategories\": [], // List of IAB categories associated with the content\n \"createdAt\": string, // Date of creation of the content\n \"updatedAt\": string // Date of last modification of the content\n }\n]\n\nThis endpoint returns the details for one or more content items requested by ID or URL.
\ncontentIds: a string of content IDs, or content url separated by commas. It accepts a maximum of 10 ids or urls.
includeProcessingAudios (boolean, optional, default: false): if true, includes in the audios array the pending audios to be processed. The audio URLs may not have content. URLs can be saved to access the audio when it's ready.
The response for this request is the content data.
\n{\n \"_id\": string, // Id of the content\n \"url\": string, // Url of the content\n \"originalLanguage\": string, // Language of the content (valid values: 'es', 'en)\n \"contentText\": string, // Url of the file that contains the full version in text of the content\n \"summaryText\": string, // Url of the file that contains the summary version in text of the content\n \"status\": string, // Status of the content (valid values: 'active', 'inactive'). Only active contents will display the player in the site.\n \"audios\": [ // Audios associated to the content\n {\n \"voice\": string, // Name of the voice used for the audio (example: 'Sergio')\n \"language\": \"es\", // Language of the audio\n \"summaryAudioUrl\": string, // Url of the file that contains the summary version of the content in audio, based on the summaryText\n \"fullAudioUrl\": string, // Url of the file that contains the full version of the content in audio, based on the summaryText\n }\n ],\n \"contentProcesses\": [ // Not finished processes associated to the content\n {\n \"type\": string, // Type of process (possible values: 'summary', 'summary-audio', 'full-audio') \n \"language\": string,\n \"voice\": string, // In case the process is audio-related, the voice used to fulfill the process.\n \"status\": string // Status of the process (possible values: 'pending', 'failed')\n }\n ],\n \"voiceIds\": [], // List of id for the voices used in the content\n \"categories\": [], // List of manually-provided categories associated with the content\n \"iabCategories\": [], // List of IAB categories associated with the content \n \"createdAt\": string, // Date of creation of the content\n \"updatedAt\": string // Date of last modification of the content\n}\n\nThis endpoint returns the summary text for a specific content.
\nThe response for this request includes some basic data of the content and the summary in plain text.
\n{\n \"_id\": string, // Id of the content\n \"url\": string, // Url of the content\n \"originalLanguage\": string, // Language of the content (valid values: 'es', 'en)\n \"summary\": string, // Generated summary in plain text of the content\n \"status\": string, // Status of the content (valid values: 'active', 'inactive'). Only active contents will display the player in the site.\n \"createdAt\": string, // Date of creation of the content\n \"updatedAt\": string // Date of last modification of the content\n}\n\nThis endpoint creates a piece of content in the system.
\nIt also will trigger the generation of the full audio , summary text and summary audio based on the request params or on the site config
\ncheckSummaryBeforeAudioGeneration (boolean): when true the summary audios won't be automatically generated for this content. Overrides the site config for this specific content.
autoGenerateFullAudio (boolean, optional): whether to autogenerate full audio or not. This param overrides the Site's configuration for this property.
autoGenerateSummaryText (boolean, optional): whether to autogenerate summary text or not. This param overrides the Site's configuration for this property.
autoGenerateSummaryAudio (boolean, optional): whether to autogenerate summary audio or not. This param overrides the Site's configuration for this property.
includeProcessingAudios (boolean, optional, default: false): if true, includes in the audios array the pending audios to be processed. The audio URLs may not have content. URLs can be saved to access the audio when it's ready.
{\n \"url\": \"https://www.example.com/post\", // string: the full URL where the player will be displayed in the site of the content to be created. Only one content can be available per URL.\n \"originalLanguage\": \"es\",// string: original language of the content. Current valid values are: \"es\" and \"en\"\n \"text\": {\n \"title\": \"\", // string: title of the content. it will be included in the full audio.\n \"content\": \"\" // string: the content in plain text. HTML is not supported, please clean the text before sending.\n },\n \"voices\": [ // the voices of the audios to have available for this content in the player. Find available voices using the Get Voi\n \"Maxi\"\n ],\n \"categories\": [\"\"] // string [], optional: content categories you can use to identify and group content. Can be used with the autoGenerateContentFor site config to select which content is selected to add the player.\n}\n\nurl (string): the full URL where the player will be displayed in the site of the content to be created. Only one content can be available per URL.
originalLanguage (string): original language of the content. Current valid values are: \"es\" and \"en\",
text.title (string): title of the content. it will be included in the full audio.
text.content (string): the content in plain text. HTML is not supported, please clean the text before sending.
voices (Voices [ ]): the voices of the audios to have available for this content in the player. Find available voices using the Get Voices endpoint.
categories (string [ ], optional): content categories you can use to identify and group content. Can be used with the autoGenerateContentFor site config to select which content is selected to add the player.
The response for this request is the content data.
\naudios may be empty at the beginning. It will be populated while the processes present in contentProcesses finish.
{\n \"_id\": string, // Id of the content\n \"url\": string, // Url of the content\n \"originalLanguage\": string, // Language of the content (valid values: 'es', 'en)\n \"contentText\": string, // Url of the file that contains the full version in text of the content\n \"summaryText\": string, // Url of the file that contains the summary version in text of the content\n \"status\": string, // Status of the content (valid values: 'active', 'inactive'). Only active contents will display the player in the site.\n \"audios\": [ // Audios associated to the content\n {\n \"voice\": string, // Name of the voice used for the audio (example: 'Sergio')\n \"language\": \"es\", // Language of the audio\n \"summaryAudioUrl\": string, // Url of the file that contains the summary version of the content in audio, based on the summaryText\n \"fullAudioUrl\": string, // Url of the file that contains the full version of the content in audio, based on the summaryText\n }\n ],\n \"contentProcesses\": [ // Not finished processes associated to the content\n {\n \"type\": string, // Type of process (possible values: 'summary', 'summary-audio', 'full-audio') \n \"language\": string,\n \"voice\": string, // In case the process is audio-related, the voice used to fulfill the process.\n \"status\": string // Status of the process (possible values: 'pending', 'failed')\n }\n ],\n \"categories\": string [], // List of categories of the content\n \"createdAt\": string, // Date of creation of the content\n \"updatedAt\": string // Date of last modification of the content\n}\n\nThis endpoint allows the bulk creation of pieces of content and triggers the generation of audios of the full content (using the provided voices), a summary text, and audios of the summary based on the query params or on the site's configuration
\ncheckSummaryBeforeAudioGeneration (boolean): when true the summary audios won't be automatically generated for this content. Overrides the site config for this specific content.
autoGenerateFullAudio (boolean, optional): whether to autogenerate full audio or not. This param overrides the Site's configuration for this property.
autoGenerateSummaryText (boolean, optional): whether to autogenerate summary text or not. This param overrides the Site's configuration for this property.
autoGenerateSummaryAudio (boolean, optional): whether to autogenerate summary audio or not. This param overrides the Site's configuration for this property.
includeProcessingAudios (boolean, optional, default: false): if true, includes in the audios array the pending audios to be processed. The audio URLs may not have content. URLs can be saved to access the audio when it's ready.
url (string): the full URL where the player will be displayed in the site of the content to be created. Only one content can be available per URL.
originalLanguage (string): original language of the content. Current valid values are: \"es\" and \"en\",
text.title (string): title of the content. it will be included in the full audio.
text.content (string): the content in plain text. HTML is not supported, please clean the text before sending.
voices (Voices [ ]): the voices of the audios to have available for this content in the player. Find available voices using the Get Voices endpoint.
categories (string [ ], optional): categories of the content.
The response for this request is the content data.
\naudios may be empty at the beginning. It will be populated while the processes present in contentProcesses finish.
{\n \"_id\": string, // Id of the content\n \"url\": string, // Url of the content\n \"originalLanguage\": string, // Language of the content (valid values: 'es', 'en)\n \"contentText\": string, // Url of the file that contains the full version in text of the content\n \"summaryText\": string, // Url of the file that contains the summary version in text of the content\n \"status\": string, // Status of the content (valid values: 'active', 'inactive'). Only active contents will display the player in the site.\n \"audios\": [ // Audios associated to the content\n {\n \"voice\": string, // Name of the voice used for the audio (example: 'Sergio')\n \"language\": \"es\", // Language of the audio\n \"summaryAudioUrl\": string, // Url of the file that contains the summary version of the content in audio, based on the summaryText\n \"fullAudioUrl\": string, // Url of the file that contains the full version of the content in audio, based on the summaryText\n }\n ],\n \"contentProcesses\": [ // Not finished processes associated to the content\n {\n \"type\": string, // Type of process (possible values: 'summary', 'summary-audio', 'full-audio') \n \"language\": string,\n \"voice\": string, // In case the process is audio-related, the voice used to fulfill the process.\n \"status\": string // Status of the process (possible values: 'pending', 'failed')\n }\n ],\n \"categories\": string [], // List of categories of the content\n \"createdAt\": string, // Date of creation of the content\n \"updatedAt\": string // Date of last modification of the content\n}\n\nThis endpoint allows you to update the content text and triggers the regeneration of summary text and audios (according to the site's configuratinon flags). The voices to be used are the ones selected using the Create Content endpoint.
\ntext.title: title of the content. It will be included in the full audio.
text.content: the content in plain text. HTML is not supported, please clean the text before sending.
The response for this request is the content data.
\n{\n \"_id\": string, // Id of the content\n \"url\": string, // Url of the content\n \"originalLanguage\": string, // Language of the content (valid values: 'es', 'en)\n \"contentText\": string, // Url of the file that contains the full version in text of the content\n \"summaryText\": string, // Url of the file that contains the summary version in text of the content\n \"status\": string, // Status of the content (valid values: 'active', 'inactive'). Only active contents will display the player in the site.\n \"audios\": [ // Audios associated to the content\n {\n \"voice\": string, // Name of the voice used for the audio (example: 'Sergio')\n \"language\": string, // Language of the audio\n \"summaryAudioUrl\": string, // Url of the file that contains the summary version of the content in audio, based on the summaryText\n \"fullAudioUrl\": string, // Url of the file that contains the full version of the content in audio, based on the summaryText\n }\n ],\n \"contentProcesses\": [ // Not finished processes associated to the content\n {\n \"type\": string, // Type of process (possible values: 'summary', 'summary-audio', 'full-audio') \n \"language\": string,\n \"voice\": string, // In case the process is audio-related, the voice used to fulfill the process.\n \"status\": string // Status of the process (possible values: 'pending', 'failed')\n }\n ],\n \"createdAt\": string, // Date of creation of the content\n \"updatedAt\": string // Date of last modification of the content\n}\n\nThis endpoint allows you to add new voices to a specific content item. Requests trigger new full and summary audios to be generated with the provided voice/s.
\nvoices (string [ ]): the voices of the audios to add to the player. Find available voices using the Get Voices endpoint.
The response for this request is the content data.
\n{\n \"_id\": string, // Id of the content\n \"url\": string, // Url of the content\n \"originalLanguage\": string, // Language of the content (valid values: 'es', 'en)\n \"contentText\": string, // Url of the file that contains the full version in text of the content\n \"summaryText\": string, // Url of the file that contains the summary version in text of the content\n \"status\": string, // Status of the content (valid values: 'active', 'inactive'). Only active contents will display the player in the site.\n \"audios\": [ // Audios associated to the content\n {\n \"voice\": string, // Name of the voice used for the audio (example: 'Sergio')\n \"language\": \"es\", // Language of the audio\n \"summaryAudioUrl\": string, // Url of the file that contains the summary version of the content in audio, based on the summaryText\n \"fullAudioUrl\": string, // Url of the file that contains the full version of the content in audio, based on the summaryText\n }\n ],\n \"contentProcesses\": [ // Not finished processes associated to the content\n {\n \"type\": string, // Type of process (possible values: 'summary', 'summary-audio', 'full-audio') \n \"language\": string,\n \"voice\": string, // In case the process is audio-related, the voice used to fulfill the process.\n \"status\": string // Status of the process (possible values: 'pending', 'failed')\n }\n ],\n \"createdAt\": string, // Date of creation of the content\n \"updatedAt\": string // Date of last modification of the content\n}\n\nThis endpoint allows you to enable and disable content. Disabled content will not display the player.
\nstatus: possible values: \"active\" and \"inactive\".
The response for this request is the content data.
\n{\n \"_id\": string, // Id of the content\n \"url\": string, // Url of the content\n \"originalLanguage\": string, // Language of the content (valid values: 'es', 'en)\n \"contentText\": string, // Url of the file that contains the full version in text of the content\n \"summaryText\": string, // Url of the file that contains the summary version in text of the content\n \"status\": string, // Status of the content (valid values: 'active', 'inactive'). Only active contents will display the player in the site.\n \"audios\": [ // Audios associated to the content\n {\n \"voice\": string, // Name of the voice used for the audio (example: 'Sergio')\n \"language\": \"es\", // Language of the audio\n \"summaryAudioUrl\": string, // Url of the file that contains the summary version of the content in audio, based on the summaryText\n \"fullAudioUrl\": string, // Url of the file that contains the full version of the content in audio, based on the summaryText\n }\n ],\n \"contentProcesses\": [ // Not finished processes associated to the content\n {\n \"type\": string, // Type of process (possible values: 'summary', 'summary-audio', 'full-audio') \n \"language\": string,\n \"voice\": string, // In case the process is audio-related, the voice used to fulfill the process.\n \"status\": string // Status of the process (possible values: 'pending', 'failed')\n }\n ],\n \"voiceIds\": [], // List of id for the voices used in the content\n \"categories\": [], // List of manually-provided categories associated with the content\n \"iabCategories\": [], // List of IAB categories associated with the content\n \"createdAt\": string, // Date of creation of the content\n \"updatedAt\": string // Date of last modification of the content\n}\n\nThis endpoint allows you to update a content’s categories. This endpoint will not trigger any content processing. if content processing is needed after the update use the Regenerate Content endpoint.
\ncategories (string [ ], optional): List of categories for the content. If present, categories sent in this property will replace previous values.
The response for this request is the updated content data.
\n{\n \"_id\": string, // Id of the content\n \"url\": string, // Url of the content\n \"originalLanguage\": string, // Language of the content (valid values: 'es', 'en)\n \"contentText\": string, // Url of the file that contains the full version in text of the content\n \"summaryText\": string, // Url of the file that contains the summary version in text of the content\n \"status\": string, // Status of the content (valid values: 'active', 'inactive'). Only active contents will display the player in the site.\n \"audios\": [ // Audios associated to the content\n {\n \"voice\": string, // Name of the voice used for the audio (example: 'Sergio')\n \"language\": \"es\", // Language of the audio\n \"summaryAudioUrl\": string, // Url of the file that contains the summary version of the content in audio, based on the summaryText\n \"fullAudioUrl\": string, // Url of the file that contains the full version of the content in audio, based on the summaryText\n }\n ],\n \"contentProcesses\": [ // Not finished processes associated to the content\n {\n \"type\": string, // Type of process (possible values: 'summary', 'summary-audio', 'full-audio') \n \"language\": string,\n \"voice\": string, // In case the process is audio-related, the voice used to fulfill the process.\n \"status\": string // Status of the process (possible values: 'pending', 'failed')\n }\n ],\n \"categories\": string [] // Content categories\n \"createdAt\": string, // Date of creation of the content\n \"updatedAt\": string // Date of last modification of the content\n}\n\nThis endpoint will generate the summary audios for the content. Summary text needs to be created previous to audio generation. This is useful if your site has the configuration checkSummaryBeforeAudioGeneration enabled.
contentId (string): ID of the content to generate summary audio for.voices (string [ ], optional): voices to generate the audios for. If not provided, it will create using the same voices as the full audio.The response for this request is the content data.
\n{\n \"_id\": string, // Id of the content\n \"url\": string, // Url of the content\n \"originalLanguage\": string, // Language of the content (valid values: 'es', 'en)\n \"contentText\": string, // Url of the file that contains the full version in text of the content\n \"summaryText\": string, // Url of the file that contains the summary version in text of the content\n \"status\": string, // Status of the content (valid values: 'active', 'inactive'). Only active contents will display the player in the site.\n \"audios\": [ // Audios associated to the content\n {\n \"voice\": string, // Name of the voice used for the audio (example: 'Sergio')\n \"language\": \"es\", // Language of the audio\n \"summaryAudioUrl\": string, // Url of the file that contains the summary version of the content in audio, based on the summaryText\n \"fullAudioUrl\": string, // Url of the file that contains the full version of the content in audio, based on the summaryText\n }\n ],\n \"contentProcesses\": [ // Not finished processes associated to the content\n {\n \"type\": string, // Type of process (possible values: 'summary', 'summary-audio', 'full-audio') \n \"language\": string,\n \"voice\": string, // In case the process is audio-related, the voice used to fulfill the process.\n \"status\": string // Status of the process (possible values: 'pending', 'failed')\n }\n ],\n \"voiceIds\": [], // List of id for the voices used in the content\n \"categories\": [], // List of manually-provided categories associated with the content\n \"iabCategories\": [], // List of IAB categories associated with the content\n \"createdAt\": string, // Date of creation of the content\n \"updatedAt\": string // Date of last modification of the content\n}\n\nThis endpoint will generate the summary text for the content based on its full content.
\nIf you want to set a custom summary text, the Force Summary Text endpoint should be used instead.
\nAudio generation will not be triggered with this endpoint. To create summary audios use the Generate Summary Audios endpoint.
\ncontentId (string): ID of the content to generate summary text for.The response for this request is the content data.
\n{\n \"softRemoved\": boolean,// Whether the Content is deleted or not \n \"publisherId\": string, // Publisher ID\n \"siteId\": string, // Site ID\n \"contentId\": string, // Id of the content\n \"type\": \"summarize\", // Type of process\n \"status\": \"created\", // Status of the process\n \"_id\": string, // Id of the summary\n \"createdAt\": string, // Date of creation of the content\n \"updatedAt\": string // Date of last modification of the content\n}\n\nThis endpoint will generate the full audios for the content.
\ncontentId (string): ID of the content to generate full audio for.
includeProcessingAudios (boolean, optional, default: false): if true, includes in the audios array the pending audios to be processed. The audio URLs may not have content. URLs can be saved to access the audio when it's ready.
The response for this request is the content data.
\n{\n \"_id\": string, // Id of the content\n \"url\": string, // Url of the content\n \"originalLanguage\": string, // Language of the content (valid values: 'es', 'en)\n \"contentText\": string, // Url of the file that contains the full version in text of the content\n \"summaryText\": string, // Url of the file that contains the summary version in text of the content\n \"status\": string, // Status of the content (valid values: 'active', 'inactive'). Only active contents will display the player in the site.\n \"audios\": [ // Audios associated to the content\n {\n \"voice\": string, // Name of the voice used for the audio (example: 'Sergio')\n \"language\": \"es\", // Language of the audio\n \"summaryAudioUrl\": string, // Url of the file that contains the summary version of the content in audio, based on the summaryText\n \"fullAudioUrl\": string, // Url of the file that contains the full version of the content in audio, based on the summaryText\n }\n ],\n \"contentProcesses\": [ // Not finished processes associated to the content\n {\n \"type\": string, // Type of process (possible values: 'summary', 'summary-audio', 'full-audio') \n \"language\": string,\n \"voice\": string, // In case the process is audio-related, the voice used to fulfill the process.\n \"status\": string // Status of the process (possible values: 'pending', 'failed')\n }\n ],\n \"createdAt\": string, // Date of creation of the content\n \"updatedAt\": string // Date of last modification of the content\n}\n\nThis endpoint will replace the summary text for the content with the one provided.
\nAudio generation will not be triggered with this endpoint. To create summary audios use the Generate Summary Audios endpoint.
\nThe response for this request is the content data.
\n{\n \"_id\": string, // Id of the content\n \"url\": string, // Url of the content\n \"originalLanguage\": string, // Language of the content (valid values: 'es', 'en)\n \"contentText\": string, // Url of the file that contains the full version in text of the content\n \"summaryText\": string, // Url of the file that contains the summary version in text of the content\n \"status\": string, // Status of the content (valid values: 'active', 'inactive'). Only active contents will display the player in the site.\n \"audios\": [ // Audios associated to the content\n {\n \"voice\": string, // Name of the voice used for the audio (example: 'Sergio')\n \"language\": \"es\", // Language of the audio\n \"summaryAudioUrl\": string, // Url of the file that contains the summary version of the content in audio, based on the summaryText\n \"fullAudioUrl\": string, // Url of the file that contains the full version of the content in audio, based on the summaryText\n }\n ],\n \"contentProcesses\": [ // Not finished processes associated to the content\n {\n \"type\": string, // Type of process (possible values: 'summary', 'summary-audio', 'full-audio') \n \"language\": string,\n \"voice\": string, // In case the process is audio-related, the voice used to fulfill the process.\n \"status\": string // Status of the process (possible values: 'pending', 'failed')\n }\n ],\n \"createdAt\": string, // Date of creation of the content\n \"updatedAt\": string // Date of last modification of the content\n}\n\nThis endpoint returns all the contractually available voices for your publisher.
\nThe response for this request is the content data.
\n[\n {\n \"_id\": string, // id of the voice\n \"name\": string, // Name of the voice\n \"sample\": string, // Url of an audio with a sample of the voice\n \"language\": string // Language in which the voice is available\n }\n]\n\n