bdy api info

$bdy api info [options] <method> <url>

Show the documentation of an API endpoint

ARGUMENTS

method

Endpoint method (get, post, put, patch, delete) (required)

url

Endpoint url (required)

OPTIONS

--context <name>

Connection and scope context: default, git, link or a saved name. Overrides the globally active context for this invocation.

--examples

Show only examples; with this flag --format accepts text, json or jsonl

--verbose

Show REST API requests, responses, timing and retries on stderr

-w, --workspace <domain>

Workspace URL handle. Can be set via variable: BUDDY_WORKSPACE

-p, --project <name>

Project name. Can be set via variable: BUDDY_PROJECT

--request-schema <schema>

Pass schema name or index to view it

--response-schema <schema>

Pass schema name or index to view it

--format <text|json>

Output format: json, text. JSON CLI errors: {error:{code,message,hint}}, exit 1. Default: text (choices: "text", "json")

-h, --help

display help for command

Documentation for bdy v1.25.20

Last modified on Oct 14, 2026

Examples

Return the result as JSON
bdy api info GET /workspaces --format json$