# ZOOOP

> AI-native filmmaking workstation. Public REST API for image / video / audio
> generation. Authenticate with a Personal Access Token; per-call charges hit
> your existing credit balance.

This file follows the `llmstxt.org` convention so language-model agents can
discover what's available without crawling HTML.

## API

- [API reference](https://github.com/zooopai/skill-zooop/blob/main/references/api-docs.md) — full v1 endpoint specification
- [llms-full.txt](/llms-full.txt) — every doc concatenated for single-fetch ingest

## Skill bundle (Claude Code / agent integration)

The canonical agent skill bundle lives on GitHub at
<https://github.com/zooopai/skill-zooop> — `SKILL.md`, helper shell scripts,
and install / contribution docs. Claude Code users:

```
claude install github:zooopai/skill-zooop
```

Other agents: clone the repo or fetch
<https://raw.githubusercontent.com/zooopai/skill-zooop/main/SKILL.md>.

## Quick start

1. Visit <https://zooop.ai/user#apiKeys> and create a PAT (`zpk_live_…`).
   Bind it to a project — all PAT-submitted tasks + uploads land there.
2. (Optional) Self-check budget + project before doing real work:
   `GET https://api.zooop.ai/v1/me`
3. List models for the task type:
   `GET https://api.zooop.ai/v1/models?type=image&subtype=default`
4. (Optional) Upload a local file the model will consume:
   `POST https://api.zooop.ai/v1/uploads` (raw body + `Content-Type`)
5. Submit a task:
   `POST https://api.zooop.ai/v1/tasks` with `{interfaceId, versionId, params}`
6. Poll until terminal:
   `GET https://api.zooop.ai/v1/tasks/{id}`

All requests carry `Authorization: Bearer $ZOOOP_API_KEY`.

## Public categories (`type` × `subType`)

The 12 (type, subType) pairs the API currently exposes match the homepage
sidebar one-for-one:

```
image / default              text-to-image / image-to-image
image / edit-image           image editing with mask
video / text-ref             text-to-video
video / motion-control       image-to-video with motion direction
video / first-last-frame     generate video between two keyframes
video / audio-lipsync        sync video to audio
video / extend-video         extend an existing video
video / video-edit           edit / restyle existing video
audio / text-to-speech       TTS
audio / voice-clone          voice cloning from sample
audio / sound-effect         text-to-SFX
audio / music                text-to-music
```