ugcinc 4.15.1 → 4.16.0

package/README.md

@@ -43,7 +43,7 @@ if (res.ok) {
 
 - `client.accounts`: list, create, update, troubleshoot, quarantine/release, and manage account lifecycle
 - `client.posts`: create video/slideshow posts, update them, retry failures, and preview schedule conflicts
-- `client.media`: upload media, create media records, search profile-picture candidates, manage tags/names, and work with social audio
+- `client.media`: upload media, create media records, search profile-picture candidates, search images and videos by keyword (`media.imageSearch`, cursor-paged), manage tags/names, and work with social audio
 - `client.stats`: fetch account/post analytics, daily aggregates, top performers, and refresh stats
 - `client.org`: manage organizations, API keys, and integration keys
 - `client.billing`: inspect subscription state and handle account deactivation, replacements, and refunds

package/dist/index.d.ts

@@ -30,7 +30,7 @@ export type { TaskType, Task, GetTasksParams } from './tasks';
 export type { PostType, PostStatus, Post, PostStat, CaptionOverlay, GetPostsParams, GetPostsPageParams, PostsPage, PostSortField, PostSortDirection, CreateDraftParams, CreateSlideshowParams, GetPostStatsParams, GetPostStatusParams, CreateVideoParams, UpdatePostParams, DeletePostsParams, DeletePostsResponse, RetryPostsParams, SetPostStatusParams, SetPostStatusResponse, PreviewScheduleEntry, PreviewScheduleParams, PreviewScheduleResult, } from './posts';
 export type { RefreshStatsParams, RefreshStatsError, RefreshStatsResponse, RefreshStatsProgressResponse, RefreshStartEvent, RefreshProgressEvent, RefreshDoneEvent, RefreshStreamEvent, DailyAggregatedStat, GetDailyAggregatedStatsParams, DailyAccountStat, GetDailyAccountStatsParams, DailyPostStat, GetDailyPostStatsParams, DashboardDailyStat, GetDashboardDailyStatsParams, TopAccount, GetTopAccountsParams, TopPost, GetTopPostsParams, } from './stats';
 export type { Org, ApiKey, DeleteApiKeyParams, EditApiKeyParams, IntegrationKey, IntegrationProvider, UpsertIntegrationKeyParams, DeleteIntegrationKeyParams } from './org';
-export type { UserMedia, MediaUse, SocialAudio, Media, GetMediaParams, GetSocialAudioParams, UploadMediaParams, UploadMediaResponse, MediaTagUpdate, UpdateMediaTagsParams, MediaTagUpdateResult, UpdateMediaTagsResponse, UpdateMediaTagParams, UpdateMediaNameParams, DeleteMediaParams, DeleteMediaResponse, CreateSocialAudioParams, ImportTextParams, ImportTextResponse, CreateMediaFromUrlParams, GetMediaUseParams, GetMediaUseResponse, FilterMediaParams, FilterMediaResponse, PfpSearchParams, PfpSearchResponse, PfpCandidate, } from './media';
+export type { UserMedia, MediaUse, SocialAudio, Media, GetMediaParams, GetSocialAudioParams, UploadMediaParams, UploadMediaResponse, MediaTagUpdate, UpdateMediaTagsParams, MediaTagUpdateResult, UpdateMediaTagsResponse, UpdateMediaTagParams, UpdateMediaNameParams, DeleteMediaParams, DeleteMediaResponse, CreateSocialAudioParams, ImportTextParams, ImportTextResponse, CreateMediaFromUrlParams, GetMediaUseParams, GetMediaUseResponse, FilterMediaParams, FilterMediaResponse, PfpSearchParams, PfpSearchResponse, PfpCandidate, ImageSearchParams, ImageSearchResult, ImageSearchResponse, ImageSearchVideoFormat, } from './media';
 export type { CommentStatus, Comment, CreateCommentParams, CreateCommentResponse, GetCommentsParams, } from './comments';
 export type { BillingInfo, PortalUrlResponse, CancelAccountParams, CancelAccountResponse, ReactivateAccountParams, ReactivateAccountResponse, CancelSubscriptionResponse, RequestReplacementParams, RequestReplacementResponse, RequestRefundParams, RequestRefundResponse, BillingRequestInfo, PortalParams, } from './billing';
 export type { RenderJobResponse, RenderJobStatus, SubmitImageRenderJobParams, SubmitVideoRenderJobParams, SubmitScreenshotAnimationRenderJobParams, SubmitAutoCaptionRenderJobParams, SubmitSceneSplitJobParams, SceneSplitDetectorConfig, SubmitInstagramDmRenderJobParams, SubmitIMessageDmRenderJobParams, IgDmMessage, ImDmMessage, RenderVideoEditorConfig, } from './render';

package/dist/media.d.ts

@@ -150,6 +150,38 @@ export interface PfpSearchResponse {
     search_term: string;
     count: number;
 }
+export interface ImageSearchParams {
+    /** What to search for. */
+    search_term: string;
+    /** How many results to return. Defaults to 24, min 1, capped at 50. */
+    count?: number;
+    /** `next_cursor` of a previous response for the same `search_term`. */
+    cursor?: string;
+}
+export type ImageSearchVideoFormat = 'mp4' | 'hls' | 'gif';
+export interface ImageSearchResult {
+    /** Stable id for this result at the source. */
+    source_id: string;
+    title: string;
+    /** Full-resolution image; the cover image for a video result. */
+    url: string;
+    /** Smaller variant, for rendering a grid of results. */
+    preview_url: string;
+    /** Present only on video results. */
+    video_url?: string;
+    /**
+     * Present exactly when `video_url` is. `hls` is a playlist (`.m3u8`), not a
+     * file — convert it before storing it.
+     */
+    video_format?: ImageSearchVideoFormat;
+}
+export interface ImageSearchResponse {
+    results: ImageSearchResult[];
+    /** Pass as `cursor` to get the next page; null when there are no more. */
+    next_cursor: string | null;
+    search_term: string;
+    count: number;
+}
 export interface OwnedUploadParams {
     filename: string;
     contentType: string;
@@ -246,4 +278,18 @@ export declare class MediaClient extends BaseClient {
      * @param params.count - How many to return (default 12, max 40)
      */
     pfpSearch(params: PfpSearchParams): Promise<ApiResponse<PfpSearchResponse>>;
+    /**
+     * Search for images and videos by keyword, a page at a time.
+     *
+     * Pass the previous response's `next_cursor` as `cursor`, with the same
+     * `search_term`, to continue. Unlike `pfpSearch`, results already in use are
+     * not removed.
+     *
+     * Requires the `media:search` scope on a restricted key.
+     *
+     * @param params.search_term - What to search for
+     * @param params.count - How many to return (default 24, max 50)
+     * @param params.cursor - `next_cursor` from the previous page
+     */
+    imageSearch(params: ImageSearchParams): Promise<ApiResponse<ImageSearchResponse>>;
 }

package/dist/media.js

@@ -112,5 +112,21 @@ class MediaClient extends base_1.BaseClient {
     async pfpSearch(params) {
         return this.post('/media/pfp-search', params);
     }
+    /**
+     * Search for images and videos by keyword, a page at a time.
+     *
+     * Pass the previous response's `next_cursor` as `cursor`, with the same
+     * `search_term`, to continue. Unlike `pfpSearch`, results already in use are
+     * not removed.
+     *
+     * Requires the `media:search` scope on a restricted key.
+     *
+     * @param params.search_term - What to search for
+     * @param params.count - How many to return (default 24, max 50)
+     * @param params.cursor - `next_cursor` from the previous page
+     */
+    async imageSearch(params) {
+        return this.post('/media/image-search', params);
+    }
 }
 exports.MediaClient = MediaClient;

package/dist/render/compositions/AutoCaptionComposition.d.ts

@@ -2,7 +2,7 @@
  * AutoCaptionComposition
  *
  * A Remotion composition that renders a video with TikTok-style captions overlay.
- * Used for both server-side rendering (Modal) and client-side preview.
+ * Used for both server-side rendering (the render worker) and client-side preview.
  *
  * Features:
  * - Video playback with caption overlay

package/dist/render/types/screenshot.d.ts

@@ -29,7 +29,7 @@ export interface ScreenshotAnimationProps {
 }
 /**
  * Config for submitting a screenshot animation render job.
- * Used by Modal render service to identify this composition type.
+ * Used by the render worker to identify this composition type.
  */
 export interface ScreenshotAnimationConfig {
     _compositionType: 'screenshot-animation';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ugcinc",
-  "version": "4.15.1",
+  "version": "4.16.0",
   "description": "TypeScript/JavaScript client for the UGC Inc API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",