focalapi-cli 0.2.1 → 0.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -1,57 +1,57 @@
1
- {
2
- "name": "focalapi-cli",
3
- "version": "0.2.1",
4
- "description": "让任意 AI Agent 直接调用 focalapi 创作模型的命令行工具",
5
- "type": "module",
6
- "bin": {
7
- "focalapi": "dist/cli.js"
8
- },
9
- "files": [
10
- "dist",
11
- "scripts",
12
- "skills",
13
- "README.md",
14
- "CHANGELOG.md",
15
- "LICENSE"
16
- ],
17
- "engines": {
18
- "node": ">=18"
19
- },
20
- "scripts": {
21
- "dev": "tsx src/cli.ts",
22
- "build": "tsup",
23
- "test": "vitest run",
24
- "test:watch": "vitest",
25
- "typecheck": "tsc --noEmit",
26
- "postinstall": "node scripts/postinstall.cjs",
27
- "prepublishOnly": "npm run build && npm test"
28
- },
29
- "keywords": [
30
- "focalapi",
31
- "ai",
32
- "agent",
33
- "cli",
34
- "llm",
35
- "image-generation",
36
- "video-generation"
37
- ],
38
- "license": "Apache-2.0",
39
- "repository": {
40
- "type": "git",
41
- "url": "git+https://github.com/focalapi/focalapi-cli.git"
42
- },
43
- "homepage": "https://github.com/focalapi/focalapi-cli#readme",
44
- "bugs": {
45
- "url": "https://github.com/focalapi/focalapi-cli/issues"
46
- },
47
- "dependencies": {
48
- "commander": "^12.1.0"
49
- },
50
- "devDependencies": {
51
- "@types/node": "^20.11.0",
52
- "tsup": "^8.2.4",
53
- "tsx": "^4.19.0",
54
- "typescript": "^5.5.4",
55
- "vitest": "^2.1.9"
56
- }
57
- }
1
+ {
2
+ "name": "focalapi-cli",
3
+ "version": "0.3.0",
4
+ "description": "让任意 AI Agent 直接调用 focalapi 创作模型的命令行工具",
5
+ "type": "module",
6
+ "bin": {
7
+ "focalapi": "dist/cli.js"
8
+ },
9
+ "files": [
10
+ "dist",
11
+ "scripts",
12
+ "skills",
13
+ "README.md",
14
+ "CHANGELOG.md",
15
+ "LICENSE"
16
+ ],
17
+ "engines": {
18
+ "node": ">=18"
19
+ },
20
+ "scripts": {
21
+ "dev": "tsx src/cli.ts",
22
+ "build": "tsup",
23
+ "test": "vitest run",
24
+ "test:watch": "vitest",
25
+ "typecheck": "tsc --noEmit",
26
+ "postinstall": "node scripts/postinstall.cjs",
27
+ "prepublishOnly": "npm run build && npm test"
28
+ },
29
+ "keywords": [
30
+ "focalapi",
31
+ "ai",
32
+ "agent",
33
+ "cli",
34
+ "llm",
35
+ "image-generation",
36
+ "video-generation"
37
+ ],
38
+ "license": "Apache-2.0",
39
+ "repository": {
40
+ "type": "git",
41
+ "url": "git+https://github.com/focalapi/focalapi-cli.git"
42
+ },
43
+ "homepage": "https://github.com/focalapi/focalapi-cli#readme",
44
+ "bugs": {
45
+ "url": "https://github.com/focalapi/focalapi-cli/issues"
46
+ },
47
+ "dependencies": {
48
+ "commander": "^12.1.0"
49
+ },
50
+ "devDependencies": {
51
+ "@types/node": "^20.11.0",
52
+ "tsup": "^8.2.4",
53
+ "tsx": "^4.19.0",
54
+ "typescript": "^5.5.4",
55
+ "vitest": "^2.1.9"
56
+ }
57
+ }
@@ -1,41 +1,41 @@
1
- #!/usr/bin/env node
2
-
3
- /**
4
- * Best-effort Agent integration after global npm installation.
5
- *
6
- * Run local connect only: do not access the network, read an API key, or change an Agent provider.
7
- * Missing Agents or integration failures never fail CLI installation; users can run focalapi connect later.
8
- */
9
-
10
- const { existsSync } = require('node:fs');
11
- const { join } = require('node:path');
12
- const { spawnSync } = require('node:child_process');
13
-
14
- if (process.env.FOCALAPI_SKIP_POSTINSTALL === '1' || process.env.CI === '1' || process.env.CI === 'true') {
15
- process.exit(0);
16
- }
17
-
18
- const cli = join(__dirname, '..', 'dist', 'cli.js');
19
- if (!existsSync(cli)) process.exit(0);
20
-
21
- const result = spawnSync(process.execPath, [cli, 'connect', 'install', '--json'], {
22
- encoding: 'utf8',
23
- env: process.env,
24
- windowsHide: true,
25
- });
26
-
27
- if (result.status === 0) {
28
- try {
29
- const output = JSON.parse(result.stdout || '{}');
30
- const count = Array.isArray(output.installed) ? output.installed.length : 0;
31
- if (count > 0) console.log(`focalapi-cli: 已自动接入 ${count} 个 Agent Skills 目录;重启 Agent 后生效。`);
32
- } catch {
33
- // Unparseable output after a successful connect must not fail installation.
34
- }
35
- process.exit(0);
36
- }
37
-
38
- if (!String(result.stderr).includes('未检测到本机 Agent')) {
39
- console.warn('focalapi-cli: Agent Skills 自动接入未完成;请稍后运行 `focalapi connect`。');
40
- }
41
- process.exit(0);
1
+ #!/usr/bin/env node
2
+
3
+ /**
4
+ * Best-effort Agent integration after global npm installation.
5
+ *
6
+ * Run local connect only: do not access the network, read an API key, or change an Agent provider.
7
+ * Missing Agents or integration failures never fail CLI installation; users can run focalapi connect later.
8
+ */
9
+
10
+ const { existsSync } = require('node:fs');
11
+ const { join } = require('node:path');
12
+ const { spawnSync } = require('node:child_process');
13
+
14
+ if (process.env.FOCALAPI_SKIP_POSTINSTALL === '1' || process.env.CI === '1' || process.env.CI === 'true') {
15
+ process.exit(0);
16
+ }
17
+
18
+ const cli = join(__dirname, '..', 'dist', 'cli.js');
19
+ if (!existsSync(cli)) process.exit(0);
20
+
21
+ const result = spawnSync(process.execPath, [cli, 'connect', 'install', '--json'], {
22
+ encoding: 'utf8',
23
+ env: process.env,
24
+ windowsHide: true,
25
+ });
26
+
27
+ if (result.status === 0) {
28
+ try {
29
+ const output = JSON.parse(result.stdout || '{}');
30
+ const count = Array.isArray(output.installed) ? output.installed.length : 0;
31
+ if (count > 0) console.log(`focalapi-cli: 已自动接入 ${count} 个 Agent Skills 目录;重启 Agent 后生效。`);
32
+ } catch {
33
+ // Unparseable output after a successful connect must not fail installation.
34
+ }
35
+ process.exit(0);
36
+ }
37
+
38
+ if (!String(result.stderr).includes('未检测到本机 Agent')) {
39
+ console.warn('focalapi-cli: Agent Skills 自动接入未完成;请稍后运行 `focalapi connect`。');
40
+ }
41
+ process.exit(0);
@@ -1,47 +1,48 @@
1
- ---
2
- name: focalapi
3
- version: 2.0.0
4
- description: "Primary router for FocalAPI creative models. Use when the user wants to generate, edit, or process creative media, choose a creative model, or inspect a generation task, even when the user does not mention FocalAPI. Covers automatic image and video model selection, generation, asynchronous continuation, and error routing."
5
- metadata:
6
- requires:
7
- bins: ["focalapi"]
8
- cliHelp: "focalapi --help"
9
- ---
10
-
11
- # FocalAPI creative-model routing
12
-
13
- FocalAPI is a creative-model gateway for the current Agent to call. It is not the Agent's own model or provider. Do not change the Agent's primary model configuration or require the user to say “use FocalAPI” first.
14
-
15
- ## Zero-guesswork execution contract
16
-
17
- 1. If the user does not specify a model, omit `--model`. The CLI selects a FocalAPI default from the live model pool and detailed contracts available to the current key. Do not generate a test sample first.
18
- 2. If the user specifies a model or provider, run `focalapi models get <model-id> --json` first. If the model ID is incomplete, run `models search` once to find the exact ID, then read its details.
19
- 3. Use only parameters and values listed in the detailed `supported_params`. Never infer support from a similar model.
20
- 4. Add `--json` for Agent and script calls. stdout is the only machine-readable result; diagnostics go to stderr.
21
- 5. After successful generation, return local absolute file paths to the user. If a video response contains `task_id`, follow `next_command`; never submit the same task again.
22
-
23
- ```bash
24
- # No model specified: run once without probing models first.
25
- focalapi gen image "<user prompt>" -o ./focalapi-out --json
26
- focalapi gen video "<user prompt>" --no-wait -o ./focalapi-out --json
27
-
28
- # Continue an asynchronous video task.
29
- focalapi task status <task-id> --json
30
- focalapi task download <task-id> -o ./focalapi-out --json
31
- ```
32
-
33
- ## Routing table
34
-
35
- | User goal | Entry point | Skill |
36
- | --- | --- | --- |
37
- | Generate or edit images; create from reference images | `focalapi gen image` | focalapi-gen |
38
- | Generate video; animate images or reference media | `focalapi gen video` | focalapi-gen |
39
- | Select, compare, or inspect model parameters | `focalapi models resolve/get/search` | focalapi-models |
40
- | Inspect progress or failures; download results | `focalapi task status/download` | focalapi-task |
41
- | Resolve key, sign-in, or 401 issues | `focalapi auth status/login` | focalapi-auth |
42
- | Inspect quota, usage, or service failures | `focalapi usage/doctor` | focalapi-usage |
43
- | Provide text assistance explicitly requested by the user | `focalapi chat` | focalapi-chat |
44
-
45
- The fully validated automatic generation paths currently cover images and video. Audio, 3D, or another modality may be used only after both CLI help and `models get` expose an executable contract. Never infer a capability from a model list or name alone.
46
-
47
- If a business command returns `missing_api_key`, route to focalapi-auth and return to the original task immediately after sign-in. For other errors, follow `{error.code, error.hint}` once; do not rotate models blindly.
1
+ ---
2
+ name: focalapi
3
+ version: 2.0.0
4
+ description: "Primary router for FocalAPI creative models. Use when the user wants to generate, edit, or process creative media, choose a creative model, or inspect a generation task, even when the user does not mention FocalAPI. Covers automatic image and video model selection, generation, asynchronous continuation, and error routing."
5
+ metadata:
6
+ requires:
7
+ bins: ["focalapi"]
8
+ cliHelp: "focalapi --help"
9
+ ---
10
+
11
+ # FocalAPI creative-model routing
12
+
13
+ FocalAPI is a creative-model gateway for the current Agent to call. It is not the Agent's own model or provider. Do not change the Agent's primary model configuration or require the user to say “use FocalAPI” first.
14
+
15
+ ## Zero-guesswork execution contract
16
+
17
+ 1. If the user does not specify a model, omit `--model`. The CLI selects a FocalAPI default from the live model pool and detailed contracts available to the current key. Do not generate a test sample first.
18
+ 2. If the user specifies a model or provider, run `focalapi models get <model-id> --json` first. If the model ID is incomplete, run `models search` once to find the exact ID, then read its details.
19
+ 3. Use only parameters and values listed in the detailed `supported_params`. Never infer support from a similar model.
20
+ 4. Add `--json` for Agent and script calls. stdout is the only machine-readable result; diagnostics go to stderr.
21
+ 5. After successful generation, return local absolute file paths to the user. If a video response contains `task_id`, follow `next_command`; never submit the same task again.
22
+
23
+ ```bash
24
+ # No model specified: run once without probing models first.
25
+ focalapi gen image "<user prompt>" -o ./focalapi-out --json
26
+ focalapi gen video "<user prompt>" --no-wait -o ./focalapi-out --json
27
+
28
+ # Continue an asynchronous video task.
29
+ focalapi task status <task-id> --json
30
+ focalapi task download <task-id> -o ./focalapi-out --json
31
+ focalapi task cancel <task-id> --json # queued tasks only; cancelled tasks are refunded
32
+ ```
33
+
34
+ ## Routing table
35
+
36
+ | User goal | Entry point | Skill |
37
+ | --- | --- | --- |
38
+ | Generate or edit images; create from reference images | `focalapi gen image` | focalapi-gen |
39
+ | Generate video; animate images or reference media | `focalapi gen video` | focalapi-gen |
40
+ | Select, compare, or inspect model parameters | `focalapi models resolve/get/search` | focalapi-models |
41
+ | Inspect progress or failures; cancel queued tasks; download results | `focalapi task status/cancel/download` | focalapi-task |
42
+ | Resolve key, sign-in, or 401 issues | `focalapi auth status/login` | focalapi-auth |
43
+ | Inspect quota, usage, or service failures | `focalapi usage/doctor` | focalapi-usage |
44
+ | Provide text assistance explicitly requested by the user | `focalapi chat` | focalapi-chat |
45
+
46
+ The fully validated automatic generation paths currently cover images and video. Audio, 3D, or another modality may be used only after both CLI help and `models get` expose an executable contract. Never infer a capability from a model list or name alone.
47
+
48
+ If a business command returns `missing_api_key`, route to focalapi-auth and return to the original task immediately after sign-in. For other errors, follow `{error.code, error.hint}` once; do not rotate models blindly.
@@ -1,28 +1,28 @@
1
- ---
2
- name: focalapi-auth
3
- version: 2.0.0
4
- description: "Handle focalapi-cli installation, first sign-in, key status, and 401/authentication errors. Trigger only during initial setup or when a business command explicitly returns missing_api_key or invalid_api_key. Return to the original creative task after authentication succeeds."
5
- metadata:
6
- requires:
7
- bins: ["focalapi"]
8
- cliHelp: "focalapi auth --help"
9
- ---
10
-
11
- # FocalAPI authentication
12
-
13
- ```bash
14
- npm i -g focalapi-cli
15
- focalapi auth login --key <sk-key>
16
- focalapi auth status --json
17
- focalapi connect
18
- ```
19
-
20
- Create a key at `https://focalapi.com/console/token`. Never reveal the complete key in a response, log, or echoed command. Prefer `FOCALAPI_API_KEY` in CI and sandbox environments.
21
-
22
- Do not run `auth status` before every business command. After an authentication error, follow this fixed path:
23
-
24
- - `missing_api_key`: sign in or set `FOCALAPI_API_KEY`.
25
- - `invalid_api_key`: ask the user to verify or create a key in the console, then sign in again.
26
- - `upstream_auth_failed`: the FocalAPI key may be valid. Preserve the request ID and escalate to the service operator; do not repeatedly replace the user's key.
27
-
28
- Retry the original business command immediately after authentication succeeds. Signing in is not the end of the task.
1
+ ---
2
+ name: focalapi-auth
3
+ version: 2.0.0
4
+ description: "Handle focalapi-cli installation, first sign-in, key status, and 401/authentication errors. Trigger only during initial setup or when a business command explicitly returns missing_api_key or invalid_api_key. Return to the original creative task after authentication succeeds."
5
+ metadata:
6
+ requires:
7
+ bins: ["focalapi"]
8
+ cliHelp: "focalapi auth --help"
9
+ ---
10
+
11
+ # FocalAPI authentication
12
+
13
+ ```bash
14
+ npm i -g focalapi-cli
15
+ focalapi auth login --key <sk-key>
16
+ focalapi auth status --json
17
+ focalapi connect
18
+ ```
19
+
20
+ Create a key at `https://focalapi.com/console/token`. Never reveal the complete key in a response, log, or echoed command. Prefer `FOCALAPI_API_KEY` in CI and sandbox environments.
21
+
22
+ Do not run `auth status` before every business command. After an authentication error, follow this fixed path:
23
+
24
+ - `missing_api_key`: sign in or set `FOCALAPI_API_KEY`.
25
+ - `invalid_api_key`: ask the user to verify or create a key in the console, then sign in again.
26
+ - `upstream_auth_failed`: the FocalAPI key may be valid. Preserve the request ID and escalate to the service operator; do not repeatedly replace the user's key.
27
+
28
+ Retry the original business command immediately after authentication succeeds. Signing in is not the end of the task.
@@ -1,29 +1,29 @@
1
- ---
2
- name: focalapi-chat
3
- version: 2.0.0
4
- description: "Supplementary FocalAPI text and audio commands. Use only when the user explicitly requests text assistance through FocalAPI or when the live model contract confirms an available audio model. Route image and video creation to focalapi-gen."
5
- metadata:
6
- requires:
7
- bins: ["focalapi"]
8
- cliHelp: "focalapi chat --help"
9
- ---
10
-
11
- # Supplementary FocalAPI capabilities
12
-
13
- This Skill is not the default route for creative requests. Route images, video, image editing, and image-to-video work to `focalapi-gen`.
14
-
15
- When the user explicitly requests text assistance, get an available text model from the live list before calling it:
16
-
17
- ```bash
18
- focalapi models list --json
19
- focalapi chat "<user text task>" -m <text-model-from-list> --json
20
- ```
21
-
22
- Use audio commands only when both `focalapi models get <model-id> --json` and `focalapi audio --help` confirm an executable contract:
23
-
24
- ```bash
25
- focalapi audio transcribe <file> -m <model-id> --json
26
- focalapi audio speech "<text>" -m <model-id> -o <file> --json
27
- ```
28
-
29
- A name appearing in the model list does not prove that the CLI supports calling it. If the current key has no audio model contract, state that audio is unavailable; do not try a similar model or an external API.
1
+ ---
2
+ name: focalapi-chat
3
+ version: 2.0.0
4
+ description: "Supplementary FocalAPI text and audio commands. Use only when the user explicitly requests text assistance through FocalAPI or when the live model contract confirms an available audio model. Route image and video creation to focalapi-gen."
5
+ metadata:
6
+ requires:
7
+ bins: ["focalapi"]
8
+ cliHelp: "focalapi chat --help"
9
+ ---
10
+
11
+ # Supplementary FocalAPI capabilities
12
+
13
+ This Skill is not the default route for creative requests. Route images, video, image editing, and image-to-video work to `focalapi-gen`.
14
+
15
+ When the user explicitly requests text assistance, get an available text model from the live list before calling it:
16
+
17
+ ```bash
18
+ focalapi models list --json
19
+ focalapi chat "<user text task>" -m <text-model-from-list> --json
20
+ ```
21
+
22
+ Use audio commands only when both `focalapi models get <model-id> --json` and `focalapi audio --help` confirm an executable contract:
23
+
24
+ ```bash
25
+ focalapi audio transcribe <file> -m <model-id> --json
26
+ focalapi audio speech "<text>" -m <model-id> -o <file> --json
27
+ ```
28
+
29
+ A name appearing in the model list does not prove that the CLI supports calling it. If the current key has no audio model contract, state that audio is unavailable; do not try a similar model or an external API.
@@ -1,6 +1,6 @@
1
1
  ---
