inklate api

Call any REST endpoint directly (escape hatch)

Examples: inklate api GET /posts, inklate api POST /posts --field content=hello --field channel_ids='["<channel-id>"]', inklate api POST /posts --input body.json.

inklate api <method> <path> [flags]

Arguments

ArgumentDescription
methodHTTP method
pathEndpoint path, e.g. /posts

Flags

FlagDescription
--field <value>Body field as key=value (value parsed as JSON when it looks like it) (repeatable)
--query <value>Query param as key=value (repeatable)
--input <value>Read the JSON body from a file (- for stdin)

Output

Structured YAML on stdout (--json for JSON); progress and errors on stderr. Exit codes: 0 ok · 1 unexpected · 2 usage · 3 auth · 4 refusal · 5 not found · 6 conflict · 7 rate limited.

Global flags on every command: --org, --profile, --json, --quiet, --yes, --no-input, --base-url — see the CLI overview.