diff --git a/docs/index.html b/docs/index.html index 6bbb5c2da..4c000838f 100644 --- a/docs/index.html +++ b/docs/index.html @@ -481,11 +481,11 @@ -
SpaceCat logo

Patches (merges) customer configuration for an organization (v2)

Development server

https://spacecat.experiencecloud.live/api/ci/v2/orgs/{spaceCatId}/llmo-customer-config

Production server

-
https://spacecat.experiencecloud.live/api/v1/v2/orgs/{spaceCatId}/llmo-customer-config

Request samples

Content type
application/json
Example
{
  • "customer": {
    }
}

Response samples

Content type
application/json
{
  • "message": "Customer configuration updated successfully",
  • "stats": {
    }
}

Retrieves lean customer configuration (without prompts) for an IMS Org (v2)

https://spacecat.experiencecloud.live/api/v1/v2/orgs/{spaceCatId}/llmo-customer-config

Request samples

Content type
application/json
Example
{
  • "customer": {
    }
}

Response samples

Content type
application/json
{
  • "message": "Customer configuration updated successfully",
  • "stats": {
    }
}

Retrieves lean customer configuration (without prompts) for an IMS Org (v2)

Development server

https://spacecat.experiencecloud.live/api/ci/v2/orgs/{spaceCatId}/llmo-customer-config-lean

Production server

-
https://spacecat.experiencecloud.live/api/v1/v2/orgs/{spaceCatId}/llmo-customer-config-lean

Response samples

Content type
application/json
{
  • "customer": {
    }
}

Retrieves topics for an IMS Org (v2)

https://spacecat.experiencecloud.live/api/v1/v2/orgs/{spaceCatId}/llmo-customer-config-lean

Response samples

Content type
application/json
{
  • "customer": {
    }
}

Retrieves topics for an IMS Org (v2)

Development server

https://spacecat.experiencecloud.live/api/ci/v2/orgs/{spaceCatId}/llmo-topics

Production server

-
https://spacecat.experiencecloud.live/api/v1/v2/orgs/{spaceCatId}/llmo-topics

Response samples

Content type
application/json
{
  • "topics": [
    ]
}

Retrieves prompts for an IMS Org (v2)

https://spacecat.experiencecloud.live/api/v1/v2/orgs/{spaceCatId}/llmo-topics

Response samples

Content type
application/json
{
  • "topics": [
    ]
}

Retrieves prompts for an IMS Org (v2)

Development server

https://spacecat.experiencecloud.live/api/ci/v2/orgs/{spaceCatId}/llmo-prompts

Production server

-
https://spacecat.experiencecloud.live/api/v1/v2/orgs/{spaceCatId}/llmo-prompts

Response samples

Content type
application/json
{
  • "prompts": [
    ]
}

trigger

https://spacecat.experiencecloud.live/api/v1/v2/orgs/{spaceCatId}/llmo-prompts

Response samples

Content type
application/json
{
  • "prompts": [
    ]
}

List prompts for a brand

Returns a paginated list of prompts for the given brand. +Upsert uniqueness: match by id or by (text, regions).

+
Authorizations:
ims_keyapi_key
path Parameters
spaceCatId
required
string <uuid>

SpaceCat Organization ID (UUID)

+
brandId
required
string

Brand ID (UUID, config id, or brand name)

+
query Parameters
limit
integer [ 1 .. 5000 ]
Default: 100

Page size

+
page
integer >= 1
Default: 1

Page number (1-based)

+
categoryId
string

Filter by category business key

+
topicId
string

Filter by topic business key

+
status
string
Enum: "active" "pending" "deleted"

Filter by status; default excludes deleted

+
search
string

Free-text search across prompt text and name (ILIKE match)

+
region
string

Filter by region (matches prompts whose regions array contains this value)

+
origin
string
Enum: "ai" "human"

Filter by origin (ai or human)

+
sort
string
Enum: "topic" "prompt" "category" "origin" "status" "updatedAt"

Sort column. Default is updatedAt descending

+
order
string
Default: "desc"
Enum: "asc" "desc"

Sort direction. Default is desc

+

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "total": 0,
  • "limit": 0,
  • "page": 0
}

Create or upsert prompts (bulk)