2
2
  name: focalapi-gen
3
- version: 2.0.0
3
+ version: 2.2.0
4
4
  description: "Use FocalAPI for image and video generation, image editing, image-to-video, and reference-media creation. Trigger directly when the user asks to draw, generate or edit an image, create video, or animate media, even without naming FocalAPI. Select a model automatically by default and do not probe models first."
5
5
  metadata:
6
6
  requires:
@@ -32,7 +32,10 @@ focalapi gen video "<prompt>" -m <model-id> [contract-supported options] --no-wa
32
32
  ```
33
33
 
34
34
  - Use `--image <url...>` for image editing and reference images. Pass `--mask` only when the contract lists it.
35
- - Use `--image <url...>` for video reference images. Pass duration, resolution, aspect ratio, and audio options only as allowed by `supported_params`.
35
+ - Use `--negative-prompt`, `--creativity`, `--prompt-extend`, `--style-references`, and `--moodboards` only when the image contract lists the corresponding field.
36
+ - For video inputs, `--image <url...>` means reference images (Grok 1.5 reference-to-video, capped at 720p and 7 images) and `--first-frame <url>` means image-to-video from a single starting frame. The two flags are mutually exclusive and both are validated against the live contract before submission.
37
+ - Pass duration, resolution, aspect ratio, and audio options only as allowed by `supported_params`.
38
+ - Use `--content '<json-array>'` for models such as LTX 2.5, FLUX 3, Kling 3.0, and Vidu Q3 when the contract requires role-aware media content. LTX also exposes `--fps`; FLUX 3 exposes `--safety-tolerance` (0-4 text-to-video, capped at 2 once images are attached).
36
39
  - Never copy one model's `ratio`, `aspect_ratio`, `size`, or `resolution` to another model.
37
40
  - Use `gen gemini-image` only when the user explicitly selects a native Gemini image model. Continue to use the automatic `gen image` entry point for ordinary requests.
38
41
 
@@ -46,3 +49,8 @@ focalapi task download <task-id> -o ./focalapi-out --json
46
49
  ```
