@llmpulse/sdk 0.0.0-stage → 1.60.0

package/docs/AnswerDetails.md

@@ -0,0 +1,78 @@
+
+# AnswerDetails
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | number
+`promptId` | number
+`promptText` | string
+`model` | string
+`response` | string
+`responseTruncated` | boolean
+`executedAt` | Date
+`durationMs` | number
+`success` | boolean
+`noResult` | boolean
+`fanOutQueries` | Array<string>
+`mentions` | Array<object>
+`citations` | Array<object>
+`competitorMentions` | Array<object>
+`competitorCitations` | Array<object>
+`sentiments` | Array<object>
+`sources` | Array<object>
+`shoppingProducts` | Array<object>
+`brandEntities` | Array<object>
+`localBusinesses` | Array<object>
+`locale` | [AnswerDetailsLocale](AnswerDetailsLocale.md)
+`appUrl` | string
+`requestId` | string
+
+## Example
+
+```typescript
+import type { AnswerDetails } from '@llmpulse/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "promptId": null,
+  "promptText": null,
+  "model": null,
+  "response": null,
+  "responseTruncated": null,
+  "executedAt": null,
+  "durationMs": null,
+  "success": null,
+  "noResult": null,
+  "fanOutQueries": null,
+  "mentions": null,
+  "citations": null,
+  "competitorMentions": null,
+  "competitorCitations": null,
+  "sentiments": null,
+  "sources": null,
+  "shoppingProducts": null,
+  "brandEntities": null,
+  "localBusinesses": null,
+  "locale": null,
+  "appUrl": null,
+  "requestId": null,
+} satisfies AnswerDetails
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as AnswerDetails
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/AnswerDetailsLocale.md

@@ -0,0 +1,36 @@
+
+# AnswerDetailsLocale
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`countryCode` | string
+`languageCode` | string
+
+## Example
+
+```typescript
+import type { AnswerDetailsLocale } from '@llmpulse/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "countryCode": null,
+  "languageCode": null,
+} satisfies AnswerDetailsLocale
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as AnswerDetailsLocale
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/AnswersApi.md

