# Send acestep to your agent
Hand the extracted package to your coding agent with a concrete install brief instead of figuring it out manually.
## Fast path
- Download the package from Yavira.
- Extract it into a folder your agent can access.
- Paste one of the prompts below and point your agent at the extracted folder.
## Suggested prompts
### New install

```text
I downloaded a skill package from Yavira. Read SKILL.md from the extracted folder and install it by following the included instructions. Tell me what you changed and call out any manual steps you could not complete.
```
### Upgrade existing

```text
I downloaded an updated skill package from Yavira. Read SKILL.md from the extracted folder, compare it with my current installation, and upgrade it while preserving any custom configuration unless the package docs explicitly say otherwise. Summarize what changed and any follow-up checks I should run.
```
## Machine-readable fields
```json
{
  "schemaVersion": "1.0",
  "item": {
    "slug": "acestep",
    "name": "acestep",
    "source": "tencent",
    "type": "skill",
    "category": "开发工具",
    "sourceUrl": "https://clawhub.ai/DumoeDss/acestep",
    "canonicalUrl": "https://clawhub.ai/DumoeDss/acestep",
    "targetPlatform": "OpenClaw"
  },
  "install": {
    "downloadUrl": "/downloads/acestep",
    "sourceDownloadUrl": "https://wry-manatee-359.convex.site/api/v1/download?slug=acestep",
    "sourcePlatform": "tencent",
    "targetPlatform": "OpenClaw",
    "packageFormat": "ZIP package",
    "primaryDoc": "SKILL.md",
    "includedAssets": [
      "api-reference.md",
      "scripts/acestep.sh",
      "scripts/config.example.json",
      "SKILL.md"
    ],
    "downloadMode": "redirect",
    "sourceHealth": {
      "source": "tencent",
      "slug": "acestep",
      "status": "healthy",
      "reason": "direct_download_ok",
      "recommendedAction": "download",
      "checkedAt": "2026-05-11T14:58:43.277Z",
      "expiresAt": "2026-05-18T14:58:43.277Z",
      "httpStatus": 200,
      "finalUrl": "https://wry-manatee-359.convex.site/api/v1/download?slug=acestep",
      "contentType": "application/zip",
      "probeMethod": "head",
      "details": {
        "probeUrl": "https://wry-manatee-359.convex.site/api/v1/download?slug=acestep",
        "contentDisposition": "attachment; filename=\"acestep-1.0.2.zip\"",
        "redirectLocation": null,
        "bodySnippet": null,
        "slug": "acestep"
      },
      "scope": "item",
      "summary": "Item download looks usable.",
      "detail": "Yavira can redirect you to the upstream package for this item.",
      "primaryActionLabel": "Download for OpenClaw",
      "primaryActionHref": "/downloads/acestep"
    },
    "validation": {
      "installChecklist": [
        "Use the Yavira download entry.",
        "Review SKILL.md after the package is downloaded.",
        "Confirm the extracted package contains the expected setup assets."
      ],
      "postInstallChecks": [
        "Confirm the extracted package includes the expected docs or setup files.",
        "Validate the skill or prompts are available in your target agent workspace.",
        "Capture any manual follow-up steps the agent could not complete."
      ]
    }
  },
  "links": {
    "detailUrl": "https://openagent3.xyz/skills/acestep",
    "downloadUrl": "https://openagent3.xyz/downloads/acestep",
    "agentUrl": "https://openagent3.xyz/skills/acestep/agent",
    "manifestUrl": "https://openagent3.xyz/skills/acestep/agent.json",
    "briefUrl": "https://openagent3.xyz/skills/acestep/agent.md"
  }
}
```
## Documentation

### ACE-Step Music Generation Skill

Use ACE-Step V1.5 API for music generation. Always use scripts/acestep.sh script — do NOT call API endpoints directly.

### Quick Start

# 1. cd to this skill's directory
cd {project_root}/{.claude or .codex}/skills/acestep/

# 2. Check API service health
./scripts/acestep.sh health

# 3. Generate with lyrics (recommended)
./scripts/acestep.sh generate -c "pop, female vocal, piano" -l "[Verse] Your lyrics here..." --duration 120 --language zh

# 4. Output saved to: {project_root}/acestep_output/

### Workflow

For user requests requiring vocals:

Use the acestep-songwriting skill for lyrics writing, caption creation, duration/BPM/key selection
Write complete, well-structured lyrics yourself based on the songwriting guide
Generate using Caption mode with -c and -l parameters