Upserts prompts. Match by id or by (text, regions). If match found, update; else insert.

+
Authorizations:
ims_keyapi_key
path Parameters
spaceCatId
required
string <uuid>

SpaceCat Organization ID (UUID)

+
brandId
required
string

Brand ID (UUID, config id, or brand name)

+
query Parameters
limit
integer [ 1 .. 5000 ]
Default: 100

Page size

+
page
integer >= 1
Default: 1

Page number (1-based)

+
categoryId
string

Filter by category business key

+
topicId
string

Filter by topic business key

+
status
string
Enum: "active" "pending" "deleted"

Filter by status; default excludes deleted

+
search
string

Free-text search across prompt text and name (ILIKE match)

+
region
string

Filter by region (matches prompts whose regions array contains this value)

+
origin
string
Enum: "ai" "human"

Filter by origin (ai or human)

+
sort
string
Enum: "topic" "prompt" "category" "origin" "status" "updatedAt"

Sort column. Default is updatedAt descending

+
order
string
Default: "desc"
Enum: "asc" "desc"

Sort direction. Default is desc

+
Request Body schema: application/json
required
Array ([ 1 .. 3000 ] items)
id
string

Optional business key; auto-generated if omitted

+
prompt
required
string

The search query prompt text

+
name
string

Display name (defaults to prompt slice)

+
regions
Array of strings
Default: []
categoryId
string
topicId
string
status
string
Default: "active"
Enum: "active" "pending" "deleted"
origin
string
Default: "human"
Enum: "ai" "human"
source
string
Default: "config"

The source system or process that created the prompt

+

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "created": 0,
  • "updated": 0,
  • "prompts": [
    ]
}

Get a single prompt

Authorizations:
ims_keyapi_key
path Parameters
spaceCatId
required
string <uuid>
brandId
required
string
promptId
required
string

prompt_id (business key)

+

Responses

Response samples

Content type
application/json
{
  • "id": "photoshop-prompt-1",
  • "prompt": "string",
  • "name": "string",
  • "regions": [
    ],
  • "categoryId": "string",
  • "topicId": "string",
  • "status": "active",
  • "origin": "ai",
  • "source": "config",
  • "updatedAt": "2024-01-19T14:20:30Z",
  • "updatedBy": "string",
  • "brandId": "0e9bcbb3-096e-49f9-aeea-7a13a201eff5",
  • "brandName": "string",
  • "category": {
    },
  • "topic": {
    }
}

Update a single prompt

Authorizations:
ims_keyapi_key
path Parameters
spaceCatId
required
string <uuid>
brandId
required
string
promptId
required
string

prompt_id (business key)

+
Request Body schema: application/json
id
string

Optional business key; auto-generated if omitted

+
prompt
required
string

The search query prompt text

+
name
string

Display name (defaults to prompt slice)

+
regions
Array of strings
Default: []
categoryId
string
topicId
string
status
string
Default: "active"
Enum: "active" "pending" "deleted"
origin
string
Default: "human"
Enum: "ai" "human"
source
string
Default: "config"

The source system or process that created the prompt

+

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "prompt": "string",
  • "name": "string",
  • "regions": [ ],
  • "categoryId": "string",
  • "topicId": "string",
  • "status": "active",
  • "origin": "ai",
  • "source": "config"
}

Response samples

Content type
application/json
{
  • "id": "photoshop-prompt-1",
  • "prompt": "string",
  • "name": "string",
  • "regions": [
    ],
  • "categoryId": "string",
  • "topicId": "string",
  • "status": "active",
  • "origin": "ai",
  • "source": "config",
  • "updatedAt": "2024-01-19T14:20:30Z",
  • "updatedBy": "string",
  • "brandId": "0e9bcbb3-096e-49f9-aeea-7a13a201eff5",
  • "brandName": "string",
  • "category": {
    },
  • "topic": {
    }
}

Soft-delete a prompt

Sets status to 'deleted'.

+
Authorizations:
ims_keyapi_key
path Parameters
spaceCatId
required
string <uuid>
brandId
required
string
promptId
required
string

prompt_id (business key)

+

Responses

Bulk soft-delete prompts

