Skip to content
Kindgi

List what a choice may be for

View as Markdown
GET
/v1/connection-choices/needs
curl --request GET \
  --url 'https://example.com/v1/connection-choices/needs?projectId=2489E9AD-2EE2-8E00-8EC9-32D5F69181C0' \
  --header 'Authorization: Bearer <token>'

Each of an agent’s or flow’s tools’ connections, at the version it resolves now: the tool, its name for the connection (need), the app and whose (as), and whether a choice for it may be a set (set.allowed, else set.reason: changes, sensitive-data-egress or accounts-input). A tool whose version couldn’t be read is listed in unread. The project’s members (read on the project).

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
projectId
required
string format: uuid

The project.

agentId
string

The agent; or flowId, one of them.

flowId
string

The flow; or agentId, one of them.

app
string

Only this app’s (its entry id).

Responses

Section titled “Responses”

200

Section titled “200”

The needs.

Media typeapplication/json
object
data
required
Array<object>

One of a tool’s connections, and whether a choice for it may be a set.

object
toolId
required
string
need
required

The tool’s name for the connection.

string
app
required

The app’s entry id.

string
as
required

Whose connection: the company’s, or the run’s person’s.

string
Allowed values: company person
set
required

Whether a choice for the tool’s connection may be a set, and if not, why not.

object
allowed
required
boolean
reason

Why not, with allowed: false: the tool changes things, may send what it reads elsewhere, or has its own accounts input.

string
Allowed values: changes sensitive-data-egress accounts-input
unread

The tools whose version couldn’t be read, refused or gone.

Array<string>
Example
{
  "data": [
    {
      "as": "company",
      "set": {
        "reason": "changes"
      }
    }
  ]
}

400

Section titled “400”

No projectId, or one that is not a UUID; an app that is not an entry id; or both or neither of agentId and flowId (bad-input).

Media typeapplication/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
{
  "error": {
    "code": "example",
    "message": "example",
    "details": {},
    "requestId": "example"
  }
}

401

Section titled “401”

Missing / malformed / expired / revoked bearer token.

Media typeapplication/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
{
  "error": {
    "code": "example",
    "message": "example",
    "details": {},
    "requestId": "example"
  }
}

403

Section titled “403”

Not a member of the project (permission-denied).

Media typeapplication/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
{
  "error": {
    "code": "example",
    "message": "example",
    "details": {},
    "requestId": "example"
  }
}

404

Section titled “404”

The agent or flow isn’t one of the project’s (agent-not-found, flow-not-found).

Media typeapplication/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
{
  "error": {
    "code": "example",
    "message": "example",
    "details": {},
    "requestId": "example"
  }
}

503

Section titled “503”

The database was too busy to answer in time (database-busy); Retry-After (whole seconds) says when to try again.

Media typeapplication/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
{
  "error": {
    "code": "example",
    "message": "example",
    "details": {},
    "requestId": "example"
  }
}

See also