VIvideogen
Entities

List entities

Changed on

List built-in actors, products, visual styles, and slideshow themes, followed by the entities available to your team. Built-in entities have isBuiltIn: true and cannot be updated or archived. Cursor-paginated; see the Pagination guide.

get/v1/entities

Request

  • Base URL
    https://api.videogen.io
  • Auth
    HTTP bearer

Query parameters

entityType'ACTOR' | 'PRODUCT' | 'VISUAL_STYLE' | 'SLIDESHOW_THEME' | 'BRAND' | 'LOCATION' | 'PROP'

When provided, returns only entities of this type. Omit to return all entities.

limitinteger

Maximum number of items to return in the page. Defaults to 50; capped at 200. See Pagination.

cursorstring

Opaque pagination cursor returned as nextCursor by the previous page. Omit on the first request. Cursors are tied to the endpoint that produced them and must be passed unmodified. See Pagination.

Response

Entity list

hasMoreboolean required

When true, there are more entities available. Pass nextCursor as the cursor query param to fetch the next page.

nextCursorstring nullable required

Opaque cursor to fetch the next page. null when hasMore is false.

Changes

  • 2976ed641a0cRevision changes
    • warning

      added the new BRAND enum value to the // response property for the response status

    • warning

      added the new LOCATION enum value to the // response property for the response status

    • warning

      added the new PROP enum value to the // response property for the response status

    • info

      added the new enum value BRAND to the query request parameter entityType

    • info

      added the new enum value LOCATION to the query request parameter entityType

    • info

      added the new enum value PROP to the query request parameter entityType

    • info

      added the optional property // to the response with the status

    • info

      added the required property //// to the response with the status