Soft-deletes multiple prompts by setting their status to 'deleted'. +Uses POST instead of DELETE because the body-data middleware does not parse DELETE request bodies. +See ADR-001 for details.

+
Authorizations:
ims_keyapi_key
path Parameters
spaceCatId
required
string <uuid>

SpaceCat Organization ID (UUID)

+
brandId
required
string

Brand ID (UUID, config id, or brand name)

+
Request Body schema: application/json
required
promptIds
required
Array of strings [ 1 .. 100 ] items

Array of prompt business keys to soft-delete

+

Responses

Request samples

Content type
application/json
{
  • "promptIds": [
    ]
}

Response samples

Content type
application/json
{
  • "metadata": {
    },
  • "failures": [
    ]
}

trigger

Trigger operations

Trigger an audit Deprecated

Development server

https://spacecat.experiencecloud.live/api/ci/sites/{siteId}/llmo/brand-claims

Production server

-
https://spacecat.experiencecloud.live/api/v1/sites/{siteId}/llmo/brand-claims

Response samples

Content type
application/json
{
  • "siteId": "9ae8877a-bbf3-407d-9adb-d6a72ce3c5e3",
  • "model": "gpt-4.1",
  • "presignedUrl": "http://example.com",
  • "expiresAt": "2025-06-15T12:00:00.000Z"
}

Create or update edge optimization configuration for an LLMO site +

https://spacecat.experiencecloud.live/api/v1/sites/{siteId}/llmo/brand-claims

Response samples

Content type
application/json
{
  • "siteId": "9ae8877a-bbf3-407d-9adb-d6a72ce3c5e3",
  • "model": "gpt-4.1",
  • "presignedUrl": "http://example.com",
  • "expiresAt": "2025-06-15T12:00:00.000Z"
}

Get presigned URL for summit demo brand presence fixture

Returns a presigned S3 URL for downloading the summit demo brand presence fixture. +Used by the Opportunity Workspace summit demo to load static performance data +without bundling it in the UI.

+

S3 key: workspace/llmo/demo/summit-demo-brand-presence.json

+
Authorizations:
api_key
path Parameters
siteId
required
string <uuid> (Id)
Example: 123e4567-e89b-12d3-a456-426614174000

The site ID in uuid format

+

Responses

Response samples

Content type
application/json
{}

Get presigned URL for summit demo recommendations fixture

Returns a presigned S3 URL for downloading the summit demo recommendations fixture. +Used by the Opportunity Workspace summit demo to load static recommendations data +without bundling it in the UI.

+

S3 key: workspace/llmo/demo/summit-demo-recommendations.json

+
Authorizations:
api_key
path Parameters
siteId
required
string <uuid> (Id)
Example: 123e4567-e89b-12d3-a456-426614174000

The site ID in uuid format

+

Responses

Response samples

Content type
application/json
{}

Create or update edge optimization configuration for an LLMO site

Development server

https://spacecat.experiencecloud.live/api/ci/sites/{siteId}/llmo/edge-optimize-config

Production server

-
https://spacecat.experiencecloud.live/api/v1/sites/{siteId}/llmo/edge-optimize-config

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

Retrieve edge optimization configuration for an LLMO site +

https://spacecat.experiencecloud.live/api/v1/sites/{siteId}/llmo/edge-optimize-config

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

Retrieve edge optimization configuration for an LLMO site

Development server

https://spacecat.experiencecloud.live/api/ci/sites/{siteId}/llmo/edge-optimize-config

Production server

-
https://spacecat.experiencecloud.live/api/v1/sites/{siteId}/llmo/edge-optimize-config

Response samples

Content type
application/json
{ }

Add staging domains for edge optimize (stage environment support)

https://spacecat.experiencecloud.live/api/v1/sites/{siteId}/llmo/edge-optimize-config

Response samples

Content type
application/json
{ }

Add staging domains for edge optimize (stage environment support)

Development server

https://spacecat.experiencecloud.live/api/ci/sites/{siteId}/llmo/edge-optimize-config/stage

Production server

-
https://spacecat.experiencecloud.live/api/v1/sites/{siteId}/llmo/edge-optimize-config/stage

Request samples