47
50
 
48
51
  `pending` and `running` are not failures. Keep checking the same `task_id` and never resubmit generation. On failure, read the structured `error.code` and `hint`, and fix only the explicit problem instead of rotating models blindly.
52
+
53
+ Two transient outcomes need no parameter changes:
54
+
55
+ - `capacity_exhausted` (HTTP 503): the platform queue is full. Retry the same command after roughly 10 seconds; do not switch models or shrink the request.
56
+ - `expired` on a task: submission state stayed unknown past the 10-minute reconciliation window; the charge is refunded automatically. Resubmitting once is correct.
@@ -1,6 +1,6 @@
1
1
  ---
2
2
  name: focalapi-models
3
- version: 2.0.0
3
+ version: 2.1.0
4
4
  description: "Select FocalAPI creative models and inspect live parameter contracts. Use when the user does not specify a model, names a model or provider, compares models, or encounters a generation-parameter error. Use resolve to obtain a callable default and never infer capabilities from names or probe models one by one."
5
5
  metadata:
6
6
  requires:
@@ -47,3 +47,9 @@ Rules:
47
47
  2. Do not send generation requests to models one by one as an availability test. Discovery and detail queries are read-only preflight checks.
48
48
  3. If an explicitly selected model is unavailable, present available candidates or return to `models resolve`; never replace it silently.