@@ -0,0 +1,202 @@
+# AnswersApi
+
+All URIs are relative to *https://api.llmpulse.ai/api/v1*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**getAnswer**](AnswersApi.md#getanswer) | **GET** /answers/{id} | Get one AI response |
+| [**listAnswers**](AnswersApi.md#listanswers) | **GET** /answers | List AI responses |
+
+
+
+## getAnswer
+
+> AnswerDetails getAnswer(projectId, id, includeSourcePageDetails)
+
+Get one AI response
+
+Full answer with mentions, citations, sentiments, sources, shopping_products, brand_entities, fan_out_queries. Pass `include_source_page_details=true` to nest page-cache metadata under each source.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AnswersApi,
+} from '@llmpulse/sdk';
+import type { GetAnswerRequest } from '@llmpulse/sdk';
+
+async function example() {
+  console.log("🚀 Testing @llmpulse/sdk SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: BearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new AnswersApi(config);
+
+  const body = {
+    // number | Project ID
+    projectId: 56,
+    // number
+    id: 56,
+    // boolean (optional)
+    includeSourcePageDetails: true,
+  } satisfies GetAnswerRequest;
+
+  try {
+    const data = await api.getAnswer(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **projectId** | `number` | Project ID | [Defaults to `undefined`] |
+| **id** | `number` |  | [Defaults to `undefined`] |
+| **includeSourcePageDetails** | `boolean` |  | [Optional] [Defaults to `false`] |
+
+### Return type
+
+[**AnswerDetails**](AnswerDetails.md)
+
+### Authorization
+
+[BearerAuth](../README.md#BearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Answer details |  -  |
+| **404** | Resource not found |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## listAnswers
+
+> listAnswers(projectId, model, collectionId, countryCode, languageCode, prompt, mentionFilter, citationFilter, competitors, from, to, page, perPage, query, noResult)
+
+List AI responses
+
+Successful prompt-execution responses with truncated content (max 10,000 chars). Pass `query` for case-insensitive full-text search inside response texts: `total` becomes the exact count of matching responses and each item returns `snippet` + `match_count` instead of `response`/`response_truncated`.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AnswersApi,
+} from '@llmpulse/sdk';
+import type { ListAnswersRequest } from '@llmpulse/sdk';
+
+async function example() {
+  console.log("🚀 Testing @llmpulse/sdk SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: BearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new AnswersApi(config);
+
+  const body = {
+    // number | Project ID
+    projectId: 56,
+    // 'chatgpt' | 'perplexity' | 'ai_mode' | 'ai_overview' | 'gemini' | 'copilot' | 'amazon_rufus' | 'claude' | 'grok' | 'deepseek' | 'naver_ai' | 'baidu_ai' | 'meta_ai' | Filter by one AI model. It must be a model enabled for the API key\'s user: an unknown value, or a model the user has not enabled, returns 422 ERR_INVALID_PARAM with the valid values in the message. (optional)
+    model: model_example,
+    // string | One collection/tag ID or a comma-separated list of IDs. A query value is always a string on the wire, so it is typed as one: the previous integer-or-string union made generators emit a wrapper type they could not serialize. (optional)
+    collectionId: 12,34,
+    // string | One ISO country code or a comma-separated list (e.g. US,GB,DE) (optional)
+    countryCode: countryCode_example,
+    // string | One ISO language code or a comma-separated list (e.g. en,es,de) (optional)
+    languageCode: languageCode_example,
+    // number | Filter by prompt ID (optional)
+    prompt: 56,
+    // 'mentions_you' | 'not_mentions_you' | 'mentions_competitor' | 'not_mentions_competitor' | 'you_and_competitor' | 'competitor_not_you' | 'you_not_competitor' | 'no_brands' | Filter by which brands are mentioned, as a two-axis matrix (your brand x competitors): mentions_you / not_mentions_you, mentions_competitor / not_mentions_competitor, and the four combined cells you_and_competitor, competitor_not_you (a rival wins and you are absent), you_not_competitor, no_brands (no tracked brand appears, i.e. open space). Combine with \'competitors\' to narrow the competitor side to specific rivals; on a negative cell that reads \'none of these\'. On /dimensions/sources it applies to the crawled content of each cited page instead of the answer text. The legacy value \'competitors_only\' is still accepted as an alias of competitor_not_you. (optional)
+    mentionFilter: mentionFilter_example,
+    // 'cites_you' | 'not_cites_you' | 'cites_competitor' | 'not_cites_competitor' | 'you_and_competitor' | 'competitor_not_you' | 'you_not_competitor' | 'cites_no_brands' | Same two-axis matrix applied to the domains cited in the answer instead of the brands named in it. Independent of mention_filter; pass both to intersect them (e.g. mentions_you + not_cites_you finds answers that talk about you without linking to you). (optional)
+    citationFilter: citationFilter_example,
+    // string | Comma-separated competitor IDs (unknown IDs return ERR_INVALID_PARAM) (optional)
+    competitors: competitors_example,
+    // Date (optional)
+    from: 2013-10-20T19:20:30+01:00,
+    // Date | End of the window. A date-only value such as 2026-09-01 covers that whole day. Pass a full timestamp to end the window earlier. (optional)
+    to: 2013-10-20T19:20:30+01:00,
+    // number (optional)
+    page: 56,
+    // number (optional)
+    perPage: 56,
+    // string | Case-insensitive full-text search inside AI response texts. Switches items to snippet + match_count mode. (optional)
+    query: query_example,
+    // boolean | Filter sentinel non-answers (provider returned nothing after retries; excluded from platform metrics). false = only real answers, true = only sentinels, omit = both. Every item carries its own no_result flag. (optional)
+    noResult: true,
+  } satisfies ListAnswersRequest;
+
+  try {
+    const data = await api.listAnswers(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **projectId** | `number` | Project ID | [Defaults to `undefined`] |
+| **model** | `chatgpt`, `perplexity`, `ai_mode`, `ai_overview`, `gemini`, `copilot`, `amazon_rufus`, `claude`, `grok`, `deepseek`, `naver_ai`, `baidu_ai`, `meta_ai` | Filter by one AI model. It must be a model enabled for the API key\'s user: an unknown value, or a model the user has not enabled, returns 422 ERR_INVALID_PARAM with the valid values in the message. | [Optional] [Defaults to `undefined`] [Enum: chatgpt, perplexity, ai_mode, ai_overview, gemini, copilot, amazon_rufus, claude, grok, deepseek, naver_ai, baidu_ai, meta_ai] |
+| **collectionId** | `string` | One collection/tag ID or a comma-separated list of IDs. A query value is always a string on the wire, so it is typed as one: the previous integer-or-string union made generators emit a wrapper type they could not serialize. | [Optional] [Defaults to `undefined`] |
+| **countryCode** | `string` | One ISO country code or a comma-separated list (e.g. US,GB,DE) | [Optional] [Defaults to `undefined`] |
+| **languageCode** | `string` | One ISO language code or a comma-separated list (e.g. en,es,de) | [Optional] [Defaults to `undefined`] |
+| **prompt** | `number` | Filter by prompt ID | [Optional] [Defaults to `undefined`] |
+| **mentionFilter** | `mentions_you`, `not_mentions_you`, `mentions_competitor`, `not_mentions_competitor`, `you_and_competitor`, `competitor_not_you`, `you_not_competitor`, `no_brands` | Filter by which brands are mentioned, as a two-axis matrix (your brand x competitors): mentions_you / not_mentions_you, mentions_competitor / not_mentions_competitor, and the four combined cells you_and_competitor, competitor_not_you (a rival wins and you are absent), you_not_competitor, no_brands (no tracked brand appears, i.e. open space). Combine with \'competitors\' to narrow the competitor side to specific rivals; on a negative cell that reads \'none of these\'. On /dimensions/sources it applies to the crawled content of each cited page instead of the answer text. The legacy value \'competitors_only\' is still accepted as an alias of competitor_not_you. | [Optional] [Defaults to `undefined`] [Enum: mentions_you, not_mentions_you, mentions_competitor, not_mentions_competitor, you_and_competitor, competitor_not_you, you_not_competitor, no_brands] |
+| **citationFilter** | `cites_you`, `not_cites_you`, `cites_competitor`, `not_cites_competitor`, `you_and_competitor`, `competitor_not_you`, `you_not_competitor`, `cites_no_brands` | Same two-axis matrix applied to the domains cited in the answer instead of the brands named in it. Independent of mention_filter; pass both to intersect them (e.g. mentions_you + not_cites_you finds answers that talk about you without linking to you). | [Optional] [Defaults to `undefined`] [Enum: cites_you, not_cites_you, cites_competitor, not_cites_competitor, you_and_competitor, competitor_not_you, you_not_competitor, cites_no_brands] |
+| **competitors** | `string` | Comma-separated competitor IDs (unknown IDs return ERR_INVALID_PARAM) | [Optional] [Defaults to `undefined`] |
+| **from** | `Date` |  | [Optional] [Defaults to `undefined`] |
+| **to** | `Date` | End of the window. A date-only value such as 2026-09-01 covers that whole day. Pass a full timestamp to end the window earlier. | [Optional] [Defaults to `undefined`] |
+| **page** | `number` |  | [Optional] [Defaults to `1`] |
+| **perPage** | `number` |  | [Optional] [Defaults to `20`] |
+| **query** | `string` | Case-insensitive full-text search inside AI response texts. Switches items to snippet + match_count mode. | [Optional] [Defaults to `undefined`] |
+| **noResult** | `boolean` | Filter sentinel non-answers (provider returned nothing after retries; excluded from platform metrics). false = only real answers, true = only sentinels, omit = both. Every item carries its own no_result flag. | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+`void` (Empty response body)
+
+### Authorization
+
+[BearerAuth](../README.md#BearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Paginated answers. Every item carries app_url, the link that opens the answer in the app |  -  |
+| **422** | Invalid parameters |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+

package/docs/ApiError.md

@@ -0,0 +1,36 @@
+
+# ApiError
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`error` | [ApiErrorError](ApiErrorError.md)
+`requestId` | string
+
+## Example
+
+```typescript
+import type { ApiError } from '@llmpulse/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "error": null,
+  "requestId": null,
+} satisfies ApiError
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ApiError
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/ApiErrorError.md

@@ -0,0 +1,38 @@
+
+# ApiErrorError
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`code` | string
+`message` | string
+`meta` | object
+
+## Example
+
+```typescript
+import type { ApiErrorError } from '@llmpulse/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "code": null,
+  "message": null,
+  "meta": null,
+} satisfies ApiErrorError
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ApiErrorError
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/AssignPromptTagsRequest.md

@@ -0,0 +1,42 @@
+
+# AssignPromptTagsRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`projectId` | number
+`promptIds` | Array<number>
+`tagIds` | Array<number>
+`tagNames` | Array<string>
+`createMissing` | boolean
+
+## Example
+
+```typescript
+import type { AssignPromptTagsRequest } from '@llmpulse/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "projectId": null,
+  "promptIds": null,
+  "tagIds": null,
+  "tagNames": null,
+  "createMissing": null,
+} satisfies AssignPromptTagsRequest
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as AssignPromptTagsRequest
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/CatalogProduct.md

@@ -0,0 +1,48 @@
+
+# CatalogProduct
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`externalId` | string
+`title` | string
+`handle` | string
+`productType` | string
+`vendor` | string
+`tags` | Array<string>
+`collections` | Array<string>
+`url` | string
+
+## Example
+
+```typescript
+import type { CatalogProduct } from '@llmpulse/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "externalId": null,
+  "title": null,
+  "handle": null,
+  "productType": null,
+  "vendor": null,
+  "tags": null,
+  "collections": null,
+  "url": null,
+} satisfies CatalogProduct
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as CatalogProduct
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/CatalogPromptSuggestion.md

@@ -0,0 +1,52 @@
+
+# CatalogPromptSuggestion
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | number
+`prompt` | string
+`status` | string
+`source` | string
+`countryCode` | string
+`languageCode` | string
+`product` | [CatalogPromptSuggestionProduct](CatalogPromptSuggestionProduct.md)
+`promptId` | number
+`acceptedAt` | Date
+`createdAt` | Date
+
+## Example
+
+```typescript
+import type { CatalogPromptSuggestion } from '@llmpulse/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "prompt": null,
+  "status": null,
+  "source": null,
+  "countryCode": null,
+  "languageCode": null,
+  "product": null,
+  "promptId": null,
+  "acceptedAt": null,
+  "createdAt": null,
+} satisfies CatalogPromptSuggestion
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as CatalogPromptSuggestion
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/CatalogPromptSuggestionIdsRequest.md

@@ -0,0 +1,36 @@
+
+# CatalogPromptSuggestionIdsRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`projectId` | number
+`ids` | Array<number>
+
+## Example
+
+```typescript
+import type { CatalogPromptSuggestionIdsRequest } from '@llmpulse/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "projectId": null,
+  "ids": null,
+} satisfies CatalogPromptSuggestionIdsRequest
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as CatalogPromptSuggestionIdsRequest
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/CatalogPromptSuggestionProduct.md

@@ -0,0 +1,39 @@
+
+# CatalogPromptSuggestionProduct
+
+The catalog product the suggestion was written for
+
+## Properties
+
+Name | Type
+------------ | -------------
+`externalId` | string
+`handle` | string
+`title` | string
+
+## Example
+
+```typescript
+import type { CatalogPromptSuggestionProduct } from '@llmpulse/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "externalId": null,
+  "handle": null,
+  "title": null,
+} satisfies CatalogPromptSuggestionProduct
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as CatalogPromptSuggestionProduct
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/CatalogPromptSuggestionsAcceptResponse.md

@@ -0,0 +1,42 @@
+
+# CatalogPromptSuggestionsAcceptResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`projectId` | number
+`accepted` | [Array<CatalogPromptSuggestionsAcceptResponseAcceptedInner>](CatalogPromptSuggestionsAcceptResponseAcceptedInner.md)
+`skipped` | [Array<CatalogPromptSuggestionsAcceptResponseSkippedInner>](CatalogPromptSuggestionsAcceptResponseSkippedInner.md)
+`promptsAvailable` | number
+`requestId` | string
+
+## Example
+
+```typescript
+import type { CatalogPromptSuggestionsAcceptResponse } from '@llmpulse/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "projectId": null,
+  "accepted": null,
+  "skipped": null,
+  "promptsAvailable": null,
+  "requestId": null,
+} satisfies CatalogPromptSuggestionsAcceptResponse
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as CatalogPromptSuggestionsAcceptResponse
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+