# Get an Asset by id Source: https://docs.argil.ai/api-reference/endpoint/assets.get get /assets/{id} Returns a single Asset identified by its id Returns an asset identified by its id from your library that can be used in your videos. ## Audio Assets Audio assets from this endpoint can be used as background music in your videos. When creating a video, you can reference an audio asset's ID in the `backgroundMusic` parameter to add it as background music. See the [Create Video endpoint](/api-reference/endpoint/videos.create) for more details. *** # List Assets Source: https://docs.argil.ai/api-reference/endpoint/assets.list get /assets Get a list of available assets from your library Returns an array of assets from your library that can be used in your videos. ## Audio Assets Audio assets from this endpoint can be used as background music in your videos. When creating a video, you can reference an audio asset's ID in the `backgroundMusic` parameter to add it as background music. See the [Create Video endpoint](/api-reference/endpoint/videos.create) for more details. *** # Create a new Avatar Source: https://docs.argil.ai/api-reference/endpoint/avatars.create post /avatars Creates a new avatar. ## Overview Create a new avatar from an image. Supports both URL and base64-encoded image formats. If no `voiceId` is provided, a voice design will be automatically created from the image. ## Request Body ```json theme={null} { "type": "IMAGE", "name": "", "datasetImage": { "url": "https://example.com/avatar-image.jpg", // OR "base64": "data:image/png;base64,iVBORw0KGgoAAAANS..." }, "voiceId": "", "extras": { "custom_key": "custom_value" } } ``` ### Image Requirements * **Format**: PNG, JPEG, or WEBP * **Resolution**: Between 720p (1280x720 or 720x1280) and 4K (3840x2160 or 2160x3840) * **Aspect Ratio**: Must be exactly 16:9 (landscape) or 9:16 (portrait) * **Max Size**: 10MB * **Protocol**: HTTPS URLs only (for `url` field) ### Optional Fields * `voiceId`: UUID of an existing voice to use. If not provided, a voice design will be automatically created from the image. * `extras`: Custom metadata dictionary (max 10 key-value pairs, 256 characters each) ## Response Returns the created Avatar object. The avatar will be created with `TRAINING` status and transition to `IDLE` when ready. ## Avatar Status After creating an avatar, it will be in the `TRAINING` status. The avatar typically becomes ready (status changes to `IDLE`) within **30 seconds**. **Important**: Before creating videos with a newly created avatar, you must ensure the avatar status is `IDLE`. You have two options: ### Option 1: Poll Avatar Status Periodically check the avatar status using the [GET /avatars/](/api-reference/endpoint/avatars.get) endpoint until the status is `IDLE`: ```bash theme={null} curl -X GET https://api.argil.ai/v1/avatars/{avatar_id} \ -H "x-api-key: YOUR_API_KEY" ``` ### Option 2: Use Webhook Events (Recommended) Subscribe to the `AVATAR_TRAINING_SUCCESS` webhook event to receive a notification when the avatar is ready. This is the recommended approach as it avoids polling and provides real-time updates. Learn more about setting up webhooks: [AVATAR\_TRAINING\_SUCCESS Event](/pages/webhook-events/avatar-training-success) ## Cost Each image avatar created from API will cost **2 credits**. # Create a new Avatar Source: https://docs.argil.ai/api-reference/endpoint/avatars.create.video post /avatars Creates a new avatar. **This endpoint is deprecated.** Video-based avatar creation will be removed in a future version. Please use [image-based avatar creation](/api-reference/endpoint/avatars.create) instead. ## Overview Create a new avatar from a video. This method requires both a dataset video and a consent video. **Deprecation Notice**: This video-based avatar creation method is deprecated and will be removed in a future API version. Migrate to image-based avatar creation for better performance and simpler workflow. ### Video Requirements **Dataset Video:** * Duration: 1-5 minutes * Format: MP4 or MOV * Resolution: Between 720p and 4K * Max size: 1.5GB * Protocol: HTTPS only **Consent Video:** * Duration: 30 seconds or less * Format: MP4 or MOV * Max size: 100MB * Protocol: HTTPS only ### Optional Fields * `extras`: Custom metadata dictionary (max 10 key-value pairs, 256 characters each) # Get an Avatar by id Source: https://docs.argil.ai/api-reference/endpoint/avatars.get get /avatars/{id} Returns a single Avatar identified by its id # List all avatars Source: https://docs.argil.ai/api-reference/endpoint/avatars.list get /avatars Returns an array of Avatar objects available for the user # Export subtitles for a video project Source: https://docs.argil.ai/api-reference/endpoint/subtitles.export get /subtitles/videos/{videoProjectId}/export Exports subtitles for a video project in VTT or ASS format. The subtitles can optionally include styling information. # List subtitle styles Source: https://docs.argil.ai/api-reference/endpoint/subtitles.list get /subtitles Returns a paginated array of subtitle styles available for the user # Create a new Video Source: https://docs.argil.ai/api-reference/endpoint/videos.create post /videos Creates a new Video with the specified details # Delete a Video by id Source: https://docs.argil.ai/api-reference/endpoint/videos.delete delete /videos/{id} Delete a single Video identified by its id # Get a Video by id Source: https://docs.argil.ai/api-reference/endpoint/videos.get get /videos/{id} Returns a single Video identified by its id # Paginated list of Videos Source: https://docs.argil.ai/api-reference/endpoint/videos.list get /videos Returns a paginated array of Videos # Render a Video by id Source: https://docs.argil.ai/api-reference/endpoint/videos.render post /videos/{id}/render Returns a single Video object, with its updated status and information # Get a Voice by id Source: https://docs.argil.ai/api-reference/endpoint/voices.get get /voices/{id} Returns a single Voice identified by its id # List all voices Source: https://docs.argil.ai/api-reference/endpoint/voices.list get /voices Returns an array of Voice objects available for the user # Create a new webhook Source: https://docs.argil.ai/api-reference/endpoint/webhooks.create post /webhooks Creates a new webhook with the specified details. # Delete a webhook Source: https://docs.argil.ai/api-reference/endpoint/webhooks.delete delete /webhooks/{id} Deletes a single webhook identified by its ID. # Retrieve all webhooks Source: https://docs.argil.ai/api-reference/endpoint/webhooks.list get /webhooks Retrieves all webhooks for the authenticated user. # Update a webhook Source: https://docs.argil.ai/api-reference/endpoint/webhooks.update PUT /webhooks/{id} Updates the specified details of an existing webhook. # API Credentials Source: https://docs.argil.ai/pages/get-started/credentials Create, manage and safely store your Argil's credentials `Prerequisite` You should have access to Argil's app with a paid plan to complete this step. Manage your API keys by clicking [here](https://app.argil.ai/developers) or directly from the app's sidebar. From the UI, click on `New API key` and follow the process. Authenticate your requests by including your API key in the `x-api-key` header. \`\`\`http x-api-key: YOUR\_API\_KEY. \`\`\`\` It is essential to adhere to best practices regarding the storage and usage of your API key. This information is sensitive and crucial for maintaining the security of your services. If any doubt about the corruption of your key, delete it and create a new one. Don't share your credentials with anyone. This API key enables video generation featuring your avatar, which may occur without your explicit authorization. Please note that Argil cannot be held responsible for any misuse of this functionality. Always ensure that your API key is handled securely to prevent unauthorized access. ## Troubleshooting Here's how to solve some common problems when working around your credentials setup. Let us assist by [Mail](mailto:brivael@argil.ai) or [Discord](https://discord.gg/Xy5NEqUv). # Introduction Source: https://docs.argil.ai/pages/get-started/introduction Welcome to Argil's API documentation Hero Light Hero Dark This service allows content creators to seamlessly integrate video generation capabilities into their workflow, leveraging their AI Clone for personalized videos creation. Whether you're looking to enhance your social media presence, boost user engagement, or offer personalized content, Argil makes it simple and efficient. ## Setting Up Get started with Argil's API by setting up your credentials and generate your first avatar video using our API service. Create, manage and safely store your Argil's credentials Jump straight into video creation with our quick start guide ## Build something on top of Argil Elaborate complex infrastructures with on-demand avatar video generation capabilities using our `Public API` and `Webhooks`. Integrate your on-demand avatar anywhere. Subscribe to events and get notified on generation success and other events # Quickstart Source: https://docs.argil.ai/pages/get-started/quickstart Start automating your content creation workflow `Prerequisite` You should be all setup with your [API Credentials](/pages/get-started/credentials) before starting this tutorial. `Prerequisite` You should have successfully trained at least one [Avatar](https://app.argil.ai/avatars) from the app. In order to generate your first video through our API, you'll need to know which avatar and voice you want to use. Not finding your Avatar? It might not be ready yet. Check at your [Avatars](https://app.argil.ai/avatars) page for updates. Get your avatars list by running a GET request on the `/avatars` route. Check the [Avatars API Reference](/api-reference/endpoint/avatars.list) to run the request using an interactive UI. Get your voices list by running a GET request on the `/voices` route. Check the [Voices API Reference](/api-reference/endpoint/voices.list) to run the request using an interactive UI. You are done with this step if you have the id of the avatar and and the id of the voice you want to use for the next steps. Create a video by running a POST request on the `/videos` route. Check the [Video creation API Reference](/api-reference/endpoint/videos.create) to run the request using an interactive UI. To create a `Video` resource, you'll need: * A `name` for the video * A list of `Moment` objects, representing segments of your final video. For each moment, you will be able to choose the `avatar`, the `voice` and the `transcript` to be used. For each moment, you can also optionally specify: * An audioUrl to be used as voice for the moment. This audio will override our voice generation. * A gestureSlug to select which gesture from the avatar should be used for the moment. ```mermaid theme={null} flowchart TB subgraph video["Video {name}"] direction LR subgraph subgraph1["Moment 1"] direction LR item1{{avatar}} item2{{voice}} item3{{transcript}} item4{{optional - gestureSlug}} item5{{optional - audioUrl}} end subgraph subgraph2["Moment n"] direction LR item6{{avatar}} item7{{voice}} item8{{transcript}} item9{{optional - gestureSlug}} item10{{optional - audioUrl}} end subgraph subgraph3["Moment n+1"] direction LR item11{{avatar}} item12{{voice}} item13{{transcript}} item14{{optional - gestureSlug}} item15{{optional - audioUrl}} end subgraph1 --> subgraph2 subgraph2 --> subgraph3 end ``` You are done with this step if the request returned a status 201 and a Video object as body.
Note the `Video id` for the next step.
Render a video by running a POST request on the `/videos/{video_id}/render` route. Check the [Render API Reference](/api-reference/endpoint/videos.render) to run the request using an interactive UI. You are done with this step if the route returned a Video object, with its status set to `GENERATING_AUDIO` or `GENERATING_VIDEO`. Get your video's updates by running a GET request on the `/videos/[id]` route. Check the [Videos API Reference](/api-reference/endpoint/videos.get) to run the request using an interactive UI. You are done with this step once the route returns a `Video` object with status set to `DONE`. From the Video object you obtains in the previous step, retrieve the `videoUrl` field. Use this url anywhere to download / share / publish your video and automate your workflow.
# Avatar Training Failed Webhook Source: https://docs.argil.ai/pages/webhook-events/avatar-training-failed Get notified when an avatar training failed ## About the Avatar Training Failed Event The `AVATAR_GENERATION_FAILED` event is triggered when an avatar training process fails in Argil. This webhook event provides your service with a payload containing detailed information about the failed generation. ## Payload Details When this event triggers, the following data is sent to your callback URL: ```json theme={null} { "event": "AVATAR_TRAINING_FAILED", "data": { "avatarId": "", "avatarName": "", "extras": "" } } ``` For detailed instructions on setting up this webhook event, visit our [Webhooks API Reference](/pages/api-reference/endpoint/webhooks.create). # Avatar Training Success Webhook Source: https://docs.argil.ai/pages/webhook-events/avatar-training-success Get notified when an avatar training completed successfully ## About the Avatar Training Success Event The `AVATAR_TRAINING_SUCCESS` event is triggered when an avatar training process completes successfully in Argil. This webhook event provides your service with a payload containing detailed information about the successful avatar training. ## Payload Details When this event triggers, the following data is sent to your callback URL: ```json theme={null} { "event": "AVATAR_TRAINING_SUCCESS", "data": { "avatarId": "", "voiceId": "", "avatarName": "", "extras": "" } } ``` For detailed instructions on setting up this webhook event, visit our [Webhooks API Reference](/pages/api-reference/endpoint/webhooks.create). # Introduction to Argil's Webhook Events Source: https://docs.argil.ai/pages/webhook-events/introduction Learn what webhooks are, how they work, and how to set them up with Argil through our API. ## What are Webhooks? Webhooks are automated messages sent from apps when something happens. In the context of Argil, webhooks allow you to receive real-time notifications about various events occurring within your environment, such as video generation successes and failures or avatar training successes and failures. ## How Webhooks Work Webhooks in Argil send a POST request to your specified callback URL whenever subscribed events occur. This enables your applications to respond immediately to events within Argil as they happen. ### Available Events for subscription This event is triggered when an avatar video generation is successful.
Check our [VIDEO\_GENERATION\_SUCCESS Event Documentation](/pages/webhook-events/video-generation-success) for more information about this event.
This event is triggered when an avatar video generation is failed.
Check our [VIDEO\_GENERATION\_FAILED Event Documentation](/pages/webhook-events/video-generation-failed) for more information about this event.
This event is triggered when an avatar training is successful.
Check our [AVATAR\_TRAINING\_SUCCESS Event Documentation](/pages/webhook-events/avatar-training-success) for more information about this event.
This event is triggered when an avatar training is failed.
Check our [AVATAR\_TRAINING\_FAILED Event Documentation](/pages/webhook-events/avatar-training-failed) for more information about this event.
A single webhook can subscribe to multiple events. ## Managing Webhooks via API You can manage your webhooks entirely through API calls, which allows you to programmatically list, register, edit, and unregister webhooks. Below are the primary actions you can perform with our API: Retrieve a list of all your registered webhook.
[API Reference for Listing Webhooks](/api-reference/endpoint/webhooks.list)
Learn how to register a webhook by specifying a callback URL and the events you are interested in.
[API Reference for Creating Webhooks](/api-reference/endpoint/webhooks.create)
Unregister a webhook when it's no longer needed.
[API Reference for Deleting Webhooks](/api-reference/endpoint/webhooks.delete)
Update your webhook settings, such as changing the callback URL or events.
[API Reference for Editing Webhooks](/api-reference/endpoint/webhooks.update)
# Video Generation Failed Webhook Source: https://docs.argil.ai/pages/webhook-events/video-generation-failed Get notified when an avatar video generation failed ## About the Video Generation Failed Event The `VIDEO_GENERATION_FAILED` event is triggered when a video generation process fails in Argil. This webhook event provides your service with a payload containing detailed information about the failed generation. ## Payload Details When this event triggers, the following data is sent to your callback URL: ```json theme={null} { "event": "VIDEO_GENERATION_FAILED", "data": { "videoId": "", "videoName": "", "videoUrl": "", "extras": "" } } ``` For detailed instructions on setting up this webhook event, visit our [Webhooks API Reference](/pages/api-reference/endpoint/webhooks.create). # Video Generation Success Webhook Source: https://docs.argil.ai/pages/webhook-events/video-generation-success Get notified when an avatar video generation completed successfully ## About the Video Generation Success Event The `VIDEO_GENERATION_SUCCESS` event is triggered when a video generation process completes successfully in Argil. This webhook event provides your service with a payload containing detailed information about the successful video generation. ## Payload Details When this event triggers, the following data is sent to your callback URL: ```json theme={null} { "event": "VIDEO_GENERATION_SUCCESS", "data": { "videoId": "", "videoName": "", "videoUrl": "", "extras": "" } } ``` For detailed instructions on setting up this webhook event, visit our [Webhooks API Reference](/pages/api-reference/endpoint/webhooks.create). # Account settings Source: https://docs.argil.ai/resources/account-settings Issues with logging in (Google Sign up and normal email sign up) ### Account Merger When you created an account using Google Sign up, you will have a possibility to create another account via email + password with the same email adress. You will then be asked to merge accounts and need to click on yes. If you see a merger prompt during login, **click on "continue"** to proceed. It means that you created your account with Google then via normal email for a second account but with the same address. This creates two different accounts that you need to merge. ### Password Reset Sign out of your current account Click on "Forgot password?" and follow the instructions ### Workspaces Workspaces will allow multiple team members with different emails to collaborate in the same studio. Need early access? Contact us at [support@argil.ai](mailto:support@argil.ai) # Affiliate Program Source: https://docs.argil.ai/resources/affiliates Earn money by referring users to Argil ### Join Our Affiliate Program Click here to join the Argil Affiliate Program and start earning up to €5k/month SEA campaigns and Facebook ads campaigns are forbidden. ### How it works Get 30% of your affiliates' generated revenue for 12 months by sharing your unique referral link. You get paid 15 days after the end of the previous month, with a \$50 minimum threshold. ### Getting started 1. Click the signup button above to create your account 2. Fill out the required information 3. Receive your unique referral link 4. Share your link with your network 5. [Track earnings in your dashboard](https://argil.tolt.io) ### Earnings 30% commission per referral with potential earnings up to €5k/month Valid for 12 months from signup Real-time dashboard analytics ### Managing your account 1. Access dashboard at [argil.getrewardful.com](https://argil.tolt.io/login) 2. View revenue overview with filters 3. Track referred users and earnings 4. Monitor payment status ### Success story "I've earned \$4,500 in three months by simply referring others to their AI video platform" - Othmane Khadri, CEO of Earleads Always disclose your affiliate relationship when promoting Argil # Animate An Image Source: https://docs.argil.ai/resources/animate-an-image Turn a single image into a short video with first and last frame Bring any static image to life with AI-generated motion. Define start and end frames, describe the animation you want, and generate dynamic video content in seconds. ## How it works 1. **Upload your first frame** — Drop your starting image (or pick a sample) 2. **Upload your last frame** (optional) — Drop your ending image to guide the animation direction 3. **Write your prompt** — Describe what you want to see (e.g., "Camera slowly zooms in, leaves blowing in the wind") 4. **Generate video** — Choose your model and render ## Available models | Model | Style | | :----------- | :------------------------ | | Sora 2 | Cinematic, photorealistic | | VEO 3.1 | Versatile, natural motion | | Seedance 1.5 | Stylized, artistic | ## Settings * **Duration** — 8s shot by default * **Aspect ratio** — 9:16 (vertical), 16:9 (horizontal), 1:1 (square) * **Sound** — Toggle on/off ## Tips * Use high-quality images for better results * Last frame is optional but helps guide motion direction * Keep prompts simple and focused on one type of movement * Add assets via "+ Add assets" to reference specific elements in your prompt # API - Pricing Source: https://docs.argil.ai/resources/api-pricings Here are the pricings for the API All prices below apply to all clients that are on a **Classic plan or above.** If you **are an entreprise client** (over **60,000 credits/month** or requiring **specific support**), please [contact us here](mailto:enterprise@argil.ai). | Feature | Pricing per unit | | --------------------------------- | ------------------ | | Video | 140 credits/minute | | Voice | 20 credits/minute | | Royalty (Argil's v1 avatars only) | 20 credits/video | | B-roll (AI image) | 10 credit/b-roll | | B-roll (stock video) | 20 credit/b-roll | For a 30 second video with 3 Image B-rolls and Argil v1 avatar, the credit cost will be \ 70 (*video*)\\+ 10 (voice) + 20 (royalty) + 30 (b-rolls) = 130 credits$0.35 (video) \+ $ ### Frequently asked questions Avatar Royalties only apply to Argil's avatars - if you train your own avatar, you will not pay for it. Yes, we have a partnership with [Elevenlabs](https://elevenlabs.io/) for voice. If you have an account there with your voices, you can link your Elevenlabs account to Argil (see how here) and you will not pay for voice using the API. At Argil, we are commited to give our actors (generic avatars) their fair share - we thus have a royalty system in place with them. By measure of transparency and since it may evolve, we're adding it as a separate pricing for awareness. We make it simpler for clients to use any of our products by sharing their credits regardless of what platform they use - we thus require to create an account to use our API. To buy credits, just go to app.argil.ai. On the bottom left, click on "get more" or "upgrade" and you will be able to buy more credits from there. # Article to video Source: https://docs.argil.ai/resources/article-to-video How does the article to video feature work? Some links may not work - in this case, please reach out to [support@argil.ai](mailto:support@argil.ai) Transforming article into videos yields major benefits and is extremely simple. It allows: * Better SEO rankings * Social-media ready video content on a video that ha * Monetizing the video if you have the ability to ### How to transform an article into a video Captured’écran2025 10 23à15 30 39 Pn You can choose a social media format (with a social media tone) or a more classic format to embed in your articles, that will produce a longer video. Captured’écran2025 10 23à15 30 15 Pn A script is automatically created for your video, but we also pull the images & videos we found in the original article. Remove those that you do not want, and pick the other options (see our editing tips (**add link)** for that). From there, just follow the editing tips (add link) to get the best possible video. ### Frequently asked questions Yes you can! See our API documentation # Assets Source: https://docs.argil.ai/resources/assets How do assets work, what type of files can be uploaded If you are using the same images or videos quite often, uploading them to the asset section is the best way to have them all stored at the same place. ### How do I add an image or a video to the assets? You can either: a) Go in the asset section on the left panel then "Upload" directly\ b) Go into create a video then "Upload media" in the next tab\ c) If you are editing a video in the studio, all the images and videos that you upload there will be stored in the assets section. Video B-rolls from Getty image won't be stored ### Are Veo3 and Hailuo videos automatically saved in the asset section? Yes, Veo3 and Hailuo videos generated via Argil will always be saved in the asset section. # Upload audio and voice-transformation Source: https://docs.argil.ai/resources/audio-and-voicetovoice Get more control on the dynamism of your voice. Two ways to use audio instead of text to generate a video: Supported audio formats are **mp3, wav, m4a** with a maximum size of **50mb**. Upload your pre-recorded audio file and let our AI transcribe it automatically Use our built-in recorder to capture your voice with perfect audio quality ### Voice transformation guarantees amazing results After uploading, our AI will transcribe your audio and let you transform your voice while preserving emotions and tone. # Avatar actions Source: https://docs.argil.ai/resources/avatar-actions You can now create your own medias and videos with VEO3 or Hailuo directly integrated into Argil using your own avatars or Argil's licensed avatars. It also integrates Nano Banana. Fictions allow you to fully prompt 8 second-clips using the latest AI video models with a frame of reference. It will also apply the voice you picked. ## **Video tutorial (text tutorial below)**