Content type
application/json
{
  • "stagingDomains": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Check Edge Optimize status for a site path

https://spacecat.experiencecloud.live/api/v1/sites/{siteId}/llmo/edge-optimize-config/stage

Request samples

Content type
application/json
{
  • "stagingDomains": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Check Edge Optimize status for a site path

Development server

https://spacecat.experiencecloud.live/api/ci/sites/{siteId}/llmo/edge-optimize-status

Production server

-
https://spacecat.experiencecloud.live/api/v1/sites/{siteId}/llmo/edge-optimize-status

Response samples

Content type
application/json
{
  • "edgeOptimizeEnabled": true
}

Update edge optimize routing for a site

https://spacecat.experiencecloud.live/api/v1/sites/{siteId}/llmo/edge-optimize-status

Response samples

Content type
application/json
{
  • "edgeOptimizeEnabled": true
}

Update edge optimize routing for a site

Development server

https://spacecat.experiencecloud.live/api/ci/sites/{siteId}/llmo/edge-optimize-routing

Production server

-
https://spacecat.experiencecloud.live/api/v1/sites/{siteId}/llmo/edge-optimize-routing

Request samples

Content type
application/json
{
  • "cdnType": "aem-cs-fastly",
  • "enabled": true
}

Response samples

Content type
application/json
{
  • "enabled": true,
  • "domain": "www.example.com",
  • "cdnType": "aem-cs-fastly"
}

Get LLMO strategy

https://spacecat.experiencecloud.live/api/v1/sites/{siteId}/llmo/edge-optimize-routing

Request samples

Content type
application/json
{
  • "cdnType": "aem-cs-fastly",
  • "enabled": true
}

Response samples

Content type
application/json
{
  • "enabled": true,
  • "domain": "www.example.com",
  • "cdnType": "aem-cs-fastly"
}

Get LLMO strategy

Development server

https://spacecat.experiencecloud.live/api/ci/sites/{siteId}/llmo/strategy

Production server

-
https://spacecat.experiencecloud.live/api/v1/sites/{siteId}/llmo/strategy

Response samples

Content type
application/json
{
  • "data": { },
  • "version": "abc123def456"
}

Save LLMO strategy

https://spacecat.experiencecloud.live/api/v1/sites/{siteId}/llmo/strategy

Response samples

Content type
application/json
{
  • "data": { },
  • "version": "abc123def456"
}

Save LLMO strategy

Development server

https://spacecat.experiencecloud.live/api/ci/sites/{siteId}/llmo/strategy

Production server

-
https://spacecat.experiencecloud.live/api/v1/sites/{siteId}/llmo/strategy

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "version": "abc123def456",
  • "notifications": {
    }
}

entitlements

https://spacecat.experiencecloud.live/api/v1/sites/{siteId}/llmo/strategy

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "version": "abc123def456",
  • "notifications": {
    }
}

Get brand vs competitors aggregated data

Returns aggregated competitor mention/citation data for a site. +Internally performs two PostgREST queries: first discovers execution +dates from brand_presence_executions, then queries the +brand_vs_competitors_by_date view with those dates.

+
Authorizations:
api_key
path Parameters
spaceCatId
required
string <uuid>

Organization ID (UUID)

+
brandId
required
string

Brand UUID or 'all' for all brands

+
query Parameters
siteId
required
string <uuid>

Site UUID (required)

+
startDate
string <date>

Start of date range (YYYY-MM-DD). Defaults to 28 days ago.

+
endDate
string <date>

End of date range (YYYY-MM-DD). Defaults to today.

+
model
string
Default: "chatgpt"

LLM model name

+
categoryName
string

Filter by category name

+
regionCode
string

Filter by region code (e.g. US, EU)

+

Responses

Response samples

Content type
application/json
{
  • "competitorData": [
    ]
}

entitlements

Entitlement management operations

List all entitlements for an organization

This endpoint retrieves all entitlements associated with a specific organization.

@@ -11089,7 +11343,7 @@ " class="sc-iKGpAq sc-cCYyou dXXcln cFvDiF">

Production server

https://spacecat.experiencecloud.live/api/v1/sites/{siteId}/opportunities/{opportunityId}/status

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "fixes": [
    ],
  • "metadata": {
    }
}