49
49
  4. Return to the user's original generation task after the query instead of stopping at the model list.
50
+
51
+ ## Current verified creative families
52
+
53
+ The maintained defaults currently prefer Seedream 5.0, GPT Image 2, Gemini 3.1 Image, Grok Imagine Image 2.0, Kling Image 3.0, Qwen Image 3.0, and Krea 2 for images. Video selection currently covers Seedance 2.5, Kling 3.0, Vidu Q3, Gemini Omni Flash, Grok Imagine Video 1.5, LTX 2.5, and FLUX 3.
54
+
55
+ These names are routing context, not permission to guess a model ID. Use the exact canonical ID returned by `models resolve` or `models get`. Removed IDs, including the former Veo 3.1 preview models, must not be retried.
@@ -1,25 +1,29 @@
1
- ---
2
- name: focalapi-task
3
- version: 2.0.0
4
- description: "Continue asynchronous FocalAPI image or video tasks and download their outputs. Use when a generation response contains task_id or next_command, or when the user asks about progress, failure reasons, or result files. Reuse the original task_id and never generate again."
5
- metadata:
6
- requires:
7
- bins: ["focalapi"]
8
- cliHelp: "focalapi task --help"
9
- ---
10
-
11
- # Complete asynchronous FocalAPI tasks
12
-
13
- After a generation command returns `task_id`, prefer the response's `next_command`:
14
-
15
- ```bash
16
- focalapi task status <task-id> --json
17
- focalapi task download <task-id> -o ./focalapi-out --json
18
- ```
19
-
20
- - `pending` or `running`: this is still the same valid task. Check it later and do not resubmit generation.
21
- - `success`: run download, verify that the file exists, and return its absolute path to the user.
22
- - `failed`: show the upstream error summary and hint. Generate again only when an explicit parameter or content issue requires it.
23
- - `unknown`: preserve the raw response and run `focalapi doctor --json`; never fabricate a success state.
24
-
25
- Polling must be bounded. When the user does not ask for blocking wait behavior, report the current status and `task_id`.
1
+ ---
2
+ name: focalapi-task
3
+ version: 2.1.0
4
+ description: "Continue asynchronous FocalAPI image or video tasks, cancel queued tasks, and download their outputs. Use when a generation response contains task_id or next_command, or when the user asks about progress, failure reasons, cancellation, or result files. Reuse the original task_id and never generate again."
5
+ metadata:
6
+ requires:
7
+ bins: ["focalapi"]
8
+ cliHelp: "focalapi task --help"
9
+ ---
10
+
11
+ # Complete asynchronous FocalAPI tasks
12
+
13
+ After a generation command returns `task_id`, prefer the response's `next_command`:
14
+
15
+ ```bash
16
+ focalapi task status <task-id> --json
17
+ focalapi task download <task-id> -o ./focalapi-out --json
18
+ focalapi task cancel <task-id> --json
19
+ ```
20
+
21
+ - `pending` or `running`: this is still the same valid task. Check it later and do not resubmit generation.
22
+ - `success`: run download, verify that the file exists, and return its absolute path to the user.
23
+ - `failed`: show the upstream error summary and hint. Generate again only when an explicit parameter or content issue requires it. A raw status of `expired` means the submission state stayed unknown past the reconciliation window; the charge was refunded automatically.
24
+ - `cancelled`: the task was stopped; a cancelled queued task is refunded. Do not download or resubmit unless the user asks for a new attempt.
25
+ - `unknown`: preserve the raw response and run `focalapi doctor --json`; never fabricate a success state.
26
+
27
+ `task cancel` only works while a task is still queued (`pending`). A 409 `task_already_running` means generation already started and cannot be stopped — keep tracking with `task status`. Cancellation failures return explicit codes (`task_already_finished`, `task_cancel_failed`); follow `error.hint` instead of retrying blindly.
28
+
29
+ Polling must be bounded. When the user does not ask for blocking wait behavior, report the current status and `task_id`.
@@ -1,26 +1,27 @@
1
- ---
2
- name: focalapi-usage
3
- version: 2.0.0
4
- description: "Inspect FocalAPI quota, usage, and billing, or diagnose network, authentication, and service errors. Use when the user asks about spend or balance, or when a failed business command needs an error-code-driven resolution. Do not add mandatory diagnostics before normal generation."
5
- metadata:
6
- requires:
7
- bins: ["focalapi"]
8
- cliHelp: "focalapi usage --help"
9
- ---
10
-
11
- # FocalAPI usage and diagnostics
12
-
13
- ```bash
14
- focalapi usage --json
15
- focalapi auth status --json
16
- focalapi doctor --json
17
- ```
18
-
19
- - For quota, balance, usage, or billing questions, run `usage`.
20
- - For `missing_api_key` or `invalid_api_key`, route to focalapi-auth.
21
- - For `insufficient_quota`, run `usage`, explain the shortfall, and do not add funds automatically.
22
- - For `network_error`, `timeout`, or 5xx errors, run `doctor` once and follow `checks[].hint`.
23
- - For `invalid_request`, return to the live `models get` parameter contract and do not resend the same request.
24
- - For `upstream_auth_failed`, preserve the request ID and escalate to the service operator; do not ask the user to replace the FocalAPI key.
25
-
26
- Do not run `doctor` or a free rehearsal before a normal business command that has not failed. The Agent should complete the user's creative goal directly and avoid unrelated calls.
1
+ ---
2
+ name: focalapi-usage
3
+ version: 2.0.0
4
+ description: "Inspect FocalAPI quota, usage, and billing, or diagnose network, authentication, and service errors. Use when the user asks about spend or balance, or when a failed business command needs an error-code-driven resolution. Do not add mandatory diagnostics before normal generation."
5
+ metadata:
6
+ requires:
7
+ bins: ["focalapi"]
8
+ cliHelp: "focalapi usage --help"
9
+ ---
10
+
11
+ # FocalAPI usage and diagnostics
12
+
13
+ ```bash
14
+ focalapi usage --json
15
+ focalapi auth status --json
16
+ focalapi doctor --json
17
+ ```
18
+
19
+ - For quota, balance, usage, or billing questions, run `usage`.
20
+ - For `missing_api_key` or `invalid_api_key`, route to focalapi-auth.
21
+ - For `insufficient_quota`, run `usage`, explain the shortfall, and do not add funds automatically.
22
+ - For `capacity_exhausted` (HTTP 503), wait about 10 seconds and retry the exact same command; the queue admission gate is full and parameters are not the problem.
23
+ - For `network_error`, `timeout`, or 5xx errors, run `doctor` once and follow `checks[].hint`.
24
+ - For `invalid_request`, return to the live `models get` parameter contract and do not resend the same request.
25
+ - For `upstream_auth_failed`, preserve the request ID and escalate to the service operator; do not ask the user to replace the FocalAPI key.
26
+
27
+ Do not run `doctor` or a free rehearsal before a normal business command that has not failed. The Agent should complete the user's creative goal directly and avoid unrelated calls.