Social Media Assistant - videos & trends · GPT-Aktionen

{
  "openapi": "3.0.0",
  "info": {
    "title": "TikTok Trend API",
    "description": "A collection of functions to retrieve and generate TikTok trends and video ideas.",
    "version": "1.0.0"
  },
  "servers": [
    {
      "url": "https://api.trendup.ai",
      "description": "Main server"
    }
  ],
  "paths": {
    "/api/get-sounds-by-mood": {
      "post": {
        "description": "Get most relevant sound that best fits the sound user is looking for based on the mood. Only call this function when the user requests specifically for a sound.",
        "operationId": "getSoundsByMood",
        "x-openai-isConsequential": false,
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "vector": {
                    "type": "array",
                    "description": "This length of 6 number array represents a vector for the type or mood of a song or sound they are looking for. First index represents 'danceability mood', second index represents 'happy mood', third index represents 'sad mood', fourth index represents 'relaxed mood', and fifth index represents 'aggressive mood'. Each index 1 through 5 can range from 0 to 100. Sixth index represents the BPM. Pick each index according to the user's query. For the mood indices, make sure to use 100 if the user specifically requests a specific mood. A high BPM is 130 and a low one is 80. For each index, make sure you have the supporting reasoning to the value that you pick. The input must only be a 6 number array.",
                    "items": {
                      "type": "number"
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "A list of sounds that fit the user's request",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "videos": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "tiktokUrl": {
                            "type": "string"
                          },
                          "title": {
                            "type": "string"
                          },
                          "imageUrl": {
                            "type": "string"
                          },
                          "businessUse": {
                            "type": "boolean"
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Invalid request, userQuery is missing or malformed."
          },
          "500": {
            "description": "Internal server error."
          }
        }
      }
    },
    "/api/get-sounds-by-country": {
      "post": {
        "description": "Get most top sound from a specific country. Use this if the user requests the trending sounds for a specific region. Only call this function when the user requests specifically for a sound.",
        "operationId": "getSoundsByCountry",
        "x-openai-isConsequential": false,
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "countryName": {
                    "type": "string",
                    "description": "The country the user wants to query for when getting top sounds on TikTok. These are the available options: United States, Lithuania, Finland, Canada, Latvia, Iceland, Estonia, Norway, Czechia, Ireland, Germany, Italy, Chile, Mexico, Greece, Peru, Colombia, Argentina, Spain, Australia, New Zealand, Egypt, Taiwan, Singapore, Pakistan, United Kingdom, South Africa, Nigeria, Brazil, Denmark, Sweden, United Arab Emirates, Belarus, Ukraine, Poland, Philippines, Croatia, Hungary, South Korea, Kazakhstan, Vietnam, Japan, Macao, Romania, Bulgaria, Slovakia, France, Switzerland, Austria, Netherlands, Belgium, Portugal, Thailand, Israel, Iraq, Lebanon, Saudi Arabia, Malaysia, Luxembourg, Cambodia, Myanmar, Bahrain, Kuwait."
                  },
                  "businessUse": {
                    "type": "boolean",
                    "description": "True or false on whether the user wants to see only business-friendly sounds. Optional. Default is all videos."
                  },
                  "format": {
                    "type": "array",
                    "items": {
                      "type": "object"
                    },
                    "description": "Sounds and songs related to the user's request. It will be an array of objects. When listing the output, include the sound title, tiktok URL, and a description of why this sound is relevant. Return 5 sounds by most relevant to the query."
                  }
                },
                "required": [
                  "countryName"
                ]
              }
            }
          }
        }
      }
    },
    "/api/get-sounds-by-genre": {
      "post": {
        "description": "Get most top sound for a specific genre. Use this if the user requests the trending sounds for a specific genre. Only call this function when the user requests specifically for a sound.",
        "operationId": "getSoundsByGenre",
        "x-openai-isConsequential": false,
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "genreName": {
                    "type": "string",
                    "description": "The genre the user wants to query for when getting top sounds on TikTok. These are the available options: Video Games, Scripted Drama, Software & APPs, Science, Other Transportation, Graphic Art, Humanities, School Education, Supernatural & Horror, DIY & Handicrafts, Advertisement, Photography, Health & Wellness, Entertainment News, Selfies, Professional & Personal Development, Other Talent, Campus Life, Finger Dance & Basic Dance, Nail Art, Hair, Travel, Babies, Fishing, Hunting & Camping, Family, Motivation, Scenery & Plants, Business & Finance, Tech Products & Infos, Other Beauty, Mukbangs & Tasting, Traditional Sports, Extreme Sports, Sports News, Toys & Collectables, Comics & Cartoon, Anime, Cosplay, Other Fashion, Dance, Oddly Satisfying, Non-Video Games, Street Interviews & Social Experiments, Social News, Work & Jobs, Cars, Trucks & Motorcycles, Farm Animals, Recreation Facilities, Food Display, Diary & VLOG, Scripted Comedy, Romance, Food Tour & Recommendations, Fitness, Pranks, Beauty, Home & Garden, Cooking, Social Issues, Other Animals, Other Comedy, Lip-sync, Movies & TV works, Pets, Outfits, Drinks, Singing & Instruments, Celebrity Clips & Variety Show, Music."
                  },
                  "businessUse": {
                    "type": "boolean",
                    "description": "True or false on whether the user wants to see only business-friendly sounds. Optional. Default is all videos."
                  },
                  "format": {
                    "type": "array",
                    "items": {
                      "type": "object"
                    },
                    "description": "Sounds and songs related to the user's request. It will be an array of objects. When listing the output, include the sound title, tiktok URL, and a description of why this sound is relevant. Return 5 sounds by most relevant to the query."
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/get-top-sounds": {
      "post": {
        "description": "Get the trending sounds on TikTok right now. Call this if the user wants to know the top or trending sounds or songs on TikTok. Only call this function when the user requests specifically for a sound.",
        "operationId": "getTopSounds",
        "x-openai-isConsequential": false,
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "businessUse": {
                    "type": "boolean",
                    "description": "True or false on whether the user wants to see only business-friendly sounds. Optional. Default is all videos."
                  },
                  "format": {
                    "type": "array",
                    "items": {
                      "type": "object"
                    },
                    "description": "A list of sounds and songs that are trending on TikTok. It will be an array of objects. When listing the output, include the sound title, tiktok URL hyperlinked to the title, image url (in markdown image), and a description of why this sound is relevant. Return 5 sounds by most relevant to the query."
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/get-video-trends": {
      "post": {
        "description": "Get popular TikTok trends right now. Call this if the user wants to know the current 'TikTok trends'. This is different from 'trending topics' or 'what's trending'. Specifically for TikTok trends or 'video trends'.",
        "operationId": "getVideoTrends",
        "x-openai-isConsequential": false,
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "format": {
                    "type": "array",
                    "items": {
                      "type": "object"
                    },
                    "description": "A list of trends that are trending on TikTok. It will be an array of objects with the description of the trend, and the sound of the trend, and example videos. When listing the output, include a short title of the trend (come up with a title using the trend description), an easy-to-understand description of the trend, and the video examples (hyperlinked). Be concise and direct with the description. Return 5 sounds by most relevant to the query."
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/get-example-videos": {
      "post": {
        "description": "Return 3 video ideas tailored to user's query. This includes sourcing high-performing, relevant example videos and current TikTok trends for inspiration, ensuring the ideas are effective and engaging. Select 3 most relevant from 5 example videos and 5 current TikTok trends and generate video ideas.",
        "operationId": "getVideoIdeas",
        "x-openai-isConsequential": false,
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "userQuery": {
                    "type": "string",
                    "description": "The user's desired video topic or idea. The 'userQuery' should specify a particular topic or idea for a video. This will be used to perform a vector search for videos with relevant themes or concepts."
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The function will return a list of 5 example videos related to user's query and 5 TikTok trends. Pick 3 most relevant items to come up with the best, most effective TikTok/short-form video ideas. Each example video will have transcription, text-overlay, summary, and each trend will have a description of the trend, and a few trend video examples. Use all resources to provide ideas that exactly copy the structure, tone, and point of the chosen videos or trend, while keeping the video in the user's query context.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "format": {
                      "type": "object",
                      "description": "A list of 5 example videos related to user's query and 5 TikTok trends."
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/generate-video-guide": {
      "post": {
        "description": "Get a specific video guide, including video script, embedded in-video text, and what and how to film, based on what the user wants in their video. Only call this for a normal video, and not trends. For trends, you will not call any functions.",
        "operationId": "generateVideoGuide",
        "x-openai-isConsequential": false,
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "userQuery": {
                    "type": "string",
                    "description": "The user's desired video idea, topic, or what the user wants the video to be about. Include all details or requests that the user wants with the video."
                  },
                  "referenceVideoLink": {
                    "type": "string",
                    "description": "The example video link. If the user wants to get a video guide of a specific video idea presented earlier in the conversation, put that link in here."
                  }
                },
                "required": [
                  "userQuery"
                ]
              }
            }
          }
        }
      }
    },
    "/api/get-trending-topics": {
      "post": {
        "description": "Get topics that are trending on social media right now. Call this if the user wants to know 'what's trending' or the current trending topics on social media. Call this if the user wants to know specifically topics that are trending. Niche is optional.",
        "operationId": "getTrendingTopics",
        "x-openai-isConsequential": false,
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "genre": {
                    "type": "string",
                    "description": "The niche the user wants to query for to get trending topics in their niche. Pass in the user’s requested niche as the input. Be as specific as possible. For example, if the user requests for trending topics in 'small green beans', you must input 'small green beans'. You must not generalize the genre or niche."
                  }
                },
                "required": []
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "A list of trending topics on social media. They are trending hashtags, but don't mention that they are hashtags. Rewrite hashtags to write a normal topic title or summary. Effectively understand what topic each hashtag represents and output as only topics.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "format": {
                      "type": "string",
                      "description": "A list of trending topics on social media. They are trending hashtags, but rewritten as normal topic titles or summaries."
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/get-relevant-trends": {
      "post": {
        "description": "Get TikTok trends that are relevant to the user's query for a specific TikTok trend or if they are looking for a relevant TikTok trend for a video they want to make.",
        "operationId": "getRelevantTrends",
        "x-openai-isConsequential": false,
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "userQuery": {
                    "type": "string",
                    "description": "The user's request on a specific trend or what they want the trend to be about. Include all details or requests that the user wants with the trend. This will be used to perform a vector search for trends with relevant themes or concepts."
                  }
                },
                "required": [
                  "userQuery"
                ]
              }
            }
          }
        }
      }
    },
    "/api/get-creators": {
      "post": {
        "description": "Get a list of trending or most popular tiktok creators. If the user requests for popular creators, call this function.",
        "operationId": "getCreators",
        "x-openai-isConsequential": false,
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {},
                "required": [
                  "userQuery"
                ]
              }
            }
          },
          "responses": {
            "200": {
              "description": "A list of creators based on the specified query.",
              "content": {
                "application/json": {
                  "schema": {
                    "type": "object",
                    "properties": {
                      "format": {
                        "type": "object",
                        "description": "A list of creators. It will be an array of objects with the creator's tiktok url, follower count, like count, and engagement rank. It may also include each creator's videos with the transcription, embedded in-video text, summary and the video tiktokUrl.  When listing the output, include the creator's tiktok url (hyperlinked to their @[creatorId])."
                      }
                    }
                  }
                }
              }
            },
            "400": {
              "description": "Bad Request - The request was invalid or cannot be otherwise served."
            },
            "500": {
              "description": "Internal Server Error - Something went wrong on the server's end."
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {}
  }
}