Only use Simple/Random mode (-d or random) for quick inspiration or instrumental exploration.

If the user needs a simple music video, use the acestep-simplemv skill to render one with waveform visualization and synced lyrics.

MV Production Requirements: Making a simple MV requires three additional skills to be installed:

acestep-songwriting — for writing lyrics and planning song structure
acestep-lyrics-transcription — for transcribing audio to timestamped lyrics (LRC)
acestep-simplemv — for rendering the final music video

### Script Commands

CRITICAL - Complete Lyrics Input: When providing lyrics via the -l parameter, you MUST pass ALL lyrics content WITHOUT any omission:

If user provides lyrics, pass the ENTIRE text they give you
If you generate lyrics yourself, pass the COMPLETE lyrics you created
NEVER truncate, shorten, or pass only partial lyrics
Missing lyrics will result in incomplete or incoherent songs

Music Parameters: Use the acestep-songwriting skill for guidance on duration, BPM, key scale, and time signature.

# need to cd to this skill's directory first
cd {project_root}/{.claude or .codex}/skills/acestep/

# Caption mode - RECOMMENDED: Write lyrics first, then generate
./scripts/acestep.sh generate -c "Electronic pop, energetic synths" -l "[Verse] Your complete lyrics
[Chorus] Full chorus here..." --duration 120 --bpm 128

# Instrumental only
./scripts/acestep.sh generate "Jazz with saxophone"

# Quick exploration (Simple/Random mode)
./scripts/acestep.sh generate -d "A cheerful song about spring"
./scripts/acestep.sh random

# Options
./scripts/acestep.sh generate "Rock" --duration 60 --batch 2
./scripts/acestep.sh generate "EDM" --no-thinking    # Faster

# Other commands
./scripts/acestep.sh status <job_id>
./scripts/acestep.sh health
./scripts/acestep.sh models

### Output Files

After generation, the script automatically saves results to the acestep_output folder in the project root (same level as .claude):

project_root/
├── .claude/
│   └── skills/acestep/...
├── acestep_output/          # Output directory
│   ├── <job_id>.json         # Complete task result (JSON)
│   ├── <job_id>_1.mp3        # First audio file
│   ├── <job_id>_2.mp3        # Second audio file (if batch_size > 1)
│   └── ...
└── ...

### JSON Result Structure

Important: When LM enhancement is enabled (use_format=true), the final synthesized content may differ from your input. Check the JSON file for actual values:

FieldDescriptionpromptActual caption used for synthesis (may be LM-enhanced)lyricsActual lyrics used for synthesis (may be LM-enhanced)metas.promptOriginal input captionmetas.lyricsOriginal input lyricsmetas.bpmBPM usedmetas.keyscaleKey scale usedmetas.durationDuration in secondsgeneration_infoDetailed timing and model infoseed_valueSeeds used (for reproducibility)lm_modelLM model namedit_modelDiT model name

To get the actual synthesized lyrics, parse the JSON and read the top-level lyrics field, not metas.lyrics.

### Configuration

Important: Configuration follows this priority (high to low):

Command line arguments > config.json defaults
User-specified parameters temporarily override defaults but do not modify config.json
Only config --set command permanently modifies config.json

### Default Config File (scripts/config.json)

{
  "api_url": "http://127.0.0.1:8001",
  "api_key": "",
  "api_mode": "completion",
  "generation": {
    "thinking": true,
    "use_format": false,
    "use_cot_caption": true,
    "use_cot_language": false,
    "batch_size": 1,
    "audio_format": "mp3",
    "vocal_language": "en"
  }
}

OptionDefaultDescriptionapi_urlhttp://127.0.0.1:8001API server addressapi_key""API authentication key (optional)api_modecompletionAPI mode: completion (OpenRouter, default) or native (polling)generation.thinkingtrueEnable 5Hz LM (higher quality, slower)generation.audio_formatmp3Output format (mp3/wav/flac)generation.vocal_languageenVocal language

### Prerequisites - ACE-Step API Service

IMPORTANT: This skill requires the ACE-Step API server to be running.

### Required Dependencies

The scripts/acestep.sh script requires: curl and jq.

# Check dependencies
curl --version
jq --version

If jq is not installed, the script will attempt to install it automatically. If automatic installation fails:

Windows: choco install jq or download from https://jqlang.github.io/jq/download/
macOS: brew install jq
Linux: sudo apt-get install jq (Debian/Ubuntu) or sudo dnf install jq (Fedora)

