# Choose a connection PUT /v1/connection-choices ```sh curl --request PUT \ --url https://example.com/v1/connection-choices \ --header 'Authorization: Bearer ' \ --header 'Content-Type: application/json' \ --data '{ "projectId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "agentId": "example", "flowId": "example", "toolId": "example", "need": "example", "connectionId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "connectionIds": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ], "person": { "userId": "example" } }' ``` Chooses which connection an agent or a flow uses, in the project and this server’s environment, for the connection’s app; with `toolId`, which one that tool uses, ahead of the agent’s or flow’s. A tool’s choice may be a set (`connectionIds`): a call of a tool that changes nothing names one of them, by name, else uses `connectionId`. A company choice is the project’s admins’ (`admin` on the project). A person’s (`person`) is that person’s alone, for their own runs, and needs only what running the agent or flow does. The connection must be a candidate (`GET /v1/connection-choices/candidates`, with `owner=me` for your own). Choosing the connection already chosen answers that choice as it is. Choosing another removes that choice and makes a new one at the next `version`, in one step. ## Authorizations - **[bearerAuth](https://docs.kindgi.com/v0.5.0/reference/api.md#bearerauth)** ## Parameters ### Header Parameters **Idempotency-Key** string \>= 1 characters Caller-supplied idempotency key, scoped to the caller: the same key from someone else in the workspace is their own request (from 0.1.5). Retries with the same key return the original response byte-identical (per `docs/API-ROUTE-CONVENTIONS.md` §3.1). A retry sent while the first request still runs is answered `409 idempotency-key-in-flight` with `Retry-After`, on a runtime whose store holds keys (from 0.1.5); retry after it, and you get the first request’s answer. An answer that carries a secret (a new API key or public run token, a session token, a generated signing secret) isn’t kept: a retry gets `409 idempotency-key-replay-withheld`, with the first request’s status and when it succeeded (from 0.1.5). A request whose key store can’t be read before it runs is answered `503 idempotency-store-unavailable` with `Retry-After`: nothing ran, so retry with the same key (from 0.3.0). ## Request Bodyrequired application/json Name what the choice is for: `agentId` or `flowId`, one of them, and `toolId` for a tool’s own. A company choice is a project admin’s; a person’s (`person`) is theirs alone. object **projectId** required string format: uuid **agentId** One of the project’s agents. string \>= 1 characters **flowId** One of the project’s flows. string \>= 1 characters **toolId** One of the agent’s or flow’s tools that uses the connection’s app. string \>= 1 characters **need** The tool’s name for the connection. It may be left out when the tool uses the app once. string \>= 1 characters **connectionId** required One of the candidates (`GET /v1/connection-choices/candidates`, with `owner=me` for a person’s own). The choice is for its app. With `connectionIds`, the set’s default. string format: uuid **connectionIds** A set, for a tool’s choice: 2 to 10 different candidates, `connectionId` among them, each named. Only for a tool that changes nothing, doesn’t declare `sensitive-data-egress` and has no `accounts` input of its own (`GET /v1/connection-choices/needs`). Array\ \>= 2 items <= 10 items unique items **person** A choice of your own connection, for your own runs: you. object **userId** required string \>= 1 characters ##### Examplegenerated ```json { "projectId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "agentId": "example", "flowId": "example", "toolId": "example", "need": "example", "connectionId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "connectionIds": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ], "person": { "userId": "example" } } ``` ## Responses ### 200 The choice. application/json Which connection an agent or a flow uses for an app in a project, in one env: `agentId` or `flowId`, one of them. The company’s, or a person’s own (`person`), for their runs. With `toolId`, it’s that tool’s, which comes before the agent’s or flow’s. A choice is never changed: changing it removes it and makes a new one at the next version. object **choiceId** required string format: uuid **projectId** required string format: uuid **envName** required string **agentId** string **flowId** string **app** required The app’s entry id (`google`): the connection’s. string **toolId** The tool it’s for, with `need`. Absent: the agent’s or flow’s choice, for every tool’s need of the app. string **need** The tool’s name for the connection (`calendar`), with `toolId`. string **connectionId** required The chosen connection, and a set’s default. A choice of a connection that’s since been disconnected stays until it’s set again or removed. string format: uuid **connectionIds** A set: the connections a call of the tool may name one of (by its name), `connectionId` among them. A call that names none uses `connectionId`. Only a tool’s choice, for a tool that changes nothing. Absent for one connection. Array\ \>= 2 items <= 10 items **person** Whose choice it is, for a person’s connection: theirs alone to make, change or remove. Absent: the company’s. object **userId** required string \>= 1 characters **version** required From 1, per project, env, agent or flow, app, tool and need, and person. integer \>= 1 **createdAt** required string format: date-time **createdBy** required string **removedAt** When it was removed, or replaced by a new choice. Only a removed choice has it. string format: date-time **removedBy** string ##### Examplegenerated ```json { "choiceId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "projectId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "envName": "example", "agentId": "example", "flowId": "example", "app": "example", "toolId": "example", "need": "example", "connectionId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "connectionIds": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ], "person": { "userId": "example" }, "version": 1, "createdAt": "2026-04-15T12:00:00Z", "createdBy": "example", "removedAt": "2026-04-15T12:00:00Z", "removedBy": "example" } ``` ### 400 A malformed body or unknown field; a `projectId` or `connectionId` that is not a UUID; both `agentId` and `flowId`, or neither; a person’s own connection in a company choice; a `person` who isn’t the caller; a `toolId` the agent or flow has no tool of the app by; a `need` that’s missing for a tool that uses the app twice, or one the tool doesn’t have; or a set that isn’t for one tool, isn’t 2 to 10 different connections with the default among them, is for a tool that changes things, may send what it reads elsewhere (`sensitive-data-egress`) or has its own `accounts` input, or has a member with no name (`bad-input`, `details.field`). application/json object **error** required object **code** required Stable machine-readable discriminant. Values match domain error codes (see `docs/API-ROUTE-CONVENTIONS.md` §4.3). string **message** required string **details** Optional, kind-specific. object **_key_** additional properties any **requestId** required Server-assigned request id; also echoed via `X-Request-Id` header. string ##### Examplegenerated ```json { "error": { "code": "example", "message": "example", "details": {}, "requestId": "example" } } ``` ### 401 Missing / malformed / expired / revoked bearer token. application/json object **error** required object **code** required Stable machine-readable discriminant. Values match domain error codes (see `docs/API-ROUTE-CONVENTIONS.md` §4.3). string **message** required string **details** Optional, kind-specific. object **_key_** additional properties any **requestId** required Server-assigned request id; also echoed via `X-Request-Id` header. string ##### Examplegenerated ```json { "error": { "code": "example", "message": "example", "details": {}, "requestId": "example" } } ``` ### 403 A company choice by a caller who isn’t an admin of the project, or a person’s by one who may not run its agent or flow (`permission-denied`). application/json object **error** required object **code** required Stable machine-readable discriminant. Values match domain error codes (see `docs/API-ROUTE-CONVENTIONS.md` §4.3). string **message** required string **details** Optional, kind-specific. object **_key_** additional properties any **requestId** required Server-assigned request id; also echoed via `X-Request-Id` header. string ##### Examplegenerated ```json { "error": { "code": "example", "message": "example", "details": {}, "requestId": "example" } } ``` ### 404 No such project (`project-not-found`); the agent or flow isn’t one of the project’s (`agent-not-found`, `flow-not-found`); or a connection isn’t a candidate, the same answer as for one that doesn’t exist (`connection-not-found`, `details.field` `connectionId` or `connectionIds`). application/json object **error** required object **code** required Stable machine-readable discriminant. Values match domain error codes (see `docs/API-ROUTE-CONVENTIONS.md` §4.3). string **message** required string **details** Optional, kind-specific. object **_key_** additional properties any **requestId** required Server-assigned request id; also echoed via `X-Request-Id` header. string ##### Examplegenerated ```json { "error": { "code": "example", "message": "example", "details": {}, "requestId": "example" } } ``` ### 409 Idempotency-Key was reused with a different body, or resource-state conflict. application/json object **error** required object **code** required Stable machine-readable discriminant. Values match domain error codes (see `docs/API-ROUTE-CONVENTIONS.md` §4.3). string **message** required string **details** Optional, kind-specific. object **_key_** additional properties any **requestId** required Server-assigned request id; also echoed via `X-Request-Id` header. string ##### Examplegenerated ```json { "error": { "code": "example", "message": "example", "details": {}, "requestId": "example" } } ``` ### 413 The request body is over the API’s limit (`request-too-large`; `details.maxBytes` says how much). application/json object **error** required object **code** required Stable machine-readable discriminant. Values match domain error codes (see `docs/API-ROUTE-CONVENTIONS.md` §4.3). string **message** required string **details** Optional, kind-specific. object **_key_** additional properties any **requestId** required Server-assigned request id; also echoed via `X-Request-Id` header. string ##### Examplegenerated ```json { "error": { "code": "example", "message": "example", "details": {}, "requestId": "example" } } ``` ### 500 Server error (unmapped domain code or framework crash). application/json object **error** required object **code** required Stable machine-readable discriminant. Values match domain error codes (see `docs/API-ROUTE-CONVENTIONS.md` §4.3). string **message** required string **details** Optional, kind-specific. object **_key_** additional properties any **requestId** required Server-assigned request id; also echoed via `X-Request-Id` header. string ##### Examplegenerated ```json { "error": { "code": "example", "message": "example", "details": {}, "requestId": "example" } } ``` ### 503 The choice couldn’t be stored just now (`connection-store-failed`), or the `Idempotency-Key` store couldn’t be read before the request ran (`idempotency-store-unavailable`, with `Retry-After`). application/json object **error** required object **code** required Stable machine-readable discriminant. Values match domain error codes (see `docs/API-ROUTE-CONVENTIONS.md` §4.3). string **message** required string **details** Optional, kind-specific. object **_key_** additional properties any **requestId** required Server-assigned request id; also echoed via `X-Request-Id` header. string ##### Examplegenerated ```json { "error": { "code": "example", "message": "example", "details": {}, "requestId": "example" } } ``` ## See also - [`GET /v1/connection-choices`: List connection choices](https://docs.kindgi.com/v0.5.0/reference/api/operations/connectionchoiceslist.md) - [Choose a connection](https://docs.kindgi.com/v0.5.0/guides/connections/choose-a-connection.md) - [Kindgi 0.5.0](https://docs.kindgi.com/v0.5.0/releases/0.5.0.md) - [Error code `agent-not-found`](https://docs.kindgi.com/v0.5.0/reference/errors.md#agent-not-found) - [Error code `bad-input`](https://docs.kindgi.com/v0.5.0/reference/errors.md#bad-input) - [Error code `connection-not-found`](https://docs.kindgi.com/v0.5.0/reference/errors.md#connection-not-found) - [Error code `connection-store-failed`](https://docs.kindgi.com/v0.5.0/reference/errors.md#connection-store-failed) - [Error code `flow-not-found`](https://docs.kindgi.com/v0.5.0/reference/errors.md#flow-not-found) - [Error code `idempotency-store-unavailable`](https://docs.kindgi.com/v0.5.0/reference/errors.md#idempotency-store-unavailable) - [Error code `permission-denied`](https://docs.kindgi.com/v0.5.0/reference/errors.md#permission-denied) - [Error code `project-not-found`](https://docs.kindgi.com/v0.5.0/reference/errors.md#project-not-found) - [Error code `request-too-large`](https://docs.kindgi.com/v0.5.0/reference/errors.md#request-too-large) - [Every error code](https://docs.kindgi.com/v0.5.0/reference/errors.md)