# Spiritme MCP > Spiritme MCP Server lets your AI client generate high-fidelity, multilingual videos using digital human avatars. You can programmatically list avatar portfolios, trigger video generation jobs for specific scripts and voices, and monitor job status in real time—all through simple natural language commands. ## Overview - **Category:** marketing-automation - **Price:** Free - **Tags:** ai-avatars, video-generation, digital-human, multilingual-video, content-creation ## Description You've got a bunch of video assets to manage, and you don't wanna deal with a web dashboard or manual status checks. This server lets your AI client handle the entire lifecycle of high-fidelity digital video content through simple commands. First off, before you run anything else, you can use `check_spiritme_status` to verify that the API connection is up and running right now. If everything's green, you're good to go. To get started on a project, your AI client first needs to know what avatars it's dealing with. You can run `list_avatars` to pull a complete inventory of every digital person you own or have access to. Need more detail on one specific face? Use `get_avatar` and pass in the ID; that pulls all the technical metadata, including the SKU IDs you need for generation. If you're building out a script from scratch, your agent needs supporting media first. You can run `list_voices` to see every synthetic voice available, checking things like language and accent details using `get_voice`. If you also gotta pick a visual style, running `list_templates` gives you the whole catalog of video layouts, and then `get_template` pulls all the metadata for a specific template. For your content library, you can use `list_videos` to see a full list of every video asset you've created and where it lives. If you need to clean things up or remove an old file, `delete_video` takes out that specific video from your account. Now for the generation part—the fun stuff. You can programmatically create just audio tracks using `generate_audio`, simply feeding in text, and the server handles the rest. If you're ready to make a whole video, you trigger it with `generate_video`. That job requires specific inputs: you gotta specify your script, which template you want to use, and which voice selection you’ve chosen. When you submit a job using `generate_video`, the AI client doesn't just forget about it. You can track everything by running `get_job_status`. This checks the real-time status of that video generation job, giving you instant confirmation when all your assets are ready and available for download. It’s a full loop: Your agent first pulls configuration details—listing avatars with `list_avatars`, checking templates with `list_templates`, and getting detailed voice info with `list_voices`. Then it uses that data to call `generate_video` or `generate_audio`. Finally, it monitors the process using `get_job_status` until everything's done. You can even check your existing work anytime by calling `list_videos`. ## Tools ### check_spiritme_status Verifies the current API connectivity status with Spiritme. ### delete_video Removes a specific video asset from your account. ### generate_audio Creates an audio file based on provided text input. ### generate_video Triggers the creation of a full video asset using specified inputs. ### get_avatar Retrieves detailed information for a single digital avatar by its ID. ### get_job_status Checks the real-time status and results of a submitted video generation job. ### get_template Retrieves metadata for available video templates. ### get_voice Fetches details about available synthetic voices, including language and accent information. ### list_avatars Retrieves a full list of all digital avatars you own or can access. ### list_templates Returns a catalog listing all available video templates. ### list_videos Generates a list of your previously created and hosted video assets. ### list_voices Retrieves a complete catalogue of available voices for selection. ## Prompt Examples **Prompt:** ``` Generate a video with avatar 'av_123' and script: 'Hello, welcome to our team!'. ``` **Response:** ``` Video orchestrated! I've successfully submitted the generation request for avatar av_123. The job ID is job_xyz789. The high-fidelity video will be ready shortly. Shall I notify you once the status is 'Completed'? ``` **Prompt:** ``` Check the status of video job 'job_xyz789'. ``` **Response:** ``` Job intelligence orchestrated! For job_xyz789, the current high-fidelity status is 'DONE'. The video was generated successfully at 2:00 PM today. Need help retrieving the final hosted URL? ``` **Prompt:** ``` List all active videos in my Spiritme library. ``` **Response:** ``` Asset directory orchestrated! I've retrieved your high-fidelity video portfolio. You currently have 10 active assets, including 'Intro 2024' and 'Product Update'. Would you like the detailed technical metadata for any of them? ``` ## Capabilities ### Manage Avatar Assets List all available digital avatars in your portfolio, retrieving technical metadata and SKU IDs for programmatic use. ### Generate Core Media Submit jobs to create full videos or just audio tracks using specified scripts, templates, and voice selections. ### Retrieve Configuration Details Fetch specific details about avatars (`get_avatar`), available video templates (`get_template`), or voices (`get_voice`) before starting a job. ### Monitor Job Progress Check the real-time status of any submitted video generation job, getting instant confirmation when assets are ready. ### List and Organize Media Library Access your full directory of hosted video assets to see what's already created and where it lives. ## Use Cases ### Need to localize a message for 5 countries A marketing manager needs five versions of the same product announcement. Instead of manually creating five separate video jobs, they prompt their agent: 'Generate videos using avatar av_123 with scripts in Spanish, French, German, Italian, and Japanese.' The agent runs `generate_video` multiple times, handling all the necessary multilingual calls. ### A training team needs to audit avatars The L&D specialist wants to know which avatar IDs are available for a new department video. They prompt: 'List all avatars.' The agent runs `list_avatars`, returning the full technical portfolio list, allowing them to verify metadata before writing scripts. ### A developer needs an asset ID check The automation developer's script fails because it can't find a template. They ask their agent: 'Check available templates.' The agent runs `list_templates`, providing the required structured data so the script can proceed with `generate_video`. ### Need to verify video job completion A user submitted a complex, long-running video generation request and needs an update. They ask: 'What's the status of job XYZ789?' The agent immediately runs `get_job_status`, confirming if it succeeded or providing details on why it stalled. ## Benefits - You get instant job status updates. Instead of checking a dashboard, running `get_job_status` gives you the current progress and final URL as soon as it's ready. - Manage your entire portfolio from chat. Use `list_avatars` to see every avatar SKU ID without logging into the web portal, making data retrieval fast. - Build structured content pipelines. By using `get_template` and `get_voice`, you ensure that any generated video follows brand guidelines before submission. - Scale multilingual production easily. You can run `generate_video` for different language scripts and voices in a single prompt, drastically cutting down manual work. - Keep track of everything. After running `list_videos`, your agent shows you exactly how many assets are active, giving an immediate resource count. ## How It Works The bottom line is, your AI client manages video creation and status checks without you ever opening a web browser. 1. First, subscribe to the Spiritme server. Then, grab your API Key from the dashboard (Settings > API). 2. Next, tell your AI client exactly what you need—for example, 'Generate a video with avatar av_123 using this script.' 3. The agent runs the necessary tools (`generate_video`, `list_avatars`) and returns job IDs or asset URLs. You then use `get_job_status` to track completion. ## Frequently Asked Questions **How do I find out what avatars are available using list_avatars?** You run `list_avatars`. This returns a complete portfolio listing. The metadata you get back includes the necessary SKU IDs and technical details required to use them in other tools. **Does generate_video handle multiple languages at once?** Yes, it can. You pass the script/language options directly into the `generate_video` tool call. This allows you to orchestrate multilingual content creation efficiently in one sequence. **What if my video job fails? How do I check that with get_job_status?** The `get_job_status` tool will return the current status, including error codes or messages. This helps you pinpoint exactly which step failed, saving debugging time. **Can list_voices help me pick the right accent for my message?** Absolutely. Running `list_voices` gives you details on available voices. You can check if a specific language and required regional accent (like British English vs. American) is supported. **How do I verify my API credentials are working before generating content using check_spiritme_status?** It immediately checks your connectivity status. Running this tool verifies that your API key is active and connected to the Spiritme platform, confirming you're ready for high-fidelity video jobs. **If I need to remove old or unused files, how do I use the delete_video tool?** The tool deletes specific videos from your hosted assets. You pass the ID of the asset you want gone; it handles the removal request directly through the API. **What details does list_videos provide when I need to audit my entire content library?** It retrieves a comprehensive directory listing of all your existing video assets. This lets you see metadata, SKU IDs, and status for every piece of media in your portfolio. **If I need technical specs on an avatar, how do I use the get_avatar tool?** It pulls detailed technical metadata about a specific digital human. This includes critical information like SKU IDs and physical parameters, which is essential for automated pipeline integration. **How do I find my Spiritme API Key?** Log in to your account, navigate to **Settings** > **API**, and copy your unique access token from the credentials section. **Can I check the status of a video job via AI?** Yes! The `get_spiritme_job_status` tool allows your agent to poll the high-fidelity real-time status of any generation request. **How do I list my available avatars?** Use the `list_spiritme_avatars` tool to retrieve your complete high-fidelity directory along with the unique identifiers for all managed digital actors.