# PixAI Platform > Developer documentation for the PixAI API, a REST API that generates anime-style AI images and videos with the same models that power pixai.art. It covers getting API access, authenticating with an API key, submitting asynchronous generation tasks, webhooks, and the v2 and v1 endpoint references. ## When to use PixAI Use the PixAI API when a user wants anime, manga, game-art or other stylized illustration generated or edited, in particular: - Generate an anime-style image from a text prompt, optionally with LoRAs, a style preset or a color palette (`POST /v2/image/create`). - Generate from 1-3 reference images, for example to keep a character consistent across images or take a pose from another picture (`contextImages` on `POST /v2/image/create`). - Redraw part of an image, or extend it past its edges (`POST /v2/gen-task/inpaint`). - Animate a still image, or make a short video from reference images and audio (`POST /v2/frame-video/create`, `POST /v2/reference-video/create`). - Find a model or LoRA, with its trigger words and supported sizes, before generating (`GET /v2/generation-model/search`). Do not use it for photorealistic photos, or for text, code or speech generation. How to call it: send an API key as `Authorization: Bearer ` to `https://api.pixai.art`. Every generation is an asynchronous task: the create call returns a task ID, then poll `GET /v2/task/{id}` no more than once every 1.5 seconds (or register a webhook) until it completes, and resolve the output media IDs to URLs with `GET /v2/media/batch?ids=`. Upload your own input images first with `POST /v2/media/image/upload-url`. Each generation spends credits from the key owner's account. Coding agents can also search and read these docs through a docs-only MCP server at `https://platform.pixai.art/docs-mcp` (Streamable HTTP, no authentication); setup: [Docs MCP server](https://platform.pixai.art/ko/docs/docs-mcp). The sections below list the Korean pages. The docs are also available in other languages; their indexes are listed under Optional. ## 문서 - [PixAI API 문서](https://platform.pixai.art/ko/docs): PixAI API 개발자 문서. REST API, API 키 인증, 비동기 작업, Webhook으로 애니메이션 스타일 AI 이미지를 프로그램에서 생성할 수 있습니다. 빠른 시작으로 시작한 뒤 v2 / v1 엔드포인트 참조로 이동하세요. - [문서 MCP 서버](https://platform.pixai.art/ko/docs/docs-mcp): Claude Code, Cursor, VS Code 등 MCP 클라이언트를 문서 MCP 서버(https://platform.pixai.art/docs-mcp)에 연결하면 AI 에이전트가 이 문서를 검색하고 읽을 수 있습니다. 이미지를 생성하지는 않습니다. - [자주 묻는 질문](https://platform.pixai.art/ko/docs/faq): PixAI API 자주 묻는 질문. 이메일 신청과 멤버십으로 받는 API 키의 차이, 유지보수 알림 수신 방법, API로 생성한 이미지와 공개 히스토리, 기술 지원 언어를 안내합니다. ## 빠른 시작 PixAI API 시작하기. 가입부터 첫 번째 요청까지 단계별로 안내합니다. - [PixAI API를 사용하려면?](https://platform.pixai.art/ko/docs/quick-start/enroll-in-api): PixAI API 사용 신청 방법과 API 키 발급 방법을 안내합니다. - [첫 번째 API 호출](https://platform.pixai.art/ko/docs/quick-start/first-api-call): 작업 제출, 상태 폴링, 이미지 다운로드까지 PixAI API로 첫 번째 요청을 보내는 과정을 단계별로 안내합니다. - [제한 사항](https://platform.pixai.art/ko/docs/quick-start/limits): PixAI API 이용 제한을 안내합니다. 대기 중인 작업 수 상한, 폴링 간격 기준, 아직 지원하지 않는 기능을 확인하세요. - [이 문서에 대하여](https://platform.pixai.art/ko/docs/quick-start): PixAI API 문서의 개요와, PixAI 플랫폼으로 이미지 생성 애플리케이션을 만들기 시작하는 방법을 소개합니다. ## API v2 문서 현재의 API. 이미지·동영상 생성, 이미지 편집, 업로드, 모델·LoRA·컬러 팔레트 조회를 다룹니다. ### 이미지 이미지를 생성하고 편집합니다. - [이미지 생성 작업 생성](https://platform.pixai.art/ko/docs/api-v2/image/createImage): 간소화된 v2 API로 비동기 이미지 생성 작업을 시작합니다. 응답에는 생성된 작업의 ID가 포함됩니다. - [인페인트, 아웃페인트, 다시 그리기 작업 생성](https://platform.pixai.art/ko/docs/api-v2/image/createInpaint): 기존 이미지를 편집합니다: - [인페인트 프리셋의 제한 조회](https://platform.pixai.art/ko/docs/api-v2/image/getInpaintConstraints): 인페인트 modelPreset의 크기 제한과 다시 그리기 프리셋을 반환합니다. 알 수 없는 프리셋에는 오류 대신 null 필드가 반환됩니다. 인증이 필요하지 않습니다. ### 동영상 이미지와 참조 자료로 동영상을 생성합니다. - [이미지 기반 동영상 생성 작업 생성](https://platform.pixai.art/ko/docs/api-v2/video/createFrameVideo): PixAI의 Tsubaki 동영상 모델로 이미지를 동영상으로 만듭니다. 동영상은 firstFrameMediaId에서 시작하며, lastFrameMediaId를 보내면 그 프레임에서 끝납니다. 출력은 첫 프레임의 종횡비를 유지합니다. - [참조 동영상 생성 작업 생성](https://platform.pixai.art/ko/docs/api-v2/video/createReferenceVideo): 참조 이미지와, 모델에 따라 참조 동영상 및 오디오를 바탕으로 동영상을 생성합니다. ### 작업 작업과 그 결과를 조회합니다. - [작업 조회](https://platform.pixai.art/ko/docs/api-v2/task/getTask): v2 엔드포인트로 생성한 작업을 조회합니다. status가 completed, failed, cancelled 중 하나가 될 때까지 몇 초마다 폴링하세요. ### 미디어 입력 파일을 업로드하고 미디어 ID를 URL로 변환합니다. - [ID로 미디어 URL 조회](https://platform.pixai.art/ko/docs/api-v2/media/batchGetMedia): 완료된 작업의 outputs.mediaIds나 outputs.videoMediaId 등 최대 100개의 미디어 ID를 URL로 변환합니다. 공개 미디어는 인증이 필요하지 않습니다. - [오디오 파일 업로드 URL 발급](https://platform.pixai.art/ko/docs/api-v2/media/getAudioUploadUrl): POST /v2/reference-video/create의 referenceAudioMediaIds에 사용할 오디오 클립을 업로드하는 1단계입니다. 흐름은 이미지와 같습니다. 파일의 Content-Type(audio/mpeg 또는 audio/wav)을 지정해 바이트를 uploadUrl에 PUT한 다음 POST /v2/media/audio/register를 호출하세요. - [이미지 업로드 URL 발급](https://platform.pixai.art/ko/docs/api-v2/media/getImageUploadUrl): 입력으로 사용할 이미지(contextImages 항목, 동영상 프레임, 인페인트 베이스 이미지 등)를 업로드하는 1단계입니다. - [동영상·오디오 파일 정보 조회](https://platform.pixai.art/ko/docs/api-v2/media/getMediaInfo): 동영상 또는 오디오 미디어 항목의 길이, 크기, 컨테이너, 코덱을 반환합니다. 참조 동영상 작업을 생성하기 전에 참조 파일이 모델의 제한을 충족하는지 확인할 수 있습니다. - [업로드한 오디오 파일 등록](https://platform.pixai.art/ko/docs/api-v2/media/registerAudio): 오디오 클립 업로드의 3단계입니다. 반환된 id가 referenceAudioMediaIds에 전달할 미디어 ID입니다. - [업로드한 이미지 등록](https://platform.pixai.art/ko/docs/api-v2/media/registerImage): 이미지 업로드의 3단계로, 업로드한 파일을 미디어 항목으로 만듭니다. uploadUrl로의 PUT이 성공한 후 호출하세요. 반환된 id가 다른 엔드포인트에 전달할 미디어 ID입니다. ### 모델 모델, LoRA, 크기, 컬러 팔레트를 찾습니다. - [모델 또는 LoRA 조회](https://platform.pixai.art/ko/docs/api-v2/model/getGenerationModel): 모델 ID(검색 결과의 id)로 모델 하나를 조회합니다. - [모델 버전 조회](https://platform.pixai.art/ko/docs/api-v2/model/getGenerationModelVersion): 생성 엔드포인트가 받는 버전 ID로 모델 버전 하나를 조회합니다. 생성 전에 LoRA의 트리거 워드와 베이스 모델을 확인할 때 사용합니다. - [모델 버전이 지원하는 크기 조회](https://platform.pixai.art/ko/docs/api-v2/model/getModelSizeConfig): POST /v2/image/create의 width/height에 모델 버전이 받는 크기를 나열합니다. 경로와 달리 파라미터는 버전 ID입니다. - [색상 팔레트 프리셋 목록 조회](https://platform.pixai.art/ko/docs/api-v2/model/listColorPalettePresets): POST /v2/image/create의 colorPalette에 사용할 PixAI 공식 색상 팔레트를 나열합니다. 사용하려면 프리셋 객체 전체에 "source": "preset"을 추가해 보내세요. - [모델의 버전 목록 조회](https://platform.pixai.art/ko/docs/api-v2/model/listGenerationModelVersions): 모델의 버전을 최신순으로 나열합니다. 이전 버전을 고정하려면 해당 버전의 id를 modelVersionId 또는 loras[].modelId로 전달하세요. - [모델 및 LoRA 검색](https://platform.pixai.art/ko/docs/api-v2/model/searchGenerationModels): PixAI 모델 마켓을 검색합니다. modelVersionId에 사용할 베이스 모델이나 POST /v2/image/create의 loras에 사용할 LoRA를 찾을 때 사용합니다. ## API 문서 작업 상태를 조회하고 ID로 미디어를 가져오거나 업로드하는 v1 엔드포인트. ### 작업 이미지 생성 작업을 생성하고 관리하기 위한 API 엔드포인트. - [ID로 작업 상세 조회](https://platform.pixai.art/ko/docs/api/task/getTask): ID로 생성 작업을 조회하여 상태(waiting, running, completed, cancelled, failed)와 생성된 미디어의 ID 및 URL을 확인합니다. ### 미디어 미디어를 업로드하고 ID로 생성된 미디어를 가져오기 위한 API 엔드포인트. - [ID로 미디어 조회](https://platform.pixai.art/ko/docs/api/media/getMedia): ID로 미디어를 조회하여 유형, 크기 및 각 변형(variant)의 URL을 확인합니다. - [ID로 미디어 이미지 조회](https://platform.pixai.art/ko/docs/api/media/getMediaImage): 미디어의 이미지 파일로 HTTP 302 리다이렉트합니다. 미디어 ID를 이미지 URL처럼 바로 사용할 수 있습니다. - [이미지 또는 동영상 업로드](https://platform.pixai.art/ko/docs/api/media/uploadMedia): 이미지 또는 동영상을 업로드하고 저장된 파일을 식별하는 미디어 ID를 받습니다. ## Extras 사용 가능한 모델, Webhook 알림, 지원되는 해상도 등의 추가 참조 자료. - [모델](https://platform.pixai.art/ko/docs/references/models): PixAI 이미지 생성 모델 목록(유형, 버전, 허용 샘플링 방식 포함) - [Webhook](https://platform.pixai.art/ko/docs/references/webhook): PixAI API 작업이 시작, 완료, 취소 또는 실패하면 POST 요청으로 알림을 받습니다. 프로필의 Webhook 또는 요청별 callbackUrl로 설정합니다. - [지원 해상도](https://platform.pixai.art/ko/docs/references/supported-resolutions): v2 API의 11가지 종횡비별로 1k 및 1.5k 크기 등급에서 출력되는 너비와 높이, 기본값을 정리했습니다. ## 기타 저작권, 라이선스 조건 및 피드백 방법에 관한 정보. - [저작권 및 관련 권리](https://platform.pixai.art/ko/docs/about/copyright): PixAI API를 통해 생성된 콘텐츠의 저작권, 라이선스 조건 및 사용권에 대해 알아보세요. - [문의하기](https://platform.pixai.art/ko/docs/about/feedback): PixAI API에 대한 피드백이나 문의는 이메일로 보내 주세요. ## OpenAPI specs Machine-readable OpenAPI 3.1 specs of the endpoints above, for agents and client generators. - [API v2 spec](https://platform.pixai.art/openapi-spec.v2.ko.yaml): image and video generation, inpainting, uploads, tasks and model lookups, with every request field and error code. The English spec is also served as [/openapi.json](https://platform.pixai.art/openapi.json). - [API v1 spec](https://platform.pixai.art/openapi-spec.ko.yaml): task status, media lookup and media upload. ## Optional - [English index](https://platform.pixai.art/en/llms.txt): This index for the English pages. - [Japanese index](https://platform.pixai.art/ja/llms.txt): This index for the Japanese pages. - [Full documentation text](https://platform.pixai.art/llms-full.txt): Every docs page, in every language, as Markdown in one file.