Group
5 endpoints
POST /api/v5/artifacts/group/get
Get Group
Get detailed group information with all runs and messages.
Parameters:
| Name | In | Required | Description |
|---|---|---|---|
X-Api-Key | header | No | — |
authorization | header | No | — |
X-MCP | header | No | — |
Request body:
{
group_id: `string`
message_limit?: `integer` | `null`
message_offset?: `integer` | `null`
}Response:
{
group_exists?: `boolean`
actor_name?: `string` | `null`
group_name?: `string` | `null`
total_message_count?: `integer`
runs?: `GroupDetailRunWithMessages`[]
models?: `GroupDetailResourceItem`[]
agents?: `GroupDetailResourceItem`[]
profiles?: `GroupDetailResourceItem`[]
}POST /api/v5/artifacts/group/refresh
Group Refresh
Refresh group materialized views and invalidate caches.
Parameters:
| Name | In | Required | Description |
|---|---|---|---|
X-Api-Key | header | No | — |
authorization | header | No | — |
X-MCP | header | No | — |
Response:
{
success: `boolean`
refreshed_views: `string`[]
invalidated_tags: `string`[]
}POST /api/v5/artifacts/group/docs
Get Group Docs Endpoint
Get composed documentation for the group analytics.
Parameters:
| Name | In | Required | Description |
|---|---|---|---|
X-Api-Key | header | No | — |
authorization | header | No | — |
X-MCP | header | No | — |
Request body:
{
entity_id?: `string` | `null`
}Response:
{
name: `string`
type: `string`
description: `string`
artifact?: `DocsResponse` | `null`
entries: `DocsResponse`[]
resources: `DocsResponse`[]
permissions: `OperationInfo`[]
api_operations: `OperationInfo`[]
page_metadata?: `DocsApiResponse` | `null`
}POST /api/v5/artifacts/group/export
Export Group
Export group data as a clean, denormalized ZIP.
Parameters:
| Name | In | Required | Description |
|---|---|---|---|
X-Api-Key | header | No | — |
authorization | header | No | — |
X-MCP | header | No | — |
Request body:
{
group_id: `string`
}Response:
{
upload_id: `string`
file_name: `string`
row_count: `integer`
}POST /api/v5/artifacts/group/generate
Generate
Trigger artifact generation. Returns immediately; progress via events.
Parameters:
| Name | In | Required | Description |
|---|---|---|---|
X-Api-Key | header | No | — |
authorization | header | No | — |
X-MCP | header | No | — |
Request body:
{
artifact_types: `ArtifactTypeItem`[]
artifact_id?: `any` | `null`
draft_id?: `any` | `null`
resource_types: `ResourceTypeItem`[]
entry_types?: `EntryTypeItem`[] | `null`
user_instructions?: `string`[] | `null`
save?: `boolean`
run_id?: `string` | `null`
group_id?: `string` | `null`
modality?: `string`
extra_messages?: `object`[] | `null`
metadata?: `object` | `null`
}Response:
{
group_id: `string`
}Last updated on