Skip to content

docs: add CLI content command documentation #61

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sweetmantech merged 6 commits into from
Mar 13, 2026
Merged

docs: add CLI content command documentation #61

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
443dca4
docs: add CLI content command documentation
sweetmantech Mar 12, 2026
3cc566e
docs: move run status to recoup tasks, remove from content
sweetmantech Mar 13, 2026
96a723c
feat: rename SDK page to CLI, add content commands after tasks section
sweetmantech Mar 13, 2026
bd66a51
feat: add API reference links to content CLI commands
sweetmantech Mar 13, 2026
4c2b9fd
fix: use artist_account_id instead of artistSlug in content CLI docs
sweetmantech Mar 13, 2026
2010b70
fix: link 'recoup tasks status' to tasks section in create content docs
sweetmantech Mar 13, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
73 changes: 73 additions & 0 deletions sdk.mdx → cli.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,3 +107,76 @@ recoup sandboxes create
recoup sandboxes create --command "ls -la"
recoup sandboxes list --json
```

## tasks

Check the status of background task runs. See [`GET /api/tasks/runs`](/api-reference/tasks/runs).

```bash
recoup tasks status --run <runId>
recoup tasks status --run <runId> --json
```

| Flag | Required | Description |
|------|----------|-------------|
| `--run <id>` | Yes | Trigger.dev run ID |

## content

Content-creation pipeline commands. Generate AI-powered social videos for artists.

### List templates

List available content templates. See [`GET /api/content/templates`](/api-reference/content/templates).

```bash
recoup content templates
recoup content templates --json
```

### Validate artist

Check that an artist has the required assets (face-guide, songs, context files) before creating content. See [`POST /api/content/validate`](/api-reference/content/validate).

```bash
recoup content validate --artist <artistAccountId>
recoup content validate --artist <artistAccountId> --json
```

| Flag | Required | Description |
|------|----------|-------------|
| `--artist <id>` | Yes | Artist account ID |

### Estimate cost

Preview the estimated cost and duration for a content run without starting it. See [`POST /api/content/estimate`](/api-reference/content/estimate).

```bash
recoup content estimate --artist <artistAccountId>
recoup content estimate --artist <artistAccountId> --template <name> --json
```

| Flag | Required | Description |
|------|----------|-------------|
| `--artist <id>` | Yes | Artist account ID |
| `--template <name>` | No | Template name (default: random) |
| `--lipsync` | No | Enable lipsync mode |
| `--upscale` | No | Enable upscaling |

### Create content

Trigger the full content-creation pipeline. Returns a run ID you can check with [`recoup tasks status`](/cli#tasks). See [`POST /api/content`](/api-reference/content/create).

```bash
recoup content create --artist <artistAccountId>
recoup content create --artist <artistAccountId> --template <name> --lipsync --upscale
recoup content create --artist <artistAccountId> --json
```

| Flag | Required | Description |
|------|----------|-------------|
| `--artist <id>` | Yes | Artist account ID |
| `--template <name>` | No | Template name (default: random) |
| `--lipsync` | No | Enable lipsync mode |
| `--upscale` | No | Enable upscaling |
| `--caption-length <n>` | No | Max caption length in characters |
2 changes: 1 addition & 1 deletion docs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
"index",
"quickstart",
"mcp",
"sdk",
"cli",
"api-reference/sandboxes/create"
]
}
Expand Down