Batch retrieve brand context items

Request

Retrieves specific files or folders from a brand context in a single batched call. File responses include Markdown content. Between 1 and 50 unique IDs per call. A single failed item is returned with fetchStatus is failed and the upstream error message in fetchStatusMessage rather than failing the whole batch. The response carries requested, succeeded, or failed completeness counts alongside the data array.

Security

HTTPBearer

Path

brandContextIdstring, (uuid)(Brandcontextid)required

The unique identifier of the brand context from which to retrieve items. To get this ID, you can use the List brand contexts endpoint to retrieve the list of brand contexts in your organization.

Example:3f2504e0-4f89-11d3-9a0c-0305e82c3301

Query

idsstring(Ids)required

Comma-separated brand context item IDs (UUIDs) of files or folders to fetch, up to 50. To get these IDs, you can use the Retrieve a brand context by ID endpoint to retrieve the complete nested folder or file tree index of the brand context.

Example:ids=3f2504e0-4f89-11d3-9a0c-0305e82c3301,a1b2c3d4-4f89-11d3-9a0c-0305e82c3301&ids=3f2504e0-4f89-11d3-9a0c-0305e82c3301,a1b2c3d4-4f89-11d3-9a0c-0305e82

Headers

x-sc-job-idany(X-Sc-Job-Id)

A unique identifier for the job, used to trace, audit, and revert actions performed by an AI agent through the Agent API.

Example:job-1234

curl -i -X GET \
  'https://edge-platform.sitecorecloud.io/stream/ai-agent-api/api/v1/brand-contexts/3f2504e0-4f89-11d3-9a0c-0305e82c3301/items?ids=3f2504e0-4f89-11d3-9a0c-0305e82c3301%2Ca1b2c3d4-4f89-11d3-9a0c-0305e82c3301' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'x-sc-job-id: job-1234'

Responses

Successful response

Bodyapplication/json

requestedinteger(Requested)

The number of IDs requested.

Example:3

succeededinteger(Succeeded)

The number of IDs whose fetch succeeded.

Example:2

failedinteger(Failed)

The number of IDs whose fetch failed.

Example:1

dataArray of objects(Data)

One entry per requested ID, in the order requested. Each entry contains the fetched data for that ID, or an error if the fetch failed.

Response

{
  "requested": 3,
  "succeeded": 2,
  "failed": 1,
  "data": [
    { … }
  ]
}