Preview exact resources and sharing impact
POST
/v1/packages/{packageId}/items/previewRequires package_access_manage and sharing authority on each source. Consent binds actor, organization, package revision and source content. Maximum 200 resources per package; thread snapshots are limited to 1 MB each and 10 MB combined per package.
How to call this endpoint
Every ACP API request uses bearer authentication. The examples here show the actual request path, auth header, and body shape that the platform expects.
Path, query, and header parameters
These parameters control which ACP object the endpoint acts on and how the request is processed.
Path parameters
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
| packageId | path | string | Yes | — |
Query parameters
None.
Body schema
Content type: application/json · Required
| Field | Type | Required | Description |
|---|---|---|---|
| items | object[] | Yes | — |
| items[].resourceType | metronome_workflow | server | agent | skill | environment | prompt | knowledge_library | database | thread | Yes | — |
| items[].resourceId | string | Yes | — |
| items[].messageIds | string[] | No | — |
What the API returns
Each response code below includes the documented payload shape for the ACP API.
200Package operation resultapplication/json
| Field | Type | Required | Description |
|---|---|---|---|
| revision | integer | Yes | — |
| confirmation | string | Yes | — |
| items | object[] | Yes | — |
| items[].id | string | Yes | Unique identifier. |
| items[].resourceType | metronome_workflow | server | agent | skill | environment | prompt | knowledge_library | database | thread | Yes | — |
| items[].resourceId | string | Yes | — |
| items[].name | string | Yes | Human-readable name. |
| items[].description | string | Yes | Human-readable description. |
| items[].kind | string | Yes | — |
| items[].avatarUrl | string | No | The agent's own profile image, distinct from creatorAvatarUrl. Optional; an empty value uses the client's standard fallback. |
| items[].creatorId | string | No | — |
| items[].creatorName | string | No | — |
| items[].creatorAvatarUrl | string | No | — |
| items[].createdAt | string | No | ISO 8601 timestamp. |
| items[].updatedAt | string | No | ISO 8601 timestamp. |
| items[].sourceOwnerId | string | Yes | — |
| items[].approvedByUserId | string | Yes | — |
| items[].sourceUpdatedAt | string | Yes | — |
| items[].addedAt | string | Yes | — |
| items[].messageIds | string[] | No | — |
| items[].snapshot | object | Yes | — |
| items[].snapshot.messages | object[] | Yes | — |
| items[].snapshot.messages[].id | string | Yes | Unique identifier. |
| items[].snapshot.messages[].role | user | assistant | Yes | — |
| items[].snapshot.messages[].content | string | Yes | Raw text content. |
| items[].snapshot.messages[].createdAt | string | Yes | ISO 8601 timestamp. |
| items[].snapshot.capturedAt | string | Yes | — |
| notice | string | Yes | — |
400Package request rejected. HTTP status distinguishes invalid input (400), authentication (401), API scope (403), unavailable resource (404), changed revision or confirmation (409), and unsupported storage (503).application/json
| Field | Type | Required | Description |
|---|---|---|---|
| error | string | No | — |
| code | string | No | — |
| message | string | No | Message text. |
401Package request rejected. HTTP status distinguishes invalid input (400), authentication (401), API scope (403), unavailable resource (404), changed revision or confirmation (409), and unsupported storage (503).application/json
| Field | Type | Required | Description |
|---|---|---|---|
| error | string | No | — |
| code | string | No | — |
| message | string | No | Message text. |
403Package request rejected. HTTP status distinguishes invalid input (400), authentication (401), API scope (403), unavailable resource (404), changed revision or confirmation (409), and unsupported storage (503).application/json
| Field | Type | Required | Description |
|---|---|---|---|
| error | string | No | — |
| code | string | No | — |
| message | string | No | Message text. |
404Package request rejected. HTTP status distinguishes invalid input (400), authentication (401), API scope (403), unavailable resource (404), changed revision or confirmation (409), and unsupported storage (503).application/json
| Field | Type | Required | Description |
|---|---|---|---|
| error | string | No | — |
| code | string | No | — |
| message | string | No | Message text. |
409Package request rejected. HTTP status distinguishes invalid input (400), authentication (401), API scope (403), unavailable resource (404), changed revision or confirmation (409), and unsupported storage (503).application/json
| Field | Type | Required | Description |
|---|---|---|---|
| error | string | No | — |
| code | string | No | — |
| message | string | No | Message text. |
503Package request rejected. HTTP status distinguishes invalid input (400), authentication (401), API scope (403), unavailable resource (404), changed revision or confirmation (409), and unsupported storage (503).application/json
| Field | Type | Required | Description |
|---|---|---|---|
| error | string | No | — |
| code | string | No | — |
| message | string | No | Message text. |
Preview exact resources and sharing impact
Loading...
Response 200
Loading...