Agent

APIs for creating/editing media via agent orchestration and managing sessions with comprehensive control over user requests. The Agent Orchestration enables iterative creation and editing with context understanding. The agent translates plain conversational requests into actions and orchestrates calls to vimmerse tools and generate the required media accordingly.

Typical Agent

  1. Post request in new or current session - prompt the agent to perform certain action using optional media input
  2. Retrieve results from the session - get a conversational response along with the generated media
  3. Continue editing within the session - build up on the previous results within the context window and iterate to hit your targets

Common Use Cases

  • Product Videos: Create marketing briefs and photoshot product images for marketing campaigns
  • Storytelling and Shorts: Create storyboard of multiple scenes, define element images of characters objects and settings, use elements in scene images, feed all to create shorts and story videos
  • Social Media Content: Perform retouches, reframing, and edits to ready content for social platforms
  • Ideation: Ask agent with propose prompts and make variants of images and videos
  • Tool testing: Compare generation results of different image and video models side by side
  • Automation: Let agent handle the orchestration on your behalf so it picks the right tools and methods and build up on your context iterations

Endpoint Overview

Method Endpoint Description Access
POST / Interact with an agent, process prompts, and manage session turns User
POST /sessions Retrieve a list of sessions owned by the authenticated user User
GET /{session_id} Retrieve full conversation turn history for a session User
PUT /{session_id}/title Update the display title of a specific session User
DELETE /agent/{session_id} Delete a session and its associated data User

Authentication

All requests require your API key in the X-Api-Key header:

headers = {
    'X-Api-Key': 'YOUR_API_KEY'
}