image-skill 0.1.12 → 0.1.14
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/CHANGELOG.md +17 -5
- package/PROVENANCE.md +12 -0
- package/README.md +30 -19
- package/bin/image-skill.mjs +1186 -40
- package/cli.md +146 -55
- package/llms.txt +42 -27
- package/package.json +1 -1
- package/skill.md +99 -58
- package/skills/image-skill/SKILL.md +99 -58
- package/skills/image-skill/references/cli.md +146 -55
- package/skills/image-skill/references/llms.txt +42 -27
package/cli.md
CHANGED
|
@@ -15,7 +15,11 @@ Public contract URLs:
|
|
|
15
15
|
## Global Rules
|
|
16
16
|
|
|
17
17
|
- Every command that agents use must support `--json`.
|
|
18
|
-
- JSON
|
|
18
|
+
- JSON is the default public CLI output. `--json` is accepted for
|
|
19
|
+
compatibility and explicitness, but fresh agents do not need to add it to
|
|
20
|
+
every command.
|
|
21
|
+
- JSON output must use the standard envelope from
|
|
22
|
+
`https://image-skill.com/llms.txt`.
|
|
19
23
|
- Commands must have deterministic exit codes.
|
|
20
24
|
- Commands must emit service telemetry unless running in a documented no-telemetry test mode.
|
|
21
25
|
- Commands must not print secrets after initial creation.
|
|
@@ -48,39 +52,61 @@ Checks thin CLI/client health, hosted service reachability, auth state, local ou
|
|
|
48
52
|
image-skill doctor --json
|
|
49
53
|
```
|
|
50
54
|
|
|
55
|
+
### `image-skill trust`
|
|
56
|
+
|
|
57
|
+
Returns a no-auth, no-spend evidence packet for tool selection and package
|
|
58
|
+
provenance checks.
|
|
59
|
+
|
|
60
|
+
```bash
|
|
61
|
+
image-skill trust --json
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
The packet uses `schema: "image-skill.trust-packet.v0"` and reports the public
|
|
65
|
+
CLI version, npm metadata status, public repo mapping when inferable, hosted
|
|
66
|
+
contract document hashes, hosted `/healthz`, `/v1/models` availability, safe
|
|
67
|
+
copyable commands, proof URL placeholders, and redaction guarantees.
|
|
68
|
+
|
|
69
|
+
Use `trust` when deciding whether Image Skill is current and honest enough to
|
|
70
|
+
select. It is not a required setup step before the first image; the canonical
|
|
71
|
+
fresh-agent creative entrypoint remains `image-skill create --guide`.
|
|
72
|
+
|
|
73
|
+
If package metadata, hosted docs, API health, or model availability cannot be
|
|
74
|
+
verified, the command still returns a packet with explicit `unreachable`,
|
|
75
|
+
`not_available_yet`, `inspect_only`, or `stale_or_mismatched` states rather
|
|
76
|
+
than omitting the field.
|
|
77
|
+
|
|
51
78
|
### `image-skill signup --agent`
|
|
52
79
|
|
|
53
80
|
Bootstraps restricted agent access.
|
|
54
81
|
|
|
55
82
|
```bash
|
|
56
83
|
image-skill signup --agent \
|
|
57
|
-
--agent-contact agent-
|
|
84
|
+
--agent-contact agent-inbox@example.com \
|
|
58
85
|
--agent-name creative-agent \
|
|
59
86
|
--runtime codex \
|
|
60
|
-
--save \
|
|
61
87
|
--json
|
|
62
88
|
```
|
|
63
89
|
|
|
64
|
-
|
|
65
|
-
permissions and redacts it from stdout.
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
90
|
+
By default, signup stores the returned `isk_r_` token in the public CLI config
|
|
91
|
+
with 0600 permissions and redacts it from stdout. `--save` remains accepted as
|
|
92
|
+
a compatibility no-op for older instructions. Use `--no-save` only when local
|
|
93
|
+
persistence is intentionally disabled, and use `--show-token --no-save` only
|
|
94
|
+
when the agent runtime has a separate secret store and needs the raw token once.
|
|
95
|
+
Do not paste tokens into prompts, logs, issue text, or feedback.
|
|
96
|
+
|
|
97
|
+
In this preview contract, `--agent-contact` is an email-shaped durable contact
|
|
98
|
+
inbox for the restricted agent identity, not a requirement to find an
|
|
99
|
+
individual human. Use an agent-owned inbox when available; otherwise use an
|
|
100
|
+
operator, team, or sponsor inbox that can receive future claim, billing, or
|
|
101
|
+
abuse notices. Do not block waiting for a person, invent a person, or use a
|
|
102
|
+
throwaway inbox.
|
|
74
103
|
`example.invalid` addresses are only appropriate inside documented harness or
|
|
75
104
|
proof runs. `--human-email` remains accepted as a compatibility alias for
|
|
76
105
|
`--agent-contact`.
|
|
77
106
|
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
```bash
|
|
82
|
-
export IMAGE_SKILL_TOKEN="isk_r_..."
|
|
83
|
-
```
|
|
107
|
+
If the runtime has a separate secret store, it may provide the token to commands
|
|
108
|
+
as `IMAGE_SKILL_TOKEN`. Keep that value outside prompts, logs, issue text, and
|
|
109
|
+
feedback.
|
|
84
110
|
|
|
85
111
|
If the agent runtime can hand secrets to a command over stdin, avoid exporting
|
|
86
112
|
the token and use `--token-stdin` instead:
|
|
@@ -92,6 +118,38 @@ printf '%s\n' "$IMAGE_SKILL_TOKEN" | image-skill usage quota --token-stdin --jso
|
|
|
92
118
|
`--api-base-url` is an advanced preview/test override; production public agents
|
|
93
119
|
should omit it.
|
|
94
120
|
|
|
121
|
+
### First Run Sequence
|
|
122
|
+
|
|
123
|
+
Use the no-spend guide first. It checks health, executable model availability,
|
|
124
|
+
auth/quota when a token already exists, and payment rails, then returns one
|
|
125
|
+
`data.next_command`. Guide mode does not create a signup, provider job,
|
|
126
|
+
dry-run job, payment object, credit debit, or asset.
|
|
127
|
+
|
|
128
|
+
```bash
|
|
129
|
+
image-skill create --guide --prompt "a compact field camera on a stainless workbench"
|
|
130
|
+
```
|
|
131
|
+
|
|
132
|
+
Read `data.stage`. If it returns `auth_required`, run `data.next_command` and
|
|
133
|
+
rerun the guide. If it returns `quota_required`, inspect the payment commands
|
|
134
|
+
it provides. If it returns `ready_to_create`, run `data.next_command`.
|
|
135
|
+
|
|
136
|
+
Manual inspection remains available when the guide asks for it or when a task
|
|
137
|
+
needs deeper capability detail:
|
|
138
|
+
|
|
139
|
+
```bash
|
|
140
|
+
image-skill trust
|
|
141
|
+
image-skill doctor
|
|
142
|
+
image-skill models list
|
|
143
|
+
image-skill models show openai.gpt-image-2
|
|
144
|
+
image-skill whoami
|
|
145
|
+
image-skill usage quota
|
|
146
|
+
image-skill create --dry-run --prompt "a compact field camera on a stainless workbench"
|
|
147
|
+
```
|
|
148
|
+
|
|
149
|
+
Use `--show-token` only when the runtime has a separate secret store and needs
|
|
150
|
+
the raw token once. Otherwise prefer saved auth; it keeps tokens out of prompts,
|
|
151
|
+
logs, and shell history.
|
|
152
|
+
|
|
95
153
|
### Local Config And Install
|
|
96
154
|
|
|
97
155
|
Prefer package execution in fresh agent sandboxes:
|
|
@@ -113,22 +171,20 @@ npx -y image-skill@latest doctor --json
|
|
|
113
171
|
|
|
114
172
|
Saved auth state defaults to
|
|
115
173
|
`${XDG_CONFIG_HOME:-~/.config}/image-skill/config.json`. If that location is
|
|
116
|
-
read-only, set a writable config path before `signup
|
|
174
|
+
read-only, set a writable config path before `signup`:
|
|
117
175
|
|
|
118
176
|
```bash
|
|
119
177
|
export IMAGE_SKILL_CONFIG_PATH="$PWD/.image-skill/config.json"
|
|
120
178
|
npx -y image-skill@latest signup --agent \
|
|
121
|
-
--agent-contact agent-
|
|
179
|
+
--agent-contact agent-inbox@example.com \
|
|
122
180
|
--agent-name creative-agent \
|
|
123
181
|
--runtime codex \
|
|
124
|
-
--save \
|
|
125
182
|
--json
|
|
126
183
|
```
|
|
127
184
|
|
|
128
185
|
Config write failures return `PUBLIC_CLI_CONFIG_WRITE_FAILED` with a structured
|
|
129
186
|
`error.recovery.suggested_command`. Agents should follow that recovery field,
|
|
130
|
-
then
|
|
131
|
-
creative flow.
|
|
187
|
+
then rerun `create --guide` for the requested creative flow.
|
|
132
188
|
|
|
133
189
|
### `image-skill whoami`
|
|
134
190
|
|
|
@@ -460,6 +516,9 @@ capability-preserving schema for one model.
|
|
|
460
516
|
```bash
|
|
461
517
|
image-skill models --json
|
|
462
518
|
image-skill models list --json
|
|
519
|
+
image-skill models list --available --operation image.generate --json
|
|
520
|
+
image-skill models list --available --operation image.edit --json
|
|
521
|
+
image-skill models list --catalog-only --provider fal --json
|
|
463
522
|
image-skill models show MODEL_ID --json
|
|
464
523
|
```
|
|
465
524
|
|
|
@@ -477,6 +536,17 @@ seeds, masks, reference images, transparent backgrounds, arbitrary aspect
|
|
|
477
536
|
ratios, image-size presets, output counts, resolution controls, safety
|
|
478
537
|
controls, or provider-native options.
|
|
479
538
|
|
|
539
|
+
`models list` is executable-first by default and returns `summary` with total,
|
|
540
|
+
returned, available, executable, catalog-only, provider split, first actionable
|
|
541
|
+
model ids, recommended filter commands, and full-catalog flags. Use
|
|
542
|
+
`--available` for currently usable executable rows, `--operation
|
|
543
|
+
image.generate` or `--operation image.edit` for the task, `--provider fal|xai|openai`
|
|
544
|
+
to narrow by provider, and `--catalog-only` when you intentionally want
|
|
545
|
+
source-backed rows that are inspectable but not runnable yet. Provider-level
|
|
546
|
+
availability is not the same thing as model executability; for runnable
|
|
547
|
+
choices require both `status:"available"` and
|
|
548
|
+
`execution.model_execution_status:"executable"`.
|
|
549
|
+
|
|
480
550
|
Image Skill standardizes common controls so agents can work quickly, but it
|
|
481
551
|
must not flatten rich model capabilities into coarse universal categories.
|
|
482
552
|
Use `model_parameters` for rare or model-specific parameters advertised by the
|
|
@@ -550,14 +620,26 @@ image-skill capabilities show CAPABILITY_ID --json
|
|
|
550
620
|
|
|
551
621
|
### `image-skill create`
|
|
552
622
|
|
|
553
|
-
|
|
623
|
+
Guides, creates, or plans a zero-cost dry run.
|
|
624
|
+
|
|
625
|
+
Guide the first image path without mutation:
|
|
626
|
+
|
|
627
|
+
```bash
|
|
628
|
+
image-skill create --guide --prompt "A compact field camera on a stainless workbench" --json
|
|
629
|
+
```
|
|
630
|
+
|
|
631
|
+
`create --guide` returns `schema: image-skill.create-guide.v1`,
|
|
632
|
+
`stage`, `next_command`, `escape_hatches`, selected executable model and cost,
|
|
633
|
+
auth/quota/payment blockers, and mutation flags. All mutation flags must be
|
|
634
|
+
false in guide mode: no provider call, hosted create, signup, payment object,
|
|
635
|
+
credit debit, or media write.
|
|
554
636
|
|
|
555
637
|
```bash
|
|
556
638
|
image-skill create \
|
|
557
639
|
--prompt "A compact field camera on a stainless workbench" \
|
|
558
640
|
--intent explore \
|
|
559
641
|
--aspect-ratio 1:1 \
|
|
560
|
-
--max-estimated-usd-per-image 0.
|
|
642
|
+
--max-estimated-usd-per-image 0.07 \
|
|
561
643
|
--json
|
|
562
644
|
```
|
|
563
645
|
|
|
@@ -571,6 +653,9 @@ higher output tier only when `--max-estimated-usd-per-image` is high enough for
|
|
|
571
653
|
that tier; otherwise it stays on a lower-cost quality tier or chooses a cheaper
|
|
572
654
|
capability within the budget and tells agents what happened in the selection
|
|
573
655
|
receipt.
|
|
656
|
+
Use `0.05` only when intentionally budget-capping to a lower-cost or
|
|
657
|
+
lower-resolution path; the current no-model quality default needs `0.07` to
|
|
658
|
+
permit the 2k plan.
|
|
574
659
|
|
|
575
660
|
Preview-compatible richer shape:
|
|
576
661
|
|
|
@@ -680,6 +765,10 @@ and never executes provider controls or consumes credits.
|
|
|
680
765
|
For dry-run responses, `cost.credit_pricing.credits_required` is the planned
|
|
681
766
|
live execution debit for the selected model. The actual debit for the dry run is
|
|
682
767
|
`quota.consumed_credits: 0`.
|
|
768
|
+
Authenticated hosted create dry-runs also create a recoverable planned job:
|
|
769
|
+
`jobs show` returns `status: "planned"` with `plan_receipt`, and `activity`
|
|
770
|
+
emits `job.planned`. Planned receipts do not create downloadable media assets or
|
|
771
|
+
usage debits.
|
|
683
772
|
|
|
684
773
|
Minimum success data:
|
|
685
774
|
|
|
@@ -687,7 +776,7 @@ Minimum success data:
|
|
|
687
776
|
{
|
|
688
777
|
"job_id": "job_...",
|
|
689
778
|
"capability": {
|
|
690
|
-
"id": "is.image.generate.
|
|
779
|
+
"id": "is.image.generate.xai-grok-imagine-image-quality.v1"
|
|
691
780
|
},
|
|
692
781
|
"assets": [
|
|
693
782
|
{
|
|
@@ -696,17 +785,17 @@ Minimum success data:
|
|
|
696
785
|
"mime_type": "image/png",
|
|
697
786
|
"url": "https://media.image-skill.com/a/image_abc123.png",
|
|
698
787
|
"content_length": 333444,
|
|
699
|
-
"width":
|
|
700
|
-
"height":
|
|
788
|
+
"width": 2048,
|
|
789
|
+
"height": 2048
|
|
701
790
|
}
|
|
702
791
|
],
|
|
703
792
|
"cost": {
|
|
704
|
-
"estimated_usd": 0.
|
|
793
|
+
"estimated_usd": 0.07,
|
|
705
794
|
"credit_pricing": {
|
|
706
795
|
"credit_unit_usd": 0.01,
|
|
707
|
-
"credits_required":
|
|
708
|
-
"estimated_provider_cost_usd": 0.
|
|
709
|
-
"estimated_revenue_usd": 0.
|
|
796
|
+
"credits_required": 12,
|
|
797
|
+
"estimated_provider_cost_usd": 0.07,
|
|
798
|
+
"estimated_revenue_usd": 0.12,
|
|
710
799
|
"pricing_confidence": "known"
|
|
711
800
|
}
|
|
712
801
|
},
|
|
@@ -721,14 +810,14 @@ Minimum success data:
|
|
|
721
810
|
},
|
|
722
811
|
"model_parameters": {
|
|
723
812
|
"keys": ["resolution"],
|
|
724
|
-
"defaults_applied": ["resolution=
|
|
813
|
+
"defaults_applied": ["resolution=2k"],
|
|
725
814
|
"source": "default_policy"
|
|
726
815
|
},
|
|
727
816
|
"output": {
|
|
728
|
-
"resolution_class": "
|
|
817
|
+
"resolution_class": "2k",
|
|
729
818
|
"expected_width": null,
|
|
730
819
|
"expected_height": null,
|
|
731
|
-
"expected_min_short_edge":
|
|
820
|
+
"expected_min_short_edge": 2048
|
|
732
821
|
}
|
|
733
822
|
}
|
|
734
823
|
},
|
|
@@ -762,10 +851,7 @@ curl -sS https://api.image-skill.com/v1/create \
|
|
|
762
851
|
"intent": "explore",
|
|
763
852
|
"aspect_ratio": "1:1",
|
|
764
853
|
"output_count": 1,
|
|
765
|
-
"max_estimated_usd_per_image": 0.
|
|
766
|
-
"model_parameters": {
|
|
767
|
-
"seed": 1234
|
|
768
|
-
}
|
|
854
|
+
"max_estimated_usd_per_image": 0.07
|
|
769
855
|
}'
|
|
770
856
|
```
|
|
771
857
|
|
|
@@ -1117,27 +1203,32 @@ Activity `type` values are stable public contract values. Do not infer new
|
|
|
1117
1203
|
event names from provider responses or telemetry logs; use only the registry
|
|
1118
1204
|
below.
|
|
1119
1205
|
|
|
1120
|
-
| Event type | Subject | Operation | Emitted when
|
|
1121
|
-
| ------------------------------------------ | ---------- | ----------- |
|
|
1122
|
-
| `job.completed` | `job` | create/edit | A hosted create or edit job reaches a terminal state.
|
|
1123
|
-
| `
|
|
1124
|
-
| `asset.
|
|
1125
|
-
| `
|
|
1126
|
-
| `
|
|
1127
|
-
| `feedback.
|
|
1128
|
-
| `
|
|
1129
|
-
| `
|
|
1130
|
-
| `credits.
|
|
1131
|
-
| `credits.
|
|
1132
|
-
| `credits.
|
|
1133
|
-
| `credits.
|
|
1134
|
-
| `credits.
|
|
1206
|
+
| Event type | Subject | Operation | Emitted when | Stable links |
|
|
1207
|
+
| ------------------------------------------ | ---------- | ----------- | ------------------------------------------------------------------ | ------------------------------------------------------------------ |
|
|
1208
|
+
| `job.completed` | `job` | create/edit | A hosted create or edit job reaches a terminal state. | `job_id`, `asset_ids`, `usage_event_id` |
|
|
1209
|
+
| `job.planned` | `job` | create | An authenticated create dry-run stores a recoverable plan receipt. | `job_id` |
|
|
1210
|
+
| `asset.created` | `asset` | create/edit | A hosted create or edit produces an output asset. | `job_id`, `asset_ids`, `usage_event_id` |
|
|
1211
|
+
| `asset.uploaded` | `asset` | upload | A public edit workflow uploads or imports input media. | `job_id`, `asset_ids`, `usage_event_id` |
|
|
1212
|
+
| `usage.credit_consumed` | `usage` | usage | A creative operation records a preview-credit entry. | `job_id`, `usage_event_id` |
|
|
1213
|
+
| `feedback.created` | `feedback` | feedback | Hosted agent feedback is accepted into product memory. | `feedback_id` |
|
|
1214
|
+
| `feedback.github_queue.processed` | `feedback` | feedback | Feedback is processed by the GitHub implementation queue handoff. | `feedback_id` |
|
|
1215
|
+
| `payment.checkout_session.created` | `payment` | payment | A Stripe Checkout session is created and awaits external action. | `quote_id`, `payment_attempt_id`, `checkout_session_id` |
|
|
1216
|
+
| `credits.payment_backed_granted` | `credit` | credits | Verified payment fulfillment grants paid credits. | `quote_id`, `receipt_id`, `credit_event_id` |
|
|
1217
|
+
| `credits.payment_backed_refunded` | `credit` | credits | A Stripe refund debits payment-backed credits. | `quote_id`, `receipt_id`, `payment_reversal_id`, `credit_event_id` |
|
|
1218
|
+
| `credits.payment_backed_disputed` | `credit` | credits | A Stripe dispute debit applies to payment-backed credits. | `quote_id`, `receipt_id`, `payment_reversal_id`, `credit_event_id` |
|
|
1219
|
+
| `credits.payment_backed_reinstated` | `credit` | credits | Stripe dispute funds were reinstated and recorded. | `quote_id`, `receipt_id`, `payment_reversal_id` |
|
|
1220
|
+
| `credits.payment_backed_reversal_pending` | `credit` | credits | A reversal was recorded but could not be fully applied. | `quote_id`, `receipt_id`, `payment_reversal_id` |
|
|
1221
|
+
| `credits.payment_backed_reversal_rejected` | `credit` | credits | A reversal was rejected because it could not safely reconcile. | `quote_id`, `receipt_id`, `payment_reversal_id` |
|
|
1135
1222
|
|
|
1136
1223
|
`feedback.github_queue.processed` includes `details.github_queue` with
|
|
1137
1224
|
machine-readable lifecycle fields such as `state`, `reason`, `issue_urls`,
|
|
1138
1225
|
`issue_numbers`, `mode`, and `github_mutation`. Agents should use it to learn
|
|
1139
1226
|
whether submitted feedback was promoted, skipped, deduped, blocked, or already
|
|
1140
1227
|
mirrored without reading private repository artifacts.
|
|
1228
|
+
`job.planned` includes `details.plan_receipt` for authenticated hosted create
|
|
1229
|
+
dry-runs. It is a recoverable planning receipt, not completed media work:
|
|
1230
|
+
planned outputs do not have durable asset IDs, download URLs, usage debits, or
|
|
1231
|
+
provider execution.
|
|
1141
1232
|
|
|
1142
1233
|
If a response includes an event type outside this registry, treat it as a
|
|
1143
1234
|
contract bug and submit `image-skill feedback create --json` with the event ID
|
package/llms.txt
CHANGED
|
@@ -38,6 +38,9 @@ Primary public surfaces:
|
|
|
38
38
|
- Hosted API: https://api.image-skill.com for generation, editing, jobs, activity, storage, telemetry, identity, quota, and feedback
|
|
39
39
|
- Hosted artifacts: prefer Image Skill-owned asset URLs such as https://media.image-skill.com/... when returned in assets[].url
|
|
40
40
|
|
|
41
|
+
Output rule:
|
|
42
|
+
JSON is the default public CLI output. --json is accepted for compatibility and explicitness, but it is not required on every command.
|
|
43
|
+
|
|
41
44
|
Actor types:
|
|
42
45
|
- human: sponsor, admin, billing, or claim actor
|
|
43
46
|
- agent: durable agent identity
|
|
@@ -51,30 +54,30 @@ Claim states:
|
|
|
51
54
|
- revoked: token or agent disabled
|
|
52
55
|
|
|
53
56
|
First-run flow:
|
|
54
|
-
1. image-skill
|
|
55
|
-
2.
|
|
56
|
-
3.
|
|
57
|
-
4. Reuse the saved CLI auth for later commands,
|
|
58
|
-
5. image-skill
|
|
59
|
-
6.
|
|
60
|
-
6-credit-note. One Image Skill credit is $0.01. Credit quotes grant prepaid value units; create/edit operations debit model-priced credits reported as cost.credit_pricing. Starter preview currently gives bounded free-preview credits plus a two-job daily cap.
|
|
57
|
+
1. image-skill create --guide --prompt PROMPT. This is the canonical fresh-agent entrypoint. It performs read-only hosted reachability, model availability, auth/quota, and payment rail checks and returns data.stage, data.next_command, data.escape_hatches, and data.mutation. Guide mode must report provider_call: false, hosted_create: false, hosted_signup: false, payment_object: false, credit_debit: false, and media_write: false.
|
|
58
|
+
2. If data.stage is prompt_required, rerun data.next_command with the real prompt.
|
|
59
|
+
3. If data.stage is auth_required, run data.next_command. The signup command uses --agent-contact as an email-shaped durable contact inbox for the restricted agent identity, not as a requirement to find an individual human. It saves CLI auth by default so later commands can authenticate without a token handoff. Use an agent-owned inbox when available; otherwise use an operator, team, or sponsor inbox that can receive future claim, billing, or abuse notices. Do not block waiting for a person, invent a person, or use a throwaway inbox. example.invalid addresses are only appropriate inside documented harness or proof runs. --human-email remains accepted as a compatibility alias, but the guide must not teach it. --save remains accepted as a compatibility no-op, but the guide must not teach it. Use --no-save only when local persistence is intentionally disabled, and use --show-token --no-save only when the runtime has a separate secret store and needs the raw token once.
|
|
60
|
+
4. Reuse the saved CLI auth for later commands. If the runtime needs the raw token once, store the returned data.token from --show-token --no-save in the agent runtime secret store and expose it as IMAGE_SKILL_TOKEN or pass it with --token-stdin.
|
|
61
|
+
5. Rerun image-skill create --guide --prompt PROMPT after signup or payment changes. The guide should advance to ready_to_create once auth, quota, executable model selection, and budget guard are sufficient.
|
|
62
|
+
6. If data.stage is quota_required, inspect data.checks.payments.suggested_commands. One Image Skill credit is $0.01. Credit quotes grant prepaid value units; create/edit operations debit model-priced credits reported as cost.credit_pricing. Starter preview currently gives bounded free-preview credits plus a two-job daily cap.
|
|
61
63
|
6a. image-skill credits methods --json to inspect payment rails, availability, buyer modes, browser requirements, and recovery commands before quoting or buying.
|
|
62
64
|
6b. image-skill credits packs list --json to inspect recommended live-money packs.
|
|
63
65
|
6c. image-skill credits quote --pack starter-500 --payment-method stripe_checkout --idempotency-key KEY --json for the default Stripe Checkout top-up path. Use --credits CREDITS instead of --pack only when the required exact budget is already known.
|
|
64
66
|
6d. image-skill credits buy --provider stripe --quote-id QUOTE_ID --idempotency-key KEY --json when the agent has a stripe_checkout quote and needs a payment handoff. Present or open checkout_handoff_url for humans; checkout_compact_url is also copy-safe when present. If no handoff URL is available, present the full checkout_url in a code block. Do not remove the Stripe # fragment; Checkout needs it in the browser. Credits are granted only after verified Stripe webhook fulfillment succeeds.
|
|
65
67
|
6e. image-skill credits status --payment-attempt-id PAYMENT_ATTEMPT_ID --json after buy or checkout completion to read durable payment state, receipt, credit_event, limits, and retry guidance without inferring from quota text.
|
|
66
|
-
7.
|
|
67
|
-
8. image-skill create --prompt PROMPT
|
|
68
|
-
9. image-skill
|
|
69
|
-
10. image-skill
|
|
70
|
-
11. image-skill
|
|
71
|
-
12. image-skill
|
|
72
|
-
13.
|
|
73
|
-
14. image-skill
|
|
68
|
+
7. If data.stage is ready_to_create, run data.next_command for the first bounded create. Use 0.05 only when intentionally budget-capping to a lower-cost/lower-resolution path; the quality-default first create generally needs the guide's returned max_estimated_usd_per_image. Add --output-count N only after models show confirms the selected create model supports more than one output; credit_pricing.credits_required is the total debit across outputs, while max_estimated_usd_per_image remains a per-image guard.
|
|
69
|
+
8. Use image-skill create --dry-run --prompt PROMPT for explicit zero-cost planning when you need the dry-run receipt before live create.
|
|
70
|
+
9. Use image-skill doctor, image-skill models list, image-skill models show MODEL_ID, image-skill whoami, and image-skill usage quota as manual escape hatches when the guide returns them or when capability details matter.
|
|
71
|
+
10. image-skill jobs show JOB_ID to recover status, cost, safety, timestamps, and final assets.
|
|
72
|
+
11. image-skill assets get ASSET_URL_OR_ID --output ./result.png to fetch the generated asset without repeating provider work.
|
|
73
|
+
12. image-skill activity list --subject JOB_ID to find the ledger event, trace, usage, and asset links to cite.
|
|
74
|
+
13. image-skill edit --input ASSET_URL_OR_ID --prompt PROMPT --accept-unknown-cost for the second bounded free-preview operation when the task needs an edit.
|
|
75
|
+
14. Leave image-skill feedback create if the first-run flow is confusing, blocked, missing an affordance, or easier through a direct provider than through Image Skill.
|
|
76
|
+
15. image-skill activity show FEEDBACK_ID to confirm the feedback entered the hosted ledger.
|
|
74
77
|
|
|
75
78
|
Core commands:
|
|
76
79
|
- image-skill doctor --json
|
|
77
|
-
- image-skill signup --agent --agent-contact
|
|
80
|
+
- image-skill signup --agent --agent-contact AGENT_OR_OPERATOR_INBOX --agent-name NAME --runtime RUNTIME --json
|
|
78
81
|
- image-skill whoami --json
|
|
79
82
|
- image-skill usage quota --json
|
|
80
83
|
- image-skill quota --json (compatibility alias)
|
|
@@ -89,7 +92,11 @@ Core commands:
|
|
|
89
92
|
- image-skill capabilities show CAPABILITY_ID --json
|
|
90
93
|
- image-skill models --json
|
|
91
94
|
- image-skill models list --json
|
|
95
|
+
- image-skill models list --available --operation image.generate --json
|
|
96
|
+
- image-skill models list --available --operation image.edit --json
|
|
97
|
+
- image-skill models list --catalog-only --provider fal --json
|
|
92
98
|
- image-skill models show MODEL_ID --json
|
|
99
|
+
- image-skill create --guide --prompt PROMPT --json
|
|
93
100
|
- image-skill create --prompt PROMPT --json
|
|
94
101
|
- image-skill create --prompt PROMPT --output-count N --json
|
|
95
102
|
- image-skill create --model fal.kling-image-o3-text-to-image --prompt PROMPT --element-frontal IMAGE_OR_ASSET[@ELEMENT_INDEX] --element-reference IMAGE_OR_ASSET[@ELEMENT_INDEX[:REFERENCE_INDEX]] --json
|
|
@@ -106,7 +113,7 @@ Core commands:
|
|
|
106
113
|
- image-skill feedback create --type TYPE --title TITLE --body BODY --command COMMAND --expected EXPECTED --actual ACTUAL --proof-needed PROOF --surface cli,docs --evidence trace:TRACE_ID --severity medium --confidence high --next-state watch --json
|
|
107
114
|
|
|
108
115
|
Hosted API endpoints:
|
|
109
|
-
- POST https://api.image-skill.com/v1/agent-signups creates or rotates a restricted unclaimed agent token. Raw API request human_email is the compatibility contact field; CLI agents should prefer --agent-contact. The contact is not a requirement that an autonomous agent stop until a specific human is present. The response returns the token once as data.token. Store it in the agent runtime secret store; never put it in prompts, logs, issue text, or feedback.
|
|
116
|
+
- POST https://api.image-skill.com/v1/agent-signups creates or rotates a restricted unclaimed agent token. Raw API request human_email is the legacy compatibility contact field; CLI agents should prefer --agent-contact. The preview hosted API currently expects an email-shaped durable contact inbox, but the contact is not a requirement that an autonomous agent stop until a specific human is present. The response returns the token once as data.token. Store it in the agent runtime secret store; never put it in prompts, logs, issue text, or feedback.
|
|
110
117
|
- GET https://api.image-skill.com/v1/whoami returns durable hosted identity for Authorization: Bearer TOKEN.
|
|
111
118
|
- GET https://api.image-skill.com/v1/quota returns durable hosted quota for Authorization: Bearer TOKEN.
|
|
112
119
|
- GET https://api.image-skill.com/v1/payment-methods returns the no-auth action-only payment rail catalog. It tells agents which currently usable rails are available, whether live money can move, buyer modes (agent_only, hybrid, human_only), browser requirements, limits, endpoint paths, and recovery commands. Planned, watch-only, fake, and private harness rails are intentionally omitted.
|
|
@@ -114,16 +121,16 @@ Hosted API endpoints:
|
|
|
114
121
|
- POST https://api.image-skill.com/v1/credit-quotes returns a stripe_checkout credit quote for Authorization: Bearer TOKEN. Request JSON: either credits or pack_id, optional payment_method, idempotency_key. Response includes quote_id, credits, price_amount_cents, currency, accepted_payment_method, pack_id, pack, and live_money. One credit equals $0.01, so price_amount_cents equals credits. This does not grant credits.
|
|
115
122
|
- POST https://api.image-skill.com/v1/credit-purchases/stripe-checkout-sessions creates a Stripe Checkout Session for a stripe_checkout quote. Request JSON: quote_id, idempotency_key. Response includes state: action_required, payment_attempt_id, checkout_session_id, checkout_handoff_url, checkout_compact_url, checkout_url, accepted_payment_method: stripe_checkout, and next.human_action: open_checkout_url. Present checkout_handoff_url to humans because it is short and redirects to Stripe; checkout_compact_url is also copy-safe when present. If no handoff URL is available, present the full checkout_url in a code block. Do not remove the Stripe # fragment; Checkout needs it in the browser. Stripe-hosted Checkout may accept operator-provided promotion codes; humans enter them on Stripe, not in the Image Skill CLI. This does not grant credits; verified Stripe webhook fulfillment grants paid credits exactly once.
|
|
116
123
|
- GET https://api.image-skill.com/v1/credit-purchases/status returns durable payment state for Authorization: Bearer TOKEN. Query with exactly one of quote_id, payment_attempt_id, checkout_session_id, or receipt_id. Response includes state, quote, payment_attempt, receipt, credit_event, provider_event, limits, and next.
|
|
117
|
-
- GET https://api.image-skill.com/v1/models returns the public model registry. GET https://api.image-skill.com/v1/models/MODEL_ID returns one model's capability-preserving schema.
|
|
124
|
+
- GET https://api.image-skill.com/v1/models returns the public model registry. Query params: available=true returns currently usable executable rows, executable=true returns runtime-wired rows regardless current availability, catalog_only=true returns source-backed catalog-only rows, operation=image.generate|image.edit narrows by operation, and provider=fal|xai|openai narrows by provider. The response summary includes total, returned, available, executable, cataloged_not_wired, provider split, first_actionable_model_ids, recommended filter commands, and full_catalog flags. For runnable choices require both status: available and execution.model_execution_status: executable; provider-level availability alone is not enough. GET https://api.image-skill.com/v1/models/MODEL_ID returns one model's capability-preserving schema.
|
|
118
125
|
- GET https://api.image-skill.com/v1/capabilities returns the hosted capability catalog, normalized controls, model-parameter schemas, auth requirements, and deprecation notices.
|
|
119
|
-
- POST https://api.image-skill.com/v1/create creates or dry-runs bounded free-preview images when Authorization: Bearer TOKEN has quota and the relevant preview grant. Request JSON: prompt, optional model, optional intent, optional aspect_ratio, optional output_count, optional references[] for reference-capable create models, optional model_parameters, optional dry_run, optional max_estimated_usd_per_image, optional accept_unknown_cost. output_count defaults to 1 and must not exceed the selected model's max_outputs_per_request. If model is omitted, hosted defaults are quality-first and the response includes request.selection with the selected capability, defaulted provider-native controls, expected output class, and pricing. Agents should read cost.credit_pricing.credits_required instead of assuming one credit per operation; for output_count greater than 1 this is the total debit across outputs. max_estimated_usd_per_image remains a per-image budget guard. On dry_run responses, cost.credit_pricing.credits_required is the planned live execution debit, while quota.consumed_credits is the actual debit and remains 0. references[] items use asset_id, role, index, optional reference_index for element_reference, and optional reference_task for reference_image; do not put URLs in references[].
|
|
126
|
+
- POST https://api.image-skill.com/v1/create creates or dry-runs bounded free-preview images when Authorization: Bearer TOKEN has quota and the relevant preview grant. Request JSON: prompt, optional model, optional intent, optional aspect_ratio, optional output_count, optional references[] for reference-capable create models, optional model_parameters, optional dry_run, optional max_estimated_usd_per_image, optional accept_unknown_cost. output_count defaults to 1 and must not exceed the selected model's max_outputs_per_request. If model is omitted, hosted defaults are quality-first and the response includes request.selection with the selected capability, defaulted provider-native controls, expected output class, and pricing. Agents should read cost.credit_pricing.credits_required instead of assuming one credit per operation; for output_count greater than 1 this is the total debit across outputs. max_estimated_usd_per_image remains a per-image budget guard. On dry_run responses, cost.credit_pricing.credits_required is the planned live execution debit, while quota.consumed_credits is the actual debit and remains 0. Authenticated hosted dry-runs also create a recoverable planned job: jobs show returns status planned with plan_receipt, and activity emits job.planned. Planned receipts do not create downloadable media assets, usage debits, or provider execution. references[] items use asset_id, role, index, optional reference_index for element_reference, and optional reference_task for reference_image; do not put URLs in references[].
|
|
120
127
|
- POST https://api.image-skill.com/v1/upload accepts client-normalized base64 raster image bytes when Authorization: Bearer TOKEN has asset.upload. Request JSON: source_kind, filename, remote_origin, mime_type, content_length, sha256, bytes_base64. Do not send local paths, full remote URLs, prompts, tokens, or provider credentials.
|
|
121
128
|
- POST https://api.image-skill.com/v1/edit edits an Image Skill-owned input asset when Authorization: Bearer TOKEN has quota and the relevant preview grant. Request JSON: input_asset_id, prompt, optional mask_asset_id for mask-capable models, optional references[] for reference-capable models, optional model, optional intent, optional aspect_ratio, optional output constraints, optional model_parameters, optional max_estimated_usd_per_image, optional max_usd, optional accept_unknown_cost. references[] items use asset_id, role, index, optional reference_index for element_reference, and optional reference_task for reference_image; do not put URLs in references[]. Current public references[] support covers Kling Image O1, Kling Image O3 image-to-image/text-to-image, Kling Image v3 image-to-image/text-to-image, Fal DreamO create, and xAI Grok Imagine image edit/quality edit. Kling references allow max 40 entries, max 10 contiguous element indexes from 0, one frontal per referenced element, and up to 3 reference images per element. DreamO references allow up to two contiguous reference_image indexes from 0, each with optional reference_task ip, id, or style. xAI edit references allow up to two contiguous reference_image indexes from 0 and do not accept reference_task; the primary input asset is the first source image. Reference assets must be owned PNG/JPEG/WebP, 10MB max, minimum 300px width/height, and aspect ratio 0.40-2.50. The public CLI uploads local paths or external URLs first for --input, --mask, --element-frontal, --element-reference, and --reference-image; do not send source bytes, external URLs, image_url, image_urls, mask_url, raw provider elements, frontal_image_url, reference_image_urls, first_image_url, second_image_url, images, or *_reference_task to /v1/edit or /v1/create. For Kling elements, --element-frontal IMAGE[@ELEMENT_INDEX] sends role element_frontal and --element-reference IMAGE[@ELEMENT_INDEX[:REFERENCE_INDEX]] sends role element_reference under top-level references[]. For DreamO create, --reference-image IMAGE[@INDEX[:TASK]] sends role reference_image with optional reference_task. For xAI edit, --reference-image IMAGE[@INDEX] supplies the second or third ordered source image.
|
|
122
129
|
- GET https://api.image-skill.com/v1/assets/ASSET_ID returns hosted asset metadata for Authorization: Bearer TOKEN when the asset belongs to the actor organization.
|
|
123
130
|
- GET https://api.image-skill.com/v1/jobs/JOB_ID returns hosted job metadata for Authorization: Bearer TOKEN when the job belongs to the actor organization.
|
|
124
131
|
- GET https://api.image-skill.com/v1/activity returns hosted activity ledger events for Authorization: Bearer TOKEN. Optional query: limit, subject. Activity is for ledger context, not job recovery.
|
|
125
132
|
- GET https://api.image-skill.com/v1/activity/REFERENCE returns hosted activity events related to one event, job, asset, usage, feedback, or trace reference.
|
|
126
|
-
- Public activity event types are: job.completed, asset.created, asset.uploaded, usage.credit_consumed, feedback.created, feedback.github_queue.processed, payment.checkout_session.created, credits.payment_backed_granted, credits.payment_backed_refunded, credits.payment_backed_disputed, credits.payment_backed_reinstated, credits.payment_backed_reversal_pending, credits.payment_backed_reversal_rejected. Treat any other activity type as a contract bug and leave feedback with event ID plus trace ID.
|
|
133
|
+
- Public activity event types are: job.completed, job.planned, asset.created, asset.uploaded, usage.credit_consumed, feedback.created, feedback.github_queue.processed, payment.checkout_session.created, credits.payment_backed_granted, credits.payment_backed_refunded, credits.payment_backed_disputed, credits.payment_backed_reinstated, credits.payment_backed_reversal_pending, credits.payment_backed_reversal_rejected. job.planned includes details.plan_receipt for authenticated hosted create dry-runs and is a planning receipt, not completed media work. Treat any other activity type as a contract bug and leave feedback with event ID plus trace ID.
|
|
127
134
|
- POST https://api.image-skill.com/v1/cli runs public CLI-compatible commands over JSON argv.
|
|
128
135
|
- GET https://api.image-skill.com/healthz checks API readiness.
|
|
129
136
|
|
|
@@ -188,7 +195,7 @@ Unclaimed agents may not:
|
|
|
188
195
|
- send card data, wallet secrets, wallet private keys, seed phrases, raw x402 payment headers, provider receipts, Stripe secrets, MPP tokens, SPTs, bearer tokens, or any payment credential to Image Skill; Stripe payment details must be entered only on Stripe-hosted checkout pages
|
|
189
196
|
|
|
190
197
|
Credits:
|
|
191
|
-
One Image Skill credit is $0.01. Use image-skill credits methods --json to inspect payment rail availability and whether a browser/human action is required. Use image-skill credits packs list --json to inspect recommended Stripe Checkout packs. Use image-skill credits quote --pack PACK_ID --payment-method stripe_checkout --json for the default live-money top-up path. Use image-skill credits quote --credits CREDITS --payment-method stripe_checkout --json for exact bounded custom top-ups when the required budget is already known. Use image-skill credits buy --provider stripe --json to create a hosted Stripe Checkout Session for a stripe_checkout quote; this returns checkout_handoff_url, copy-safe checkout_compact_url, and full Stripe checkout_url fallback and does not grant credits. Present checkout_handoff_url or checkout_compact_url to humans, especially in mobile terminals, SSH, or chat. If checkout_handoff_url is absent, present the full checkout_url in a code block and preserve the Stripe # fragment. Use image-skill credits status --payment-attempt-id PAYMENT_ATTEMPT_ID --json after buy and after checkout completion to read state, receipt, credit_event, limits, and retry guidance. Create/edit debit model-priced credits after provider success; inspect models show and operation cost.credit_pricing for credits_required and pricing_confidence. Do not silently downgrade to the cheapest model to avoid payment when the user asked for quality or is willing to pay; quote the needed credits and use the payment handoff. Credits buy requires explicit --idempotency-key. Quote idempotency keys are scoped to the hosted agent identity and exact quote terms; use per-run/per-step quote keys and inspect error.recovery.suggested_command on CREDIT_QUOTE_CONFLICT. Never send payment credentials to Image Skill; Stripe collects payment details on Stripe-hosted pages. Public request fields are credits, pack_id, payment_method, quote_id, status reference IDs, and idempotency_key.
|
|
198
|
+
One Image Skill credit is $0.01. Use image-skill credits methods --json to inspect payment rail availability and whether a browser/human action is required. Use image-skill credits packs list --json to inspect recommended Stripe Checkout packs. Use image-skill credits quote --pack PACK_ID --payment-method stripe_checkout --idempotency-key KEY --json for the default live-money top-up path. Use image-skill credits quote --credits CREDITS --payment-method stripe_checkout --idempotency-key KEY --json for exact bounded custom top-ups when the required budget is already known. Use image-skill credits buy --provider stripe --quote-id QUOTE_ID --idempotency-key KEY --json to create a hosted Stripe Checkout Session for a stripe_checkout quote; this returns checkout_handoff_url, copy-safe checkout_compact_url, and full Stripe checkout_url fallback and does not grant credits. Present checkout_handoff_url or checkout_compact_url to humans, especially in mobile terminals, SSH, or chat. If checkout_handoff_url is absent, present the full checkout_url in a code block and preserve the Stripe # fragment. Use image-skill credits status --payment-attempt-id PAYMENT_ATTEMPT_ID --json after buy and after checkout completion to read state, receipt, credit_event, limits, and retry guidance. Create/edit debit model-priced credits after provider success; inspect models show and operation cost.credit_pricing for credits_required and pricing_confidence. Do not silently downgrade to the cheapest model to avoid payment when the user asked for quality or is willing to pay; quote the needed credits and use the payment handoff. Credits buy requires explicit --idempotency-key. Quote idempotency keys are scoped to the hosted agent identity and exact quote terms; use per-run/per-step quote keys and inspect error.recovery.suggested_command on CREDIT_QUOTE_CONFLICT. Never send payment credentials to Image Skill; Stripe collects payment details on Stripe-hosted pages. Public request fields are credits, pack_id, payment_method, quote_id, status reference IDs, and idempotency_key.
|
|
192
199
|
|
|
193
200
|
Telemetry:
|
|
194
201
|
- command or endpoint name
|
|
@@ -211,15 +218,23 @@ auditable event IDs, feedback confirmation, usage links, job/asset links, or
|
|
|
211
218
|
trace references. Activity is broader than jobs and can include completed
|
|
212
219
|
outputs, uploads, usage events, and feedback. Activity does not replace jobs
|
|
213
220
|
show/wait for polling, recovery, retry judgment, or final job state.
|
|
214
|
-
Current activity event registry: job.completed,
|
|
215
|
-
usage.credit_consumed, feedback.created,
|
|
216
|
-
payment.checkout_session.created,
|
|
217
|
-
credits.
|
|
218
|
-
credits.
|
|
219
|
-
credits.payment_backed_reversal_rejected.
|
|
221
|
+
Current activity event registry: job.completed, job.planned, asset.created,
|
|
222
|
+
asset.uploaded, usage.credit_consumed, feedback.created,
|
|
223
|
+
feedback.github_queue.processed, payment.checkout_session.created,
|
|
224
|
+
credits.payment_backed_granted, credits.payment_backed_refunded,
|
|
225
|
+
credits.payment_backed_disputed, credits.payment_backed_reinstated,
|
|
226
|
+
credits.payment_backed_reversal_pending, credits.payment_backed_reversal_rejected.
|
|
220
227
|
Feedback GitHub queue lifecycle events expose `details.github_queue.state`,
|
|
221
228
|
`reason`, and public issue references when available, so agents can tell what
|
|
222
229
|
happened to submitted feedback without inspecting private Actions artifacts.
|
|
230
|
+
`job.planned` exposes `details.plan_receipt` for authenticated hosted create
|
|
231
|
+
dry-runs; it does not mean assets were generated, credits were consumed, or a
|
|
232
|
+
provider was called.
|
|
233
|
+
`models list --available --operation image.generate --json` is the fastest
|
|
234
|
+
manual escape hatch for runnable create choices. Use
|
|
235
|
+
`models list --available --operation image.edit --json` for runnable edit
|
|
236
|
+
choices. Use `models list --catalog-only --json` only when you intentionally
|
|
237
|
+
want inspectable rows that Image Skill does not execute yet.
|
|
223
238
|
|
|
224
239
|
Feedback:
|
|
225
240
|
Use image-skill feedback create --json when the workflow fails, succeeds with friction, reveals confusing behavior, or suggests a missing feature. Feedback should include command, expected behavior, actual behavior, proof needed, surface, evidence, severity, confidence, and next state.
|
package/package.json
CHANGED