### Before First Use

You MUST check the API key and URL status before proceeding. Run:

cd "{project_root}/{.claude or .codex}/skills/acestep/" && bash ./scripts/acestep.sh config --check-key
cd "{project_root}/{.claude or .codex}/skills/acestep/" && bash ./scripts/acestep.sh config --get api_url

Case 1: Using Official Cloud API (https://api.acemusic.ai) without API key

If api_url is https://api.acemusic.ai and api_key is empty, you MUST stop and guide the user to configure their key:

Tell the user: "You're using the ACE-Step official cloud API, but no API key is configured. An API key is required to use this service."
Explain how to get a key: API keys are currently available through acemusic.ai for free.
Use AskUserQuestion to ask the user to provide their API key.
Once provided, configure it:
cd "{project_root}/{.claude or .codex}/skills/acestep/" && bash ./scripts/acestep.sh config --set api_key <KEY>


Additionally, inform the user: "If you also want to render music videos (MV), it's recommended to configure a lyrics transcription API key as well (OpenAI Whisper or ElevenLabs Scribe), so that lyrics can be automatically transcribed with accurate timestamps. You can configure it later via the acestep-lyrics-transcription skill."

Case 2: API key is configured

Verify the API endpoint: ./scripts/acestep.sh health and proceed with music generation.

Case 3: Using local/custom API without key

Local services (http://127.0.0.1:*) typically don't require a key. Verify with ./scripts/acestep.sh health and proceed.

If health check fails:

Ask: "Do you have ACE-Step installed?"
If installed but not running: Use the acestep-docs skill to help them start the service
If not installed: Use acestep-docs skill to guide through installation

### Service Configuration

Official Cloud API: ACE-Step provides an official API endpoint at https://api.acemusic.ai. To use it:

./scripts/acestep.sh config --set api_url "https://api.acemusic.ai"
./scripts/acestep.sh config --set api_key "your-key"
./scripts/acestep.sh config --set api_mode completion

API keys are currently available through acemusic.ai for free.

Local Service (Default): No configuration needed — connects to http://127.0.0.1:8001.

Custom Remote Service: Update scripts/config.json or use:

./scripts/acestep.sh config --set api_url "http://remote-server:8001"
./scripts/acestep.sh config --set api_key "your-key"

API Key Handling: When checking whether an API key is configured, use config --check-key which only reports configured or empty without printing the actual key. NEVER use config --get api_key or read config.json directly — these would expose the user's API key. The config --list command is safe — it automatically masks API keys as *** in output.

### API Mode

The skill supports two API modes. Switch via api_mode in scripts/config.json:

ModeEndpointDescriptioncompletion (default)/v1/chat/completionsOpenRouter-compatible, sync request, audio returned as base64native/release_task + /query_resultAsync polling mode, supports all parameters

Switch mode:

./scripts/acestep.sh config --set api_mode completion
./scripts/acestep.sh config --set api_mode native

Completion mode notes:

No polling needed — single request returns result directly
Audio is base64-encoded inline in the response (auto-decoded and saved)
inference_steps, infer_method, shift are not configurable (server defaults)
--no-wait and status commands are not applicable in completion mode
Requires model field — auto-detected from /v1/models if not specified

### Using acestep-docs Skill for Setup Help

IMPORTANT: For installation and startup, always use the acestep-docs skill to get complete and accurate guidance.

DO NOT provide simplified startup commands - each user's environment may be different. Always guide them to use acestep-docs for proper setup.

For API debugging, see API Reference.
## Trust
- Source: tencent
- Verification: Indexed source record
- Publisher: DumoeDss
- Version: 1.0.2
## Source health
- Status: healthy
- Item download looks usable.
- Yavira can redirect you to the upstream package for this item.
- Health scope: item
- Reason: direct_download_ok
- Checked at: 2026-05-11T14:58:43.277Z
- Expires at: 2026-05-18T14:58:43.277Z
- Recommended action: Download for OpenClaw
## Links
- [Detail page](https://openagent3.xyz/skills/acestep)
- [Send to Agent page](https://openagent3.xyz/skills/acestep/agent)
- [JSON manifest](https://openagent3.xyz/skills/acestep/agent.json)
- [Markdown brief](https://openagent3.xyz/skills/acestep/agent.md)
- [Download page](https://openagent3.xyz/downloads/acestep)