Fetch a generated artwork image
/ai/artwork/imagesStreams an artwork image produced by POST /ai/generate-artwork. Unlike
GET /ai/images (which browsers can call via a signed URL), artwork
images sit outside the chat image tree, so this route is fetched with the
X-Api-Key header and is scoped to the linked user's own artwork
directory (/filestore/artwork/{userId}/...).
Requires the ai key scope and a linked service user. Pass the path
value returned by the generate-artwork response.
Authorization
apiKey Issued to you when your integration is provisioned. Determines which catalogue resources are visible and which AI tools are available.
In: header
Query Parameters
The path returned in a generate-artwork image entry.
Response Body
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/ai/artwork/images?path=string""string"{ "success": false, "status": "fail", "message": "string", "error": { "message": "API key is required", "code": "NO_API_KEY" }}{ "success": false, "status": "fail", "message": "API key is required", "error": { "code": "NO_API_KEY", "message": "API key is required" }}{ "success": false, "status": "fail", "message": "This API key does not have the 'write' scope", "error": { "code": "INSUFFICIENT_SCOPE", "message": "This API key does not have the 'write' scope" }}{ "success": false, "status": "fail", "message": "string", "error": { "message": "API key is required", "code": "NO_API_KEY" }}List AI tools available to this api-key GET
Tools are filtered by the api-key's permissions. The `defaults` array shows which tools are enabled if you omit `tools` from a chat message body.
Today's trending search topics GET
Returns today's trending Google searches with the news headlines behind them, for a region. Direct REST equivalent of the chat `trending_topics` tool — useful for "what's trending that we could promote against?". Requires the `ai` key scope and a linked service user. A GET under `/ai/` still requires the `ai` scope.