Global flags
| Flag | Description |
|---|---|
--params '<JSON>' | Query and URL parameters (id, page, filters) |
--json '<JSON>' | Request body (POST/PUT/PATCH) |
--fields '<FIELDS>' | Limits the fields returned in the response |
--dry-run | Shows the request without running it |
--page-all | Automatic pagination, with NDJSON output |
--page-limit <N> | Maximum pages (default: 10) |
--page-delay <MS> | Interval between pages (default: 100ms) |
--env <ENV> | Environment: production (default) or development |
--verbose | Request details on stderr |
--output <PATH> | Saves the response to a file |
--output-format <FMT> | Format: json, table, csv |
--idempotency-key <KEY> | Custom idempotency key |
--dry-run shows the method, URL, query and body of the request without sending it. Use it before every action that changes data, triggers the agent or deletes. It does not validate the body against the spec: a missing required field only shows up in the API response (400 VALIDATION_ERROR).
Pagination. Listings are cursor-based. With --page-all, the CLI follows meta.next_cursor to the last page and prints one item per line (NDJSON). limit in --params sets each page size (up to 100). The rules are those of the API's Pagination.
Idempotency. Every POST, PUT and PATCH carries an X-Idempotency-Key; the CLI generates a new key per command. To safely repeat a call that failed midway (triggering a task, for example), pass the same key both times with --idempotency-key. The rules are in Idempotency.
Next steps​
- Usage — syntax, resources, examples.
- Schema introspection — parameters, required fields, types and responses.