# X-Pilot Developers

- [X-Pilot Developer Documentation](https://developers.x-pilot.ai/introduction.md): Build editable course and training videos with the X-Pilot API, MCP and official Agent Skills.
- [MCP Integration](https://developers.x-pilot.ai/mcp-integration.md): Connect X-Pilot to a compatible AI assistant with OAuth or an API key and explore the MCP tool schemas.
- [Agent Skills](https://developers.x-pilot.ai/skills.md): Install official X-Pilot Skills for course videos, narration and digital human avatars, with complete workflow and API references.
- [Course & explainer video](https://developers.x-pilot.ai/skills/xpilot-course-video.md): Create or revise educational and explainer videos with X Pilot, including the brief, style and duration choice, source uploads, optional outline review, asynchronous polling, preview handoff and MP4 export. Use when the user wants an X Pilot course, training, product or explainer video.
- [Voices & audio](https://developers.x-pilot.ai/skills/xpilot-audio.md): Find and preview X Pilot voices, produce spoken MP3 audio, and clone voices (Voice I instantly, or Voice II with the speaker's recorded consent) when the user requests narration, voiceover, text-to-speech, or a voice clone using X Pilot.
- [Digital human avatars](https://developers.x-pilot.ai/skills/xpilot-avatar.md): Find, create and inspect X Pilot digital humans from uploaded images or training videos, and synthesize talking-presenter videos with them from text or audio, when the user asks for an X Pilot presenter or avatar video.
- [API Reference](https://developers.x-pilot.ai/api-reference.md): Authenticate, explore request parameters and test the X-Pilot REST API directly in the documentation.
- [List conversations](https://developers.x-pilot.ai/api-reference/list-conversations.md): Owned conversations, newest first, with cumulative cost_credits. Conversation status follows its latest message. status: queued, running, stopping, paused, completed, failed or stopped. next_action is set only when paused: confirm_outline (confirm or revise the outline) or reply (answer the assistan…
- [Create conversation](https://developers.x-pilot.ai/api-reference/create-conversation.md): Creates a conversation and starts the first paid message immediately. Check credits and capacity first. By default the video is generated straight through; set require_outline_confirmation=true to review the outline first. Each files item may use an owned asset_id or a third-party public URL, with i…
- [Get conversation](https://developers.x-pilot.ai/api-reference/get-conversation.md): Conversation summary. status: queued, running, stopping, paused, completed, failed or stopped. next_action is set only when paused: confirm_outline (confirm or revise the outline) or reply (answer the assistant with a prompt). Use list messages for the outline and per-message detail.
- [Send message](https://developers.x-pilot.ai/api-reference/send-message.md): Send a follow-up turn to a conversation that is not running (409 conversation_busy otherwise). Paid. When next_action=confirm_outline, send outline_action=confirm (no prompt) or outline_action=revise with a prompt. When next_action=reply, answer with a prompt. Otherwise send an edit instruction. vid…
- [List messages](https://developers.x-pilot.ai/api-reference/list-messages.md): Messages in order. Poll for status, next_action, outline, cost_credits and preview_video_url. status: queued, running, stopping, paused, completed, failed or stopped. next_action is set only when paused: confirm_outline (confirm or revise the outline) or reply (answer the assistant with a prompt). c…
- [Stop conversation](https://developers.x-pilot.ai/api-reference/stop-conversation.md): Stops the running message (409 not_running when nothing runs). Poll list messages until stopped; cost already incurred may still be charged.
- [Delete conversation](https://developers.x-pilot.ai/api-reference/delete-conversation.md): Deletes an owned conversation and stops its running message.
- [List renders](https://developers.x-pilot.ai/api-reference/list-renders.md): MP4 exports of a conversation. status: queued, running, completed, failed or superseded. progress is 0–100 when available, otherwise null.
- [Create render](https://developers.x-pilot.ai/api-reference/create-render.md): Export an MP4 once preview_video_url is available (409 preview_not_ready otherwise). A preview is not an export. Retrying with the same Idempotency-Key returns the same render. Poll get render until completed.
- [Get render](https://developers.x-pilot.ai/api-reference/get-render.md): Export status, progress (0–100 or null when unavailable), and video_url once completed.
- [Delete render](https://developers.x-pilot.ai/api-reference/delete-render.md): Delete an export render record.
- [List brand kits](https://developers.x-pilot.ai/api-reference/list-brand-kits.md): Owned brand kits. Pass an id as video_config.brand_kit_id.
- [Create brand kit](https://developers.x-pilot.ai/api-reference/create-brand-kit.md): Create a brand kit referenced by video_config.brand_kit_id. Unknown fields return 400.
- [Get brand kit](https://developers.x-pilot.ai/api-reference/get-brand-kit.md): Read an owned brand kit.
- [Update brand kit](https://developers.x-pilot.ai/api-reference/update-brand-kit.md): Update fields of an owned brand kit; omitted fields stay unchanged.
- [Delete brand kit](https://developers.x-pilot.ai/api-reference/delete-brand-kit.md): Delete an owned brand kit.
- [Check credits](https://developers.x-pilot.ai/api-reference/check-credits.md): The API and platform share the same wallet and the same credit conversion as the app. Recharge in the owner console.
- [Check capacity & budget](https://developers.x-pilot.ai/api-reference/check-capacity.md): Check available concurrency and the credential monthly budget before starting a paid run.
- [List owned assets](https://developers.x-pilot.ai/api-reference/list-assets.md): Files uploaded to this account, newest first. Upload with POST /v1/assets.
- [Upload assets](https://developers.x-pilot.ai/api-reference/upload-assets.md): Multipart upload, field name files, up to 5 files per request. Limits per file: documents (pdf, docx, pptx, md, markdown, mdx) 10 MB; images (jpg, jpeg, png, gif, webp, svg) 10 MB; audio (wav, mp3, m4a, aac, ogg, flac) 20 MB; video (mp4, webm, mov) 60 MB. Empty files are rejected. Errors return 400…
- [list voices](https://developers.x-pilot.ai/api-reference/list-voices.md): Find public catalog voices or your own clones. Choose voice_id from the returned items; never guess provider identifiers. Use samples on list/detail items for fixed audition clips.
- [get voice](https://developers.x-pilot.ai/api-reference/get-voice.md): Read a public or owned voice, including readiness and samples. Private voices from another account are unavailable. Poll this after clone_voice: a Voice II clone moves from training to trained (selectable=true) or failed.
- [generate audio](https://developers.x-pilot.ai/api-reference/generate-audio.md): Synthesize up to 1,000 characters with a catalog voice or one of your ready clones, in Voice I or Voice II. voice_version must match the voice. Returns MP3 audio_url (which may be a data URL). Uses platform TTS pricing; reuse the same Idempotency-Key for retries.
- [get voice clone config](https://developers.x-pilot.ai/api-reference/get-voice-clone-config.md): Read Voice II clone requirements before clone_voice with voice_version 2: availability, the authorized company_name, supported locales with the consent_statement the speaker must read aloud, and sample duration/size limits. When voice_ii_available is false (for example voice_ii_unavailable_reason cl…
- [clone voice](https://developers.x-pilot.ai/api-reference/clone-voice.md): Clone a private voice from audio already uploaded to your account. Voice I (default) is an instant clone from one sample. Voice II needs the speaker's consent: call get_voice_clone_config, have the speaker record the consent_statement for the chosen locale with their name and company_name filled in,…
- [delete voice](https://developers.x-pilot.ai/api-reference/delete-voice.md): Delete an owned cloned voice. Public catalog voices cannot be deleted. Reuse Idempotency-Key on retry.
- [List owned avatars](https://developers.x-pilot.ai/api-reference/list-avatars.md): Owned avatars and quota. Only avatars with selectable=true can be used as video_config.avatar_id.
- [get avatar](https://developers.x-pilot.ai/api-reference/get-avatar.md): Read an owned avatar. status is the overall state (draft, generating, ready, failed, deleting, migration_required); training_status and preview_status track training and the preview sample; selectable must be true before video generation can use it; stage names the step in progress (queued, generati…
- [create avatar](https://developers.x-pilot.ai/api-reference/create-avatar.md): Create an avatar from an owned asset_id or a public http(s) image/video URL. Third-party URLs are downloaded and archived to the caller’s owned storage before training. Requires platform entitlement. Poll get_avatar for preview_image_url and preview_video_url, or receive avatar.completed / avatar.fa…
- [delete avatar](https://developers.x-pilot.ai/api-reference/delete-avatar.md): Delete an owned avatar. Poll get_avatar or list_avatars until it disappears. Reuse Idempotency-Key on retry.
- [create avatar video](https://developers.x-pilot.ai/api-reference/create-avatar-video.md): Synthesize a talking-presenter video with an owned avatar whose training_status is ready. Drive it with text + voice_id (platform TTS, Voice I or Voice II) or with your own speech audio (asset_id or a public http(s) audio_url) — exactly one source, up to 5 minutes of speech. Output is a transparent-…
- [get avatar video](https://developers.x-pilot.ai/api-reference/get-avatar-video.md): Read an avatar video job: status (queued, processing, completed, failed), video_url (transparent WebM) once completed, duration_seconds, width, height and the settled cost_credits. Poll at least 5 seconds apart.

## OpenAPI Specs

- [openapi](/downloads/openapi.json)
- [openapi](/openapi.json)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.