Groups

About 731 wordsAbout 2 min

Generated from docs/.vuepress/openapi.json. Refresh with npm run gen:api. Back to overview.

`GET /api/v1/groups` — Index Group

Tags: Groups

Responses

Status	Description
`default`	JSON envelope: `{data: ...}` on success, `{error: {code, message}}` on error.

`POST /api/v1/groups` — Store Group

Tags: Groups

Responses

Status	Description
`default`	JSON envelope: `{data: ...}` on success, `{error: {code, message}}` on error.

`GET /api/v1/groups/{id}` — Show Group

Tags: Groups

Path parameters

Name	Type	Required	Description
`id`	integer	yes

Responses

Status	Description
`default`	JSON envelope: `{data: ...}` on success, `{error: {code, message}}` on error.

`PATCH /api/v1/groups/{id}` — Update Group

Tags: Groups

Path parameters

Name	Type	Required	Description
`id`	integer	yes

Responses

Status	Description
`default`	JSON envelope: `{data: ...}` on success, `{error: {code, message}}` on error.

`DELETE /api/v1/groups/{id}` — Destroy Group

Tags: Groups

Path parameters

Name	Type	Required	Description
`id`	integer	yes

Responses

Status	Description
`default`	JSON envelope: `{data: ...}` on success, `{error: {code, message}}` on error.

`GET /api/v1/groups/{id}/agents` — Agents Group

Tags: Groups

Path parameters

Name	Type	Required	Description
`id`	integer	yes

Responses

Status	Description
`default`	JSON envelope: `{data: ...}` on success, `{error: {code, message}}` on error.

`GET /api/v1/groups/{id}/llm-configs` — Index GroupLlmConfigs

Tags: Groups

Path parameters

Name	Type	Required	Description
`id`	integer	yes

Responses

Status	Description
`default`	JSON envelope: `{data: ...}` on success, `{error: {code, message}}` on error.

`POST /api/v1/groups/{id}/llm-configs` — Store GroupLlmConfigs

Tags: Groups

Path parameters

Name	Type	Required	Description
`id`	integer	yes

Responses

Status	Description
`default`	JSON envelope: `{data: ...}` on success, `{error: {code, message}}` on error.

`PATCH /api/v1/groups/{id}/llm-configs/{cid}` — Update GroupLlmConfigs

Tags: Groups

Path parameters

Name	Type	Required	Description
`id`	integer	yes
`cid`	integer	yes

Responses

Status	Description
`default`	JSON envelope: `{data: ...}` on success, `{error: {code, message}}` on error.

`DELETE /api/v1/groups/{id}/llm-configs/{cid}` — Destroy GroupLlmConfigs

Tags: Groups

Path parameters

Name	Type	Required	Description
`id`	integer	yes
`cid`	integer	yes

Responses

Status	Description
`default`	JSON envelope: `{data: ...}` on success, `{error: {code, message}}` on error.

`POST /api/v1/groups/{id}/llm-configs/{cid}/set-default` — SetDefault GroupLlmConfigs

Tags: Groups

Path parameters

Name	Type	Required	Description
`id`	integer	yes
`cid`	integer	yes

Responses

Status	Description
`default`	JSON envelope: `{data: ...}` on success, `{error: {code, message}}` on error.

`GET /api/v1/groups/{id}/members` — Index GroupMember

Tags: Groups

Path parameters

Name	Type	Required	Description
`id`	integer	yes

Responses

Status	Description
`default`	JSON envelope: `{data: ...}` on success, `{error: {code, message}}` on error.

`POST /api/v1/groups/{id}/members` — Store GroupMember

Tags: Groups

Path parameters

Name	Type	Required	Description
`id`	integer	yes

Responses

Status	Description
`default`	JSON envelope: `{data: ...}` on success, `{error: {code, message}}` on error.

`PATCH /api/v1/groups/{id}/members/{uid}` — Update GroupMember

Tags: Groups

Path parameters

Name	Type	Required	Description
`id`	integer	yes
`uid`	string	yes

Responses

Status	Description
`default`	JSON envelope: `{data: ...}` on success, `{error: {code, message}}` on error.

`DELETE /api/v1/groups/{id}/members/{uid}` — Destroy GroupMember

Tags: Groups

Path parameters

Name	Type	Required	Description
`id`	integer	yes
`uid`	string	yes

Responses

Status	Description
`default`	JSON envelope: `{data: ...}` on success, `{error: {code, message}}` on error.

`POST /api/v1/groups/{id}/picture/image` — UploadImage GroupPicture

Tags: Groups

Path parameters

Name	Type	Required	Description
`id`	string	yes

Responses

Status	Description
`default`	JSON envelope: `{data: ...}` on success, `{error: {code, message}}` on error.

`DELETE /api/v1/groups/{id}/picture/image` — DeleteImage GroupPicture

Tags: Groups

Path parameters

Name	Type	Required	Description
`id`	string	yes

Responses

Status	Description
`default`	JSON envelope: `{data: ...}` on success, `{error: {code, message}}` on error.

`GET /api/v1/groups/{id}/preferences` — Show GroupPreferences

Tags: Groups

Path parameters

Name	Type	Required	Description
`id`	integer	yes

Responses

Status	Description
`default`	JSON envelope: `{data: ...}` on success, `{error: {code, message}}` on error.

`PUT /api/v1/groups/{id}/preferences` — Update GroupPreferences

Tags: Groups

Path parameters

Name	Type	Required	Description
`id`	integer	yes

Responses

Status	Description
`default`	JSON envelope: `{data: ...}` on success, `{error: {code, message}}` on error.

`GET /api/v1/groups/{id}/tools` — Index GroupTools

Tags: Groups

Path parameters

Name	Type	Required	Description
`id`	integer	yes

Responses

Status	Description
`default`	JSON envelope: `{data: ...}` on success, `{error: {code, message}}` on error.

`POST /api/v1/groups/{id}/tools/{toolClass}` — Upsert GroupTools

Tags: Groups

Path parameters

Name	Type	Required	Description
`id`	integer	yes
`toolClass`	string	yes

Responses

Status	Description
`default`	JSON envelope: `{data: ...}` on success, `{error: {code, message}}` on error.

`DELETE /api/v1/groups/{id}/tools/{toolClass}` — Destroy GroupTools

Tags: Groups

Path parameters

Name	Type	Required	Description
`id`	integer	yes
`toolClass`	string	yes

Responses

Status	Description
`default`	JSON envelope: `{data: ...}` on success, `{error: {code, message}}` on error.