---
title: "Connectors Cli"
method: POST
path: "/api/connectors/cli"
tags: ["connectors"]
---

# Connectors Cli

`POST /api/connectors/cli`

## Request

- Base URL: `https://app.getdot.ai` (the document declares no server; this is the origin it was published from)
- URL: `https://app.getdot.ai/api/connectors/cli`
- Auth: one of:
  - API key in header `X-API-KEY`
  - API key in cookie `Authorization`
  - OAuth 2 (password, token URL `/api/auth/token`)

Run one connectors CLI command server-side for the caller.

``save`` names output fields that hold a whole downloaded file (base64);
they come back beside stdout, uncapped, for the CLI to write to disk.

``full`` returns a run's whole output uncapped: `--save-df` turns all of
it into a table, not the first 30,000 characters.

``files`` carries whole-file arguments: an upload's base64 content, keyed
by the action argument it belongs to. They travel here rather than in
``argv`` because a real document exceeds ``_MAX_CLI_ARG_LEN`` as base64
long before it is large enough to be interesting, and an agent that cannot
pass one resorts to shrinking the file until it fits.

## Request body

- BodyConnectorsCliApiConnectorsCliPost
  - `argv` unknown[], required
    - unknown
  - `files` object, nullable
  - `save` unknown[], nullable
    - unknown
  - `full` boolean

## Response `200`

Successful Response

- object

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/getdot/apis/dot-api-2.md) · [All operations](https://skmtc.dev/getdot/apis/dot-api-2/llms.txt) · [OpenAPI document](https://skmtc.dev/getdot/apis/dot-api-2/revisions/d26fe7163a7f?raw)
