CLI API - Chatbase

Use chatbase api as an escape hatch for API v2 endpoints that do not have a dedicated CLI command. Pass an HTTP method and a path relative to /api/v2 — for example, /agents maps to https://www.chatbase.co/api/v2/agents. Authenticate first — see CLI Auth.

List resources

Fetch a collection:

chatbase api GET /agents

Limit results with --field:

chatbase api GET /agents --field limit=5

Add URL query parameters with --query (repeatable):

chatbase api GET /agents --query limit=5 --query status=active

Create a resource

Send a JSON body inline:

chatbase api POST /agents --body '{"name":"Support Bot"}'

Set individual body fields instead of raw JSON:

chatbase api POST /agents --field name="Support Bot"

Update a resource

Read the body from a file with @:

chatbase api PATCH /agents/agt_123 --body @patch.json

Pipe JSON from stdin with @-:

echo '{"name":"Renamed Bot"}' | chatbase api PATCH /agents/agt_123 --body @-

Request options

Flag	Purpose
`--body`	JSON request body — inline JSON, `@file`, or `@-` for stdin
`--field` / `-f`	Set a body field as `key=value` (repeatable)
`--query`	Add a URL query parameter as `key=value` (repeatable)

Supported methods: GET, POST, PUT, PATCH, DELETE. Use --json for raw API JSON in scripts. See Chatbase CLI for other global output flags.

Commands

Command	Purpose
`chatbase api METHOD PATH`	Call any API v2 endpoint directly

For every flag, run chatbase api --help.

​List resources

​Create a resource

​Update a resource

​Request options

​Commands

List resources

Create a resource

Update a resource

Request options

Commands