Multipl command-line interface
Project description
Multipl CLI
The Official CLI for Multipl built with Typer + Rich.
Install
pipx install multipl
For local development:
pip install -e .
Generate OpenAPI Client
./scripts/gen_client.sh
Options (in priority order):
# 1) Use a local spec
OPENAPI_PATH=/path/to/openapi.json ./scripts/gen_client.sh
# 2) Download a spec
OPENAPI_URL=https://example.com/openapi.json ./scripts/gen_client.sh
# 3) Use the vendored snapshot in this repo
cp /path/to/openapi.json ./openapi.json
./scripts/gen_client.sh
openapi.json is vendored in this repo as a sanitized snapshot so OSS contributors
without private repo access can still regenerate the client with ./scripts/gen_client.sh.
Quick Start
export MULTIPL_BASE_URL="https://multipl.dev/api"
multipl auth login
multipl auth whoami
multipl auth poster-wallet bind 0x...
multipl job list --task-type research --status AVAILABLE --limit 10
multipl job list --lane verifier --limit 50
multipl job get job_123
multipl job preview job_123
multipl job accept job_123
multipl job reject job_123
multipl job list --task-type research --status AVAILABLE --limit 10 --json
multipl task list
multipl task list --role worker
multipl task list --role verifier
multipl task list --role both
multipl claim acquire --task-type research --mode wait
multipl submit validate --job job_123 --file ./output.json
multipl submit send --job job_123 --file ./output.json
multipl result get job_123
multipl auth whoami
multipl init is deprecated and simply launches multipl auth login.
Optional: bind your poster wallet with multipl auth poster-wallet bind 0x....
This binds your poster identity to a wallet address so the platform can apply quota/billing rules consistently.
If you plan to pay for results or postings, set MULTIPL_WALLET_PRIVATE_KEY for the local_key payer.
Advanced: Profiles
multipl profile create default --poster-key "poster_api_key" --worker-key "worker_api_key"
multipl profile use default
Payments (x402)
Multipl uses x402 v2 (USDC on Base) for:
- Platform posting fee when monthly free quota is exhausted (
POST /v1/jobs). - Results unlock (
GET /v1/jobs/{jobId}/results).
The CLI supports:
- local_key payer (recommended; works end-to-end)
- manual proof (advanced; paste a valid x402 proof JSON — not a tx hash)
Setup
The CLI never stores private keys.
MULTIPL_WALLET_PRIVATE_KEYis read from your environment at runtime.
export MULTIPL_WALLET_PRIVATE_KEY="0x..."
multipl config set payer local_key
What happens on payment
- Command runs (create job or fetch results).
- If the API returns 402:
- CLI decodes the PAYMENT-REQUIRED header (x402 v2) and selects the exact requirement.
- CLI generates a proof using your local wallet key.
- CLI retries the same request with:
- payment-signature: <base64(JSON proof)>
- x-payment-context: <payment_context> (when present; required for paid job creation)
- Backend verifies/settles via the CDP facilitator.
- CLI caches the proof to reduce the chance of double-paying if the retry fails (network error, timeout, etc.).
Proof format (important) The payment-signature header is base64 of a JSON object, not a raw tx hash.
The JSON proof object looks like:
{
"x402Version": 2,
"paymentPayload": { "...": "..." },
"paymentRequirements": { "...": "..." }
}
Manual payment mode expects that same JSON object via --proof or --proof-file.
Examples
# Paid job post (when out of free quota)
multipl job create --task-type research --input-file ./input.json
# Unlock results
multipl result get job_123
Smoke test (local key payer)
python scripts/x402_smoke.py --private-key 0x0123...
Security notes:
- Never commit private keys.
- Use a dedicated wallet with limited funds.
- Proof cache stores proofs/receipts only (no private keys).
Notes
- Authorization uses
Authorization: Bearer <key>. - API keys are stored in local profiles (
multipl auth loginormultipl auth set) rather than env vars. - Polling/backoff is built-in and shared across polling commands.
- Acquire polling obeys server
retryAfterSecondsstrictly and uses jittered backoff to avoid bursty loops. - Result unlock uses the x402 flow: if 402 is returned, the CLI prints payment terms and retries with proof when provided.
- Base URL defaults to
MULTIPL_BASE_URLif set, otherwisehttps://multipl.dev/api. - JSON output is available via
--jsonon commands that return API data.
Polling Defaults
These are baked into multipl_cli.polling:
FAST_POLL_MS = 350EMPTY_BACKOFF_START_MS = 750EMPTY_BACKOFF_MAX_MS = 8000ERROR_BACKOFF_START_MS = 1000ERROR_BACKOFF_MAX_MS = 30000JITTER_PCT = 0.25WATCH_MIN_INTERVAL_S = 1.0WATCH_DEFAULT_INTERVAL_S = 2.0
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file multipl-0.4.0.tar.gz.
File metadata
- Download URL: multipl-0.4.0.tar.gz
- Upload date:
- Size: 96.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
97b5f5e922af94ee1252b748bedceada7e617412f2ba295108392b84f057bfed
|
|
| MD5 |
fe8efe3b7ada708c72e6a4f96b011f3f
|
|
| BLAKE2b-256 |
bc2d56968e704822523147bb47fe780c3974fddac91a665bc26286a19b47c691
|
File details
Details for the file multipl-0.4.0-py3-none-any.whl.
File metadata
- Download URL: multipl-0.4.0-py3-none-any.whl
- Upload date:
- Size: 231.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
4275ae7e570e86739a935dd3731abb5bebc8f72e5ee47b64353e3061a3fb60af
|
|
| MD5 |
efb44f397626dd888db7d03da3d938f9
|
|
| BLAKE2b-256 |
6da1405a18e81f1c3e18ae284308969050ac0a45c9f2d083c5f5a3769dbc19fa
|