Organisations
Read which agents may connect to an organisation
"Only approved agents can connect": whether it is on, the approved agents, the known agents offered in one click, and the agents seen recently.
GET
/orgs/{org}/policies/agentsTL;DR
| Question | Answer |
|---|---|
| What does it do? | Read which agents may connect to an organisation. |
| What does it take? | org in the path. |
| What does it return? | Status 200 with a body of type AllowedAgentsPolicy. |
| What can go wrong? | 401 not signed in; 403 a member or a reader (orgs.forbidden); 404 no such organisation, or the caller is not a member of it; 429 too many requests; 503 organisations are not set up on this server. Every failure uses the one error envelope. |
What it does
"Only approved agents can connect": whether it is on, the approved agents, the known agents offered in one click, and the agents seen recently. The owner and admins.
Path parameters
| Field | Type | Required | Description |
|---|---|---|---|
org | string | yes | The organisation's id or its slug. |
Responses
| Status | Meaning | Body |
|---|---|---|
| 200 | The policy. | AllowedAgentsPolicy |
| 401 | Not signed in. | ErrorResponse |
| 403 | A member or a reader (orgs.forbidden). | ErrorResponse |
| 404 | No such organisation, or the caller is not a member of it. | ErrorResponse |
| 429 | Too many requests. | ErrorResponse |
| 503 | Organisations are not set up on this server. | ErrorResponse |
Response body
A 200 answer has the type AllowedAgentsPolicy.
| Field | Type | Required | Description |
|---|---|---|---|
enabled | boolean | yes | "Only approved agents can connect". False means any agent a member approves may connect. |
agents | AllowedAgent[] | yes | |
presets | object[] | yes | |
presets[].id | string | yes | |
presets[].label | string | yes | |
presets[].entries | object[] | yes | |
presets[].entries[].name | string | yes | |
presets[].entries[].redirect | string | yes | |
presets[].confirmed | boolean | yes | False when the name and redirect are what the agent is known to send but were not seen in Plotwork's own tests; it may not match. |
recent | object[] | yes | The agents that connected to the organisation in the last 90 days, one each, newest first. |
recent[].entry | AllowedAgent | yes | |
recent[].connections | integer | yes | How many of its connections to the organisation are live. |
recent[].lastConnectedAt | integer | yes |
See also
| Doc | Why |
|---|---|
| API reference | Every endpoint, and the error envelope |
| Schemas | Every request and response type |
| Tool reference | The operations as callable tools |