Organisations
List an organisation's own patterns
The patterns the owner and admins saved, without their source; find_pattern offers them first to the organisation's agents.
GET
/orgs/{org}/patternsTL;DR
| Question | Answer |
|---|---|
| What does it do? | List an organisation's own patterns. |
| What does it take? | org in the path. |
| What does it return? | Status 200 with a body of type OrganisationPatternList. |
| What can go wrong? | 401 not signed in, or the key is not valid; 404 no such organisation, the caller is not a member of it, or the key is another organisation's; 429 too many requests; 503 organisations are not set up on this server. Every failure uses the one error envelope. |
What it does
The patterns the owner and admins saved, without their source; find_pattern offers them first to the organisation's agents. Every member and a key of the organisation.
Path parameters
| Field | Type | Required | Description |
|---|---|---|---|
org | string | yes | The organisation's id or its slug. |
Responses
| Status | Meaning | Body |
|---|---|---|
| 200 | The patterns. | OrganisationPatternList |
| 401 | Not signed in, or the key is not valid. | ErrorResponse |
| 404 | No such organisation, the caller is not a member of it, or the key is another organisation's. | ErrorResponse |
| 429 | Too many requests. | ErrorResponse |
| 503 | Organisations are not set up on this server. | ErrorResponse |
Response body
A 200 answer has the type OrganisationPatternList.
| Field | Type | Required | Description |
|---|---|---|---|
items | OrganisationPatternSummary[] | yes | By title. |
items[].id | string | yes | What the tools take: org:<name>. |
items[].name | string | yes | The name after org:. |
items[].title | string | yes | |
items[].summary | string | yes | |
items[].whenToUse | string | yes | |
items[].kind | string | yes | The kind of diagram, such as flow. |
items[].tags | string[] | yes | |
items[].flavours | ("neutral" | "aws" | "azure" | "gcp")[] | yes | |
items[].slotCount | integer | yes | minimum 0. |
items[].createdAt | integer | yes | |
items[].updatedAt | integer | yes | |
items[].updatedBy | string | null | yes | The account that last saved it, or null once that account is gone. |
limit | integer | yes | The most patterns the organisation keeps. |
available | boolean | yes | Whether the organisation's plan includes its own patterns (Enterprise). Without it they are kept and not offered to agents. |
canEdit | boolean | yes | Whether the caller may save, change and remove them: the owner and admins, signed in. |
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 |