originalpictures-cli 0.1.0__tar.gz
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.
- originalpictures_cli-0.1.0/.gitignore +23 -0
- originalpictures_cli-0.1.0/LICENSE +202 -0
- originalpictures_cli-0.1.0/PKG-INFO +298 -0
- originalpictures_cli-0.1.0/README.md +262 -0
- originalpictures_cli-0.1.0/pyproject.toml +93 -0
- originalpictures_cli-0.1.0/src/originalpictures_cli/__init__.py +7 -0
- originalpictures_cli-0.1.0/src/originalpictures_cli/__main__.py +5 -0
- originalpictures_cli-0.1.0/src/originalpictures_cli/cli.py +162 -0
- originalpictures_cli-0.1.0/src/originalpictures_cli/click_boundary.py +69 -0
- originalpictures_cli-0.1.0/src/originalpictures_cli/config.py +222 -0
- originalpictures_cli-0.1.0/src/originalpictures_cli/exit_codes.py +24 -0
- originalpictures_cli-0.1.0/src/originalpictures_cli/operations.py +704 -0
- originalpictures_cli-0.1.0/src/originalpictures_cli/output.py +128 -0
- originalpictures_cli-0.1.0/src/originalpictures_cli/runtime.py +175 -0
- originalpictures_cli-0.1.0/src/originalpictures_cli/workflows.py +289 -0
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# Python
|
|
2
|
+
__pycache__/
|
|
3
|
+
*.py[cod]
|
|
4
|
+
.venv/
|
|
5
|
+
.mypy_cache/
|
|
6
|
+
.ruff_cache/
|
|
7
|
+
.pytest_cache/
|
|
8
|
+
*.egg-info/
|
|
9
|
+
build/
|
|
10
|
+
dist/
|
|
11
|
+
.build/
|
|
12
|
+
|
|
13
|
+
# Node / TypeScript
|
|
14
|
+
node_modules/
|
|
15
|
+
*.tsbuildinfo
|
|
16
|
+
coverage/
|
|
17
|
+
npm-dist/
|
|
18
|
+
|
|
19
|
+
# Local secrets (never committed)
|
|
20
|
+
.env
|
|
21
|
+
.env.*
|
|
22
|
+
*.pem
|
|
23
|
+
*.key
|
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|
|
@@ -0,0 +1,298 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: originalpictures-cli
|
|
3
|
+
Version: 0.1.0
|
|
4
|
+
Summary: Command-line tool to sign media with C2PA Content Credentials, add invisible watermarks, and verify.
|
|
5
|
+
Project-URL: Homepage, https://originalpictures.com
|
|
6
|
+
Project-URL: Documentation, https://docs.originalpictures.com/
|
|
7
|
+
Project-URL: Repository, https://github.com/Original-Pictures/originalpictures-clients
|
|
8
|
+
Project-URL: Issues, https://github.com/Original-Pictures/originalpictures-clients/issues
|
|
9
|
+
Project-URL: Pricing, https://originalpictures.com/pricing/
|
|
10
|
+
Author-email: "Original Pictures Technologies, Inc." <hello@originalpictures.com>
|
|
11
|
+
License-Expression: Apache-2.0
|
|
12
|
+
License-File: LICENSE
|
|
13
|
+
Keywords: ai-labeling,ai-watermarking,c2pa,cli,content-credentials,eu-ai-act,fingerprinting,invisible-watermark,provenance,sb-942,verification,watermarking
|
|
14
|
+
Classifier: Development Status :: 4 - Beta
|
|
15
|
+
Classifier: Environment :: Console
|
|
16
|
+
Classifier: Intended Audience :: Developers
|
|
17
|
+
Classifier: Operating System :: OS Independent
|
|
18
|
+
Classifier: Programming Language :: Python :: 3
|
|
19
|
+
Classifier: Programming Language :: Python :: 3 :: Only
|
|
20
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
21
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
22
|
+
Classifier: Programming Language :: Python :: 3.14
|
|
23
|
+
Classifier: Topic :: Multimedia
|
|
24
|
+
Classifier: Topic :: Multimedia :: Graphics
|
|
25
|
+
Classifier: Topic :: Multimedia :: Sound/Audio
|
|
26
|
+
Classifier: Topic :: Multimedia :: Video
|
|
27
|
+
Classifier: Topic :: Security :: Cryptography
|
|
28
|
+
Classifier: Topic :: Utilities
|
|
29
|
+
Requires-Python: >=3.12
|
|
30
|
+
Requires-Dist: click==8.4.2
|
|
31
|
+
Requires-Dist: keyring==25.7.0
|
|
32
|
+
Requires-Dist: originalpictures-sdk==1.0.0
|
|
33
|
+
Requires-Dist: platformdirs==4.11.1
|
|
34
|
+
Requires-Dist: rich==15.0.0
|
|
35
|
+
Description-Content-Type: text/markdown
|
|
36
|
+
|
|
37
|
+
# originalpictures-cli: command-line tool for C2PA Content Credentials, AI watermarking and verification
|
|
38
|
+
|
|
39
|
+
`originalpictures-cli` installs the `originalpictures` command: a safe, scriptable command-line
|
|
40
|
+
interface to the [Original Pictures](https://originalpictures.com) API. Sign files with C2PA
|
|
41
|
+
Content Credentials, add an invisible watermark and perceptual fingerprints, declare AI generation,
|
|
42
|
+
verify what a file declares about its origin, and download signed outputs, from a terminal or a CI
|
|
43
|
+
job.
|
|
44
|
+
|
|
45
|
+
```sh
|
|
46
|
+
pipx install originalpictures-cli
|
|
47
|
+
export ORIGINALPICTURES_API_URL=https://api.originalpictures.com
|
|
48
|
+
originalpictures auth login # paste the key at the hidden prompt
|
|
49
|
+
originalpictures capabilities show
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
It delegates every network operation to [`originalpictures-sdk`](https://pypi.org/project/originalpictures-sdk/);
|
|
53
|
+
it has no raw-route command and no internal-service access.
|
|
54
|
+
|
|
55
|
+
## What it does
|
|
56
|
+
|
|
57
|
+
- **C2PA signing** (`sign accept`): every job writes a C2PA manifest (Content Credentials) following
|
|
58
|
+
the C2PA Technical Specification 2.4, recording the file's declared origin.
|
|
59
|
+
- **Invisible watermark and fingerprinting** (`--watermark`, `--fingerprint`): optional, so a copy
|
|
60
|
+
whose metadata was stripped can still be matched to your record.
|
|
61
|
+
- **AI-generation declaration** (`--ai-generated`): the kind of machine-readable marking that EU AI
|
|
62
|
+
Act Article 50(2) and the California AI Transparency Act (SB 942) describe.
|
|
63
|
+
- **Verification** (`verifications create`, `verifications get`): Content Credentials status,
|
|
64
|
+
certificate chain and your account's records, reported as declared origin with reason codes.
|
|
65
|
+
- **Uploads and downloads** (`uploads file`, `assets download`) with streaming, size bounds and
|
|
66
|
+
SHA-256 integrity checks.
|
|
67
|
+
- **Jobs** (`jobs wait`): polls with a bounded deadline and clean Ctrl-C cancellation.
|
|
68
|
+
|
|
69
|
+
## Why use it
|
|
70
|
+
|
|
71
|
+
- **No secrets on the command line.** Credentials come only from `ORIGINALPICTURES_API_KEY`, a
|
|
72
|
+
hidden prompt, or standard input (`auth login --token-stdin`). The operating-system keyring
|
|
73
|
+
stores them; the config file holds only non-secret profile settings.
|
|
74
|
+
- **Scriptable.** `--json` gives deterministic compact JSON on stdout and canonical JSON errors on
|
|
75
|
+
stderr, with stable exit codes (below).
|
|
76
|
+
- **No hand-written JSON for signing.** `sign accept` builds the request from flags.
|
|
77
|
+
- **Safe by default.** Bounded timeouts and response sizes, fresh idempotency keys for operations
|
|
78
|
+
that need them, and request bodies read from bounded files or stdin, never from argv.
|
|
79
|
+
|
|
80
|
+
## Install
|
|
81
|
+
|
|
82
|
+
```sh
|
|
83
|
+
pipx install originalpictures-cli
|
|
84
|
+
```
|
|
85
|
+
|
|
86
|
+
or
|
|
87
|
+
|
|
88
|
+
```sh
|
|
89
|
+
uv tool install originalpictures-cli
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
Requires Python 3.12 or later. The command is `originalpictures`. (Earlier pre-release builds also
|
|
93
|
+
installed an `op` alias; it was removed because `op` is the 1Password CLI's command.)
|
|
94
|
+
|
|
95
|
+
## Quickstart
|
|
96
|
+
|
|
97
|
+
1. Create an API key in the [console](https://console.originalpictures.com/) under **API keys**
|
|
98
|
+
(keys start with `opk_`).
|
|
99
|
+
2. Point the CLI at the API and store the key:
|
|
100
|
+
|
|
101
|
+
```sh
|
|
102
|
+
originalpictures config set-api-url https://api.originalpictures.com
|
|
103
|
+
originalpictures auth login
|
|
104
|
+
originalpictures auth status
|
|
105
|
+
```
|
|
106
|
+
|
|
107
|
+
The CLI's built-in default API URL is a local development address, so set the URL once per
|
|
108
|
+
profile as above, or export `ORIGINALPICTURES_API_URL` in each shell.
|
|
109
|
+
|
|
110
|
+
3. Upload, sign and wait:
|
|
111
|
+
|
|
112
|
+
```sh
|
|
113
|
+
originalpictures --json uploads file photo.jpg --media-type image/jpeg > upload.json
|
|
114
|
+
ASSET=$(jq -r .completion.asset_id upload.json)
|
|
115
|
+
|
|
116
|
+
originalpictures --json sign accept --asset "$ASSET" --no-watermark --no-fingerprint > job.json
|
|
117
|
+
originalpictures --json jobs wait "$(jq -r .job_id job.json)" --poll-timeout 300 > signed.json
|
|
118
|
+
```
|
|
119
|
+
|
|
120
|
+
4. Download the signed file (checked against the published length and SHA-256):
|
|
121
|
+
|
|
122
|
+
```sh
|
|
123
|
+
originalpictures assets download "$(jq -r .result.asset_id signed.json)" photo.signed.jpg
|
|
124
|
+
```
|
|
125
|
+
|
|
126
|
+
Root options (`--json`, `--profile`, `--api-url`, `--timeout`, `--max-response-bytes`) must come
|
|
127
|
+
before the command group, for example `originalpictures --json jobs get job_...`.
|
|
128
|
+
|
|
129
|
+
## Signing flags
|
|
130
|
+
|
|
131
|
+
`sign accept` builds the whole request from flags. Every job signs with C2PA;
|
|
132
|
+
`--watermark/--no-watermark` and `--fingerprint/--no-fingerprint` choose what else it adds. Send
|
|
133
|
+
both every time.
|
|
134
|
+
|
|
135
|
+
| Flag | Request field |
|
|
136
|
+
| ------------------------------------ | ------------------------------------------------------------------------ |
|
|
137
|
+
| `--asset ID` | `asset_id` |
|
|
138
|
+
| `--watermark` / `--no-watermark` | `watermark` |
|
|
139
|
+
| `--fingerprint` / `--no-fingerprint` | `fingerprint` |
|
|
140
|
+
| `--watermark-algorithm ID` | `watermark_algorithm` (needs `--watermark`) |
|
|
141
|
+
| `--watermark-strength LEVEL` | `watermark_strength`: `subtle`, `balanced`, `robust` |
|
|
142
|
+
| `--fingerprint-algorithm ID` | `fingerprint_algorithms` (repeatable) |
|
|
143
|
+
| `--ai-generated` | `ai_declaration` (needs `--software-agent NAME`) |
|
|
144
|
+
| `--software-agent-version V` | `ai_declaration.software_agent_version` |
|
|
145
|
+
| `--digital-source-type T` | `ai_declaration.digital_source_type` (default `trainedAlgorithmicMedia`) |
|
|
146
|
+
| `--creator ID` | `creator_id` |
|
|
147
|
+
| `--template ID` | `template_id` (a saved workflow template) |
|
|
148
|
+
| `--recipe ID` | `recipe_id` (advanced; needed only for a sidecar format) |
|
|
149
|
+
|
|
150
|
+
`--input FILE` (or `-` for standard input) still supplies a JSON body; a flag and the same field in
|
|
151
|
+
the body must agree. `--strength` is an alias of `--watermark-strength`.
|
|
152
|
+
|
|
153
|
+
## Examples
|
|
154
|
+
|
|
155
|
+
### 1. C2PA Content Credentials only
|
|
156
|
+
|
|
157
|
+
```sh
|
|
158
|
+
originalpictures sign accept --asset ast_… --no-watermark --no-fingerprint
|
|
159
|
+
```
|
|
160
|
+
|
|
161
|
+
### 2. Invisible watermark and fingerprints, then C2PA
|
|
162
|
+
|
|
163
|
+
```sh
|
|
164
|
+
originalpictures sign accept --asset ast_… --watermark --fingerprint \
|
|
165
|
+
--watermark-algorithm pixelseal --watermark-strength subtle
|
|
166
|
+
```
|
|
167
|
+
|
|
168
|
+
`originalpictures capabilities show` lists the media types, recipes, watermark and fingerprint
|
|
169
|
+
algorithms your deployment offers.
|
|
170
|
+
|
|
171
|
+
### 3. Declare AI generation (sign-only)
|
|
172
|
+
|
|
173
|
+
```sh
|
|
174
|
+
originalpictures sign accept --asset ast_… --no-watermark --fingerprint \
|
|
175
|
+
--ai-generated --software-agent "Studio Nova Imagine" --software-agent-version 2.0
|
|
176
|
+
```
|
|
177
|
+
|
|
178
|
+
`--ai-generated` with `--watermark` is refused before any request is sent: "AI-generated mark needs
|
|
179
|
+
a sign-only call (C2PA claim plan)".
|
|
180
|
+
|
|
181
|
+
### 4. Verify a file
|
|
182
|
+
|
|
183
|
+
```sh
|
|
184
|
+
originalpictures --json uploads file received.jpg --media-type image/jpeg > upload.json
|
|
185
|
+
jq '{object_id: .completion.asset_object_id}' upload.json \
|
|
186
|
+
| originalpictures --json verifications create --input - > verification.json
|
|
187
|
+
originalpictures --json verifications get "$(jq -r .verification_id verification.json)"
|
|
188
|
+
```
|
|
189
|
+
|
|
190
|
+
The result reports what the file declares about its origin and whether your account has a record
|
|
191
|
+
of it. It is never a judgement about the content itself.
|
|
192
|
+
|
|
193
|
+
### 5. CI pipeline (GitHub Actions, GitLab, Jenkins)
|
|
194
|
+
|
|
195
|
+
```sh
|
|
196
|
+
# The key comes from the CI secret store as an environment variable, never as an argument.
|
|
197
|
+
export ORIGINALPICTURES_API_KEY="$OP_SIGNING_KEY"
|
|
198
|
+
export ORIGINALPICTURES_API_URL=https://api.originalpictures.com
|
|
199
|
+
for file in build/images/*.png; do
|
|
200
|
+
asset=$(originalpictures --json uploads file "$file" --media-type image/png | jq -r .completion.asset_id)
|
|
201
|
+
originalpictures --json sign accept --asset "$asset" --watermark --fingerprint | jq -r .job_id
|
|
202
|
+
done
|
|
203
|
+
```
|
|
204
|
+
|
|
205
|
+
### 6. Several accounts with profiles
|
|
206
|
+
|
|
207
|
+
```sh
|
|
208
|
+
originalpictures --profile staging config set-api-url https://api.originalpictures.com
|
|
209
|
+
originalpictures --profile staging auth login --token-stdin < staging-key.txt
|
|
210
|
+
originalpictures --profile staging --json user show
|
|
211
|
+
originalpictures config profiles
|
|
212
|
+
```
|
|
213
|
+
|
|
214
|
+
## Configuration
|
|
215
|
+
|
|
216
|
+
| Variable or option | Meaning |
|
|
217
|
+
| ---------------------------------------- | --------------------------------------------------------------- |
|
|
218
|
+
| `ORIGINALPICTURES_API_KEY` | API key; takes precedence over the keyring credential |
|
|
219
|
+
| `ORIGINALPICTURES_API_URL` / `--api-url` | API origin for one run; overrides the profile's URL |
|
|
220
|
+
| `ORIGINALPICTURES_PROFILE` / `--profile` | Named local profile (default `default`) |
|
|
221
|
+
| `--timeout SECONDS` | Per-request timeout (default 30, at most 600) |
|
|
222
|
+
| `--max-response-bytes N` | Hard JSON response bound (default 16 MiB) |
|
|
223
|
+
| `--json` | Deterministic JSON on stdout, canonical JSON errors on stderr |
|
|
224
|
+
| `config set-api-url URL` | Store the profile's API URL (URLs carrying credentials refused) |
|
|
225
|
+
|
|
226
|
+
Mutation bodies use `--input FILE` and explicit operation parameters use `--parameters FILE`; `-`
|
|
227
|
+
reads the JSON object from standard input. Run `originalpictures --help` for every command group:
|
|
228
|
+
`assets`, `auth`, `billing`, `capabilities`, `capture`, `config`, `governance`, `history`, `jobs`,
|
|
229
|
+
`keys`, `shares`, `sign`, `uploads`, `usage`, `user`, `verifications`, `webhooks`.
|
|
230
|
+
|
|
231
|
+
## Stable exit codes
|
|
232
|
+
|
|
233
|
+
| Code | Meaning |
|
|
234
|
+
| ---: | ------------------------------------------------- |
|
|
235
|
+
| 0 | Success |
|
|
236
|
+
| 1 | Unexpected local failure |
|
|
237
|
+
| 2 | Command usage error |
|
|
238
|
+
| 3 | Missing or invalid local configuration/credential |
|
|
239
|
+
| 4 | API or local input validation failure |
|
|
240
|
+
| 5 | Authentication failed |
|
|
241
|
+
| 6 | Permission denied |
|
|
242
|
+
| 7 | Resource not found |
|
|
243
|
+
| 8 | State or idempotency conflict |
|
|
244
|
+
| 9 | Rate limited |
|
|
245
|
+
| 10 | Deadline exceeded |
|
|
246
|
+
| 11 | Transport or service unavailable |
|
|
247
|
+
| 12 | Transfer integrity failure |
|
|
248
|
+
| 13 | Configured response/transfer bound exceeded |
|
|
249
|
+
| 130 | Cancelled by Ctrl-C |
|
|
250
|
+
|
|
251
|
+
## FAQ
|
|
252
|
+
|
|
253
|
+
**Is this C2PA?**
|
|
254
|
+
Yes. Signing writes standard C2PA manifests (Content Credentials) that any C2PA-aware validator,
|
|
255
|
+
such as `c2patool`, can read. Original Pictures is listed on the C2PA Conforming Products List as a
|
|
256
|
+
generator product under the C2PA Conformance Program 0.2 (C2PA Technical Specification 2.4).
|
|
257
|
+
|
|
258
|
+
**Is Original Pictures audited?**
|
|
259
|
+
Original Pictures Technologies, Inc. holds ISO/IEC 27001:2022 certification for its information
|
|
260
|
+
security management system (GCAI, certificate GCAI-ISMS-PD91) and ISO/IEC 42001:2023 certification
|
|
261
|
+
for its AI management system (TNV). It has a SOC 2 Type I report from Percilchofe CPA LLC as of
|
|
262
|
+
19 October 2026, and runs a GDPR compliance program. The certifications cover management systems,
|
|
263
|
+
not this package. See [Security and compliance](https://originalpictures.com/security/).
|
|
264
|
+
|
|
265
|
+
**Does it store my media?**
|
|
266
|
+
Uploaded files are processed on Original Pictures' private servers, encrypted in transit and at
|
|
267
|
+
rest, in isolated processing. Published outputs are kept for the retention your API key selects
|
|
268
|
+
(new accounts default to 72 hours). Operator views show metadata only, and emergency access is
|
|
269
|
+
audited. This is private server processing, not end-to-end encryption.
|
|
270
|
+
|
|
271
|
+
**What formats are supported?**
|
|
272
|
+
Embedded C2PA for JPEG, PNG, WebP, TIFF, AVIF, WAV, MP3, AAC (`.m4a`) and MP4 (H.264/AAC);
|
|
273
|
+
sign-only embedding for GIF, JPEG XL, SVG, DNG, HEIC/HEIF, QuickTime, AVI and FLAC; a sidecar
|
|
274
|
+
`.c2pa` manifest for PDF, EPUB, DOCX, text, fonts and ML model files. Run
|
|
275
|
+
`originalpictures capabilities show` for the live list.
|
|
276
|
+
|
|
277
|
+
**Why was the `op` command removed?**
|
|
278
|
+
`op` is the 1Password CLI. Installing a second `op` would shadow it on your `PATH`.
|
|
279
|
+
|
|
280
|
+
**How much does it cost?**
|
|
281
|
+
See [pricing](https://originalpictures.com/pricing/).
|
|
282
|
+
|
|
283
|
+
**How do I get an API key?**
|
|
284
|
+
Sign in to the [console](https://console.originalpictures.com/) and create one under **API keys**.
|
|
285
|
+
|
|
286
|
+
## Links
|
|
287
|
+
|
|
288
|
+
- Documentation: <https://docs.originalpictures.com/>
|
|
289
|
+
- API reference: <https://docs.originalpictures.com/api/>
|
|
290
|
+
- Website: <https://originalpictures.com>
|
|
291
|
+
- Python SDK: <https://pypi.org/project/originalpictures-sdk/>
|
|
292
|
+
- Support: <hello@originalpictures.com>
|
|
293
|
+
|
|
294
|
+
## Licence
|
|
295
|
+
|
|
296
|
+
Licensed under the [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0); the
|
|
297
|
+
full text is in the `LICENSE` file shipped with this package. Copyright © 2026 Original Pictures
|
|
298
|
+
Technologies, Inc. The licence grants no rights to the Original Pictures name or logo.
|