@graph8/sdk 0.251.0 → 0.260.0

package/docs/api/campaigns.md

@@ -0,0 +1,1236 @@
+<!-- Generated by sdk/js/scripts/generate-agent-docs.ts from developer-contract/openapi.json. Regenerated on every build. -->
+
+# `g8.api.campaigns`: Campaigns
+
+29 operations (13 read, 5 write, 3 destructive, 8 billable).
+
+No hand-written client covers this area. Call it through `g8.api.campaigns.*` as shown below, or by operationId with `g8.api.call(operationId, input)`.
+
+Every example below assumes this setup (server-side, API key):
+
+```ts
+import { g8 } from "@graph8/sdk";
+
+g8.init({ apiKey: process.env.G8_API_KEY! });
+```
+
+Example values are placeholders that match each field's type. Only required fields are shown. Every example is type-checked against the SDK in CI.
+
+Exact TypeScript types for every operation on this page, and every schema they use: [campaigns.d.ts](campaigns.d.ts).
+
+## Operations
+
+| Call | HTTP | Tier | Scope | Summary |
+|---|---|---|---|---|
+| [`acceptAudiencePipelineFilters`](#op-acceptaudiencepipelinefilters) | `POST /api/v1/campaigns/{campaign_id}/audience-pipeline/accept-filters` | billable | `campaigns:run` | Accept Audience Pipeline Filters |
+| [`archiveCampaignIdea`](#op-archivecampaignidea) | `POST /api/v1/campaigns/ideas/{idea_id}/archive` | write | `campaigns:write` | Archive Campaign Idea |
+| [`createManualCampaignIdea`](#op-createmanualcampaignidea) | `POST /api/v1/campaigns/ideas/manual` | write | `campaigns:write` | Create Manual Campaign Idea |
+| [`deleteCampaign`](#op-deletecampaign) | `DELETE /api/v1/campaigns/{campaign_id}` | destructive | `campaigns:delete` | Delete Campaign |
+| [`deleteCampaignIdea`](#op-deletecampaignidea) | `DELETE /api/v1/campaigns/ideas/{idea_id}` | destructive | `campaigns:delete` | Delete Campaign Idea |
+| [`generateCampaignIdeas`](#op-generatecampaignideas) | `POST /api/v1/campaigns/generate-ideas` | billable | `campaigns:run` | Generate Campaign Ideas |
+| [`generateCampaignIdeasAsync`](#op-generatecampaignideasasync) | `POST /api/v1/campaigns/generate-ideas-async` | billable | `campaigns:run` | Generate Campaign Ideas Async |
+| [`generateCampaignStepContent`](#op-generatecampaignstepcontent) | `POST /api/v1/campaigns/{campaign_id}/sequence/steps/{step_id}/generate` | billable | `campaigns:run` | Generate Campaign Step Content |
+| [`getAudiencePipelineStatus`](#op-getaudiencepipelinestatus) | `GET /api/v1/campaigns/{campaign_id}/audience-pipeline/status` | read | `campaigns:read` | Get Audience Pipeline Status |
+| [`getAudiencePipelineSuggestedFilters`](#op-getaudiencepipelinesuggestedfilters) | `GET /api/v1/campaigns/{campaign_id}/audience-pipeline/suggested-filters` | read | `campaigns:read` | Get Audience Pipeline Suggested Filters |
+| [`getCampaignDashboard`](#op-getcampaigndashboard) | `GET /api/v1/campaigns/{campaign_id}/dashboard` | billable | `campaigns:run` | Get Campaign Dashboard |
+| [`getCampaignGeneratedFile`](#op-getcampaigngeneratedfile) | `GET /api/v1/campaigns/{campaign_id}/files/{file_type}` | read | `campaigns:read` | Get Campaign Generated File |
+| [`getCampaignGenerationOptions`](#op-getcampaigngenerationoptions) | `GET /api/v1/campaigns/generation-options` | read | `campaigns:read` | Get Campaign Generation Options |
+| [`getCampaignGenerationStatus`](#op-getcampaigngenerationstatus) | `GET /api/v1/campaigns/{campaign_id}/status` | read | `campaigns:read` | Get Campaign Generation Status |
+| [`getCampaignIdeasTaskStatus`](#op-getcampaignideastaskstatus) | `GET /api/v1/campaigns/ideas/status/{task_id}` | read | `campaigns:read` | Get Campaign Ideas Task Status |
+| [`linkLandingPageToCampaign`](#op-linklandingpagetocampaign) | `POST /api/v1/campaigns/{campaign_id}/landing-pages` | write | `campaigns:write` | Link Landing Page To Campaign |
+| [`listCampaignAudienceListOptions`](#op-listcampaignaudiencelistoptions) | `GET /api/v1/campaigns/audience-lists/options` | read | `campaigns:read` | List Campaign Audience List Options |
+| [`listCampaignGeneratedFiles`](#op-listcampaigngeneratedfiles) | `GET /api/v1/campaigns/{campaign_id}/files` | read | `campaigns:read` | List Campaign Generated Files |
+| [`listCampaignLandingPages`](#op-listcampaignlandingpages) | `GET /api/v1/campaigns/{campaign_id}/landing-pages` | read | `campaigns:read` | List Campaign Landing Pages |
+| [`listCampaignsForPicker`](#op-listcampaignsforpicker) | `GET /api/v1/campaigns/picker` | read | `campaigns:read` | List Campaigns For Picker |
+| [`previewCampaignAudienceProfile`](#op-previewcampaignaudienceprofile) | `POST /api/v1/campaigns/audience-profile/preview` | read | `campaigns:read` | Preview Campaign Audience Profile |
+| [`previewCampaignDocumentManifest`](#op-previewcampaigndocumentmanifest) | `POST /api/v1/campaigns/document-manifest/preview` | read | `campaigns:read` | Preview Campaign Document Manifest |
+| [`recommendCampaignPersonas`](#op-recommendcampaignpersonas) | `POST /api/v1/campaigns/recommend-personas` | billable | `campaigns:run` | Recommend Campaign Personas |
+| [`regenerateCampaignDocument`](#op-regeneratecampaigndocument) | `POST /api/v1/campaigns/{campaign_id}/documents/{document_id}/regenerate` | billable | `campaigns:run` | Regenerate Campaign Document |
+| [`suggestCampaignConcepts`](#op-suggestcampaignconcepts) | `POST /api/v1/campaigns/suggest` | read | `campaigns:read` | Suggest Campaign Concepts |
+| [`toggleCampaignIdeaFavorite`](#op-togglecampaignideafavorite) | `POST /api/v1/campaigns/ideas/{idea_id}/favorite` | write | `campaigns:write` | Toggle Campaign Idea Favorite |
+| [`triggerAudiencePipeline`](#op-triggeraudiencepipeline) | `POST /api/v1/campaigns/{campaign_id}/audience-pipeline/trigger` | billable | `campaigns:run` | Trigger Audience Pipeline |
+| [`unlinkLandingPageFromCampaign`](#op-unlinklandingpagefromcampaign) | `DELETE /api/v1/campaigns/{campaign_id}/landing-pages/{landing_page_id}` | destructive | `campaigns:delete` | Unlink Landing Page From Campaign |
+| [`updateCampaignIdea`](#op-updatecampaignidea) | `PATCH /api/v1/campaigns/ideas/{idea_id}` | write | `campaigns:write` | Update Campaign Idea |
+
+---
+
+<a id="op-acceptaudiencepipelinefilters"></a>
+
+### `g8.api.campaigns.acceptAudiencePipelineFilters(input)`
+
+**Accept Audience Pipeline Filters**
+
+- HTTP: `POST /api/v1/campaigns/{campaign_id}/audience-pipeline/accept-filters`
+- operationId: `accept_audience_pipeline_filters_campaigns__campaign_id__audience_pipeline_accept_filters_post` (also callable as `g8.api.call("accept_audience_pipeline_filters_campaigns__campaign_id__audience_pipeline_accept_filters_post", input)`)
+- Tier: `billable`: spends credits; the SDK never blindly retries it; confirm cost before bulk use
+- API-key scope: `campaigns:run`
+
+SPENDS CREDITS when `run_pipeline` is true, which is the DEFAULT.
+
+Saves the (possibly edited) filters as the campaign's own, then starts the
+pipeline: it builds the list, provisions intent keywords and starts a bulk
+enrichment that spends credits per contact. Send `run_pipeline: false` to
+only save the filters; the answer is then `filters_saved` with no
+`chain_id`. `list_name` overrides the default "{campaign name} Audience".
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.campaign_id` | `string` | yes | Campaign id or slug; resolved inside the key's organisation. |
+| `body` | `AudiencePipelineAcceptFiltersRequest` | yes | Request body; fields below. |
+
+Body fields (`AudiencePipelineAcceptFiltersRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.filters` | `Array<Record<string, unknown>>` | yes |  |
+| `body.list_name` | `string \| null` | no | Custom list name (defaults to '{campaign_name} Audience') |
+| `body.run_pipeline` | `boolean` | no | default `true` |
+
+**Returns** `ApiResponse_AudiencePipelineAcceptResult_`: the envelope `{ data: AudiencePipelineAcceptResult, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`AudiencePipelineAcceptResult` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `campaign_id` | `string` | yes |  |
+| `status` | `string` | yes |  |
+| `chain_id` | `string \| null` | no |  |
+
+**Example**
+
+```ts
+// billable: spends credits; the SDK never blindly retries it; confirm cost before bulk use.
+const result = await g8.api.campaigns.acceptAudiencePipelineFilters({ path: { campaign_id: "id" }, body: { filters: [{}] } });
+```
+
+---
+
+<a id="op-archivecampaignidea"></a>
+
+### `g8.api.campaigns.archiveCampaignIdea(input)`
+
+**Archive Campaign Idea**
+
+- HTTP: `POST /api/v1/campaigns/ideas/{idea_id}/archive`
+- operationId: `archive_campaign_idea_campaigns_ideas__idea_id__archive_post` (also callable as `g8.api.call("archive_campaign_idea_campaigns_ideas__idea_id__archive_post", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `campaigns:write`
+
+Archive an idea. FREE.
+
+Archived ideas are not deleted: future idea generation reads them - and
+the `reason` - to steer away from similar concepts.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.idea_id` | `string` | yes | Campaign idea id. |
+| `query.reason` | `string \| null` | no | Why it was archived. |
+
+**Returns** `ApiResponse_StudioContentPayload_`: the envelope `{ data: StudioContentPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.campaigns.archiveCampaignIdea({ path: { idea_id: "id" } });
+```
+
+---
+
+<a id="op-createmanualcampaignidea"></a>
+
+### `g8.api.campaigns.createManualCampaignIdea(input)`
+
+**Create Manual Campaign Idea**
+
+- HTTP: `POST /api/v1/campaigns/ideas/manual`
+- operationId: `create_manual_campaign_idea_campaigns_ideas_manual_post` (also callable as `g8.api.call("create_manual_campaign_idea_campaigns_ideas_manual_post", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `campaigns:write`
+
+Add an idea by hand, with no generation. FREE.
+
+The zero-cost way into the idea pool: everything `/generate-ideas` produces
+can also be written directly here.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body` | `Record<string, unknown>` | yes | Request body; fields below. |
+
+**Returns** `ApiResponse_StudioContentPayload_`: the envelope `{ data: StudioContentPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.campaigns.createManualCampaignIdea({ body: {} });
+```
+
+---
+
+<a id="op-deletecampaign"></a>
+
+### `g8.api.campaigns.deleteCampaign(input)`
+
+**Delete Campaign**
+
+- HTTP: `DELETE /api/v1/campaigns/{campaign_id}`
+- operationId: `delete_campaign_campaigns__campaign_id__delete` (also callable as `g8.api.call("delete_campaign_campaigns__campaign_id__delete", input)`)
+- Tier: `destructive`: deletes or archives data; confirm with a human before calling
+- API-key scope: `campaigns:delete`
+
+SOFT-delete a campaign. It stops appearing; its rows are not dropped.
+
+The contract could create, read, patch and LAUNCH a campaign and never
+remove one. `campaigns:delete` plus the per-record ownership scope, both
+the app's own gates.
+
+Spends nothing.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.campaign_id` | `string` | yes | Campaign id or slug. |
+
+**Returns** `ApiResponse_StudioContentPayload_`: the envelope `{ data: StudioContentPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+// destructive: deletes or archives data; confirm with a human before calling.
+const result = await g8.api.campaigns.deleteCampaign({ path: { campaign_id: "id" } });
+```
+
+---
+
+<a id="op-deletecampaignidea"></a>
+
+### `g8.api.campaigns.deleteCampaignIdea(input)`
+
+**Delete Campaign Idea**
+
+- HTTP: `DELETE /api/v1/campaigns/ideas/{idea_id}`
+- operationId: `delete_campaign_idea_campaigns_ideas__idea_id__delete` (also callable as `g8.api.call("delete_campaign_idea_campaigns_ideas__idea_id__delete", input)`)
+- Tier: `destructive`: deletes or archives data; confirm with a human before calling
+- API-key scope: `campaigns:delete`
+
+PERMANENTLY delete an idea. Archiving is the reversible alternative.
+
+Two gates, matching the app: the per-record ownership scope AND
+`campaigns:delete`. Both are re-declared here because neither runs on a
+direct call - the first is a decorator dependency, the second a signature
+one.
+
+Spends nothing.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.idea_id` | `string` | yes | Campaign idea id. |
+
+**Returns** `ApiResponse_StudioContentPayload_`: the envelope `{ data: StudioContentPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+// destructive: deletes or archives data; confirm with a human before calling.
+const result = await g8.api.campaigns.deleteCampaignIdea({ path: { idea_id: "id" } });
+```
+
+---
+
+<a id="op-generatecampaignideas"></a>
+
+### `g8.api.campaigns.generateCampaignIdeas(input)`
+
+**Generate Campaign Ideas**
+
+- HTTP: `POST /api/v1/campaigns/generate-ideas`
+- operationId: `generate_campaign_ideas_campaigns_generate_ideas_post` (also callable as `g8.api.call("generate_campaign_ideas_campaigns_generate_ideas_post", input)`)
+- Tier: `billable`: spends credits; the SDK never blindly retries it; confirm cost before bulk use
+- API-key scope: `campaigns:run`
+
+Generate campaign ideas. SPENDS CREDIT, scaled by `num_ideas`.
+
+SYNCHRONOUS: the generation runs during this call, so a large `num_ideas`
+is a long request. Use `/generate-ideas-async` for anything big.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body` | `SuggestCampaignsRequest` | yes | Request body; fields below. |
+| `query.num_ideas` | `integer` | no | How many ideas. Scales the spend. default `5` |
+| `query.user_direction` | `string \| null` | no | Free-text steer for the generator. |
+
+Body fields (`SuggestCampaignsRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.campaign_goal` | `string` | yes |  |
+| `body.website_url` | `string` | yes |  |
+| `body.campaign_type` | `string \| null` | no | default `"all"` |
+| `body.organization_id` | `string \| null` | no | Ignored. The organisation is the API key's own. |
+| `body.target_persona` | `string \| null` | no |  |
+
+**Returns** `ApiResponse_StudioContentListPayload_`: the envelope `{ data: StudioContentListPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`StudioContentListPayload` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `items` | `Array<unknown>` | no |  |
+
+**Example**
+
+```ts
+// billable: spends credits; the SDK never blindly retries it; confirm cost before bulk use.
+const result = await g8.api.campaigns.generateCampaignIdeas({
+  body: { campaign_goal: "example", website_url: "https://example.com" },
+});
+```
+
+---
+
+<a id="op-generatecampaignideasasync"></a>
+
+### `g8.api.campaigns.generateCampaignIdeasAsync(input)`
+
+**Generate Campaign Ideas Async**
+
+- HTTP: `POST /api/v1/campaigns/generate-ideas-async`
+- operationId: `generate_campaign_ideas_async_campaigns_generate_ideas_async_post` (also callable as `g8.api.call("generate_campaign_ideas_async_campaigns_generate_ideas_async_post", input)`)
+- Tier: `billable`: spends credits; the SDK never blindly retries it; confirm cost before bulk use
+- API-key scope: `campaigns:run`
+
+The same generation, dispatched to the background. SPENDS CREDIT.
+
+Returns a task id immediately. The spend is committed by this call even
+though the ideas are not here yet - cancelling the poll does not cancel
+the run.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body` | `AsyncGenerateIdeasRequest` | yes | Request body; fields below. |
+
+Body fields (`AsyncGenerateIdeasRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.campaign_goal` | `string` | yes |  |
+| `body.organization_id` | `string` | yes | Ignored for tenancy. The organisation is the API key's own. |
+| `body.website_url` | `string` | yes |  |
+| `body.audience_list_id` | `integer \| null` | no |  |
+| `body.audience_source` | `string \| null` | no | default `"build_new"` |
+| `body.campaign_type` | `string \| null` | no | default `"all"` |
+| `body.execution_targets` | `Array<string> \| null` | no |  |
+| `body.num_ideas` | `integer \| null` | no | How many ideas to generate. Scales the spend. default `5` |
+| `body.persona_mode` | `string \| null` | no | default `"selected"` |
+| `body.preferred_channels` | `Array<string> \| null` | no |  |
+| `body.target_personas` | `Array<string> \| null` | no |  |
+| `body.user_direction` | `string \| null` | no |  |
+
+**Returns** `ApiResponse_StudioContentPayload_`: the envelope `{ data: StudioContentPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+// billable: spends credits; the SDK never blindly retries it; confirm cost before bulk use.
+const result = await g8.api.campaigns.generateCampaignIdeasAsync({
+  body: {
+    campaign_goal: "example",
+    organization_id: "id",
+    website_url: "https://example.com",
+  },
+});
+```
+
+---
+
+<a id="op-generatecampaignstepcontent"></a>
+
+### `g8.api.campaigns.generateCampaignStepContent(input)`
+
+**Generate Campaign Step Content**
+
+- HTTP: `POST /api/v1/campaigns/{campaign_id}/sequence/steps/{step_id}/generate`
+- operationId: `generate_campaign_step_content_campaigns__campaign_id__sequence_steps__step_id__generate_post` (also callable as `g8.api.call("generate_campaign_step_content_campaigns__campaign_id__sequence_steps__step_id__generate_post", input)`)
+- Tier: `billable`: spends credits; the SDK never blindly retries it; confirm cost before bulk use
+- API-key scope: `campaigns:run`
+
+Write the content for ONE sequence step with AI, replacing its placeholder. SPENDS CREDIT.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.campaign_id` | `string` | yes | Campaign id or slug. |
+| `path.step_id` | `string` | yes | Sequence step id, from `GET /campaigns/{campaign_id}/sequence`. |
+
+**Returns** `ApiResponse_StudioContentPayload_`: the envelope `{ data: StudioContentPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+// billable: spends credits; the SDK never blindly retries it; confirm cost before bulk use.
+const result = await g8.api.campaigns.generateCampaignStepContent({ path: { campaign_id: "id", step_id: "id" } });
+```
+
+---
+
+<a id="op-getaudiencepipelinestatus"></a>
+
+### `g8.api.campaigns.getAudiencePipelineStatus(input)`
+
+**Get Audience Pipeline Status**
+
+- HTTP: `GET /api/v1/campaigns/{campaign_id}/audience-pipeline/status`
+- operationId: `get_audience_pipeline_status_campaigns__campaign_id__audience_pipeline_status_get` (also callable as `g8.api.call("get_audience_pipeline_status_campaigns__campaign_id__audience_pipeline_status_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `campaigns:read`
+
+SPENDS NOTHING. Where the campaign's audience pipeline is, and what it has
+produced: the list it built, how many contacts, the enrichment job, the
+keywords it provisioned, and the error if it failed.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.campaign_id` | `string` | yes | Campaign id or slug; resolved inside the key's organisation. |
+
+**Returns** `ApiResponse_AudiencePipelineStatus_`: the envelope `{ data: AudiencePipelineStatus, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`AudiencePipelineStatus` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `completed_at` | `string (date-time) \| null` | no |  |
+| `enrichment_job_id` | `string \| null` | no |  |
+| `error` | `string \| null` | no |  |
+| `keyword_ids` | `Array<string> \| null` | no |  |
+| `list_id` | `string \| null` | no |  |
+| `pipeline_status` | `string` | no | Pipeline state: idle \| suggested \| extracting_filters \| creating_list \| provisioning_keywords \| checking_enrichment \| enriching \| completed \| failed default `"idle"` |
+| `started_at` | `string (date-time) \| null` | no |  |
+| `suggested_filters` | `Array<Record<string, unknown>> \| null` | no |  |
+| `suggested_list_name` | `string \| null` | no | Pre-filled list name based on campaign name |
+| `total_contacts` | `integer` | no | default `0` |
+
+**Example**
+
+```ts
+const result = await g8.api.campaigns.getAudiencePipelineStatus({ path: { campaign_id: "id" } });
+```
+
+---
+
+<a id="op-getaudiencepipelinesuggestedfilters"></a>
+
+### `g8.api.campaigns.getAudiencePipelineSuggestedFilters(input)`
+
+**Get Audience Pipeline Suggested Filters**
+
+- HTTP: `GET /api/v1/campaigns/{campaign_id}/audience-pipeline/suggested-filters`
+- operationId: `get_audience_pipeline_suggested_filters_campaigns__campaign_id__audience_pipeline_suggested_filters_get` (also callable as `g8.api.call("get_audience_pipeline_suggested_filters_campaigns__campaign_id__audience_pipeline_suggested_filters_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `campaigns:read`
+
+SPENDS NOTHING. The targeting filters the pipeline would build the list from.
+
+`source` says whether they are filters someone accepted or edited
+(`user_modified`) or a fresh extraction from the targeting document
+(`targeting_doc`). 422 when the campaign has no targeting document or it
+yields no filters; generate campaign content first.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.campaign_id` | `string` | yes | Campaign id or slug; resolved inside the key's organisation. |
+
+**Returns** `ApiResponse_AudiencePipelineSuggestedFilters_`: the envelope `{ data: AudiencePipelineSuggestedFilters, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`AudiencePipelineSuggestedFilters` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `filters` | `Array<Record<string, unknown>>` | yes |  |
+| `source` | `string` | yes | Where filters came from: user_modified \| targeting_doc |
+| `suggested_list_name` | `string \| null` | no | Pre-filled list name based on campaign name |
+
+**Example**
+
+```ts
+const result = await g8.api.campaigns.getAudiencePipelineSuggestedFilters({ path: { campaign_id: "id" } });
+```
+
+---
+
+<a id="op-getcampaigndashboard"></a>
+
+### `g8.api.campaigns.getCampaignDashboard(input)`
+
+**Get Campaign Dashboard**
+
+- HTTP: `GET /api/v1/campaigns/{campaign_id}/dashboard`
+- operationId: `get_campaign_dashboard_campaigns__campaign_id__dashboard_get` (also callable as `g8.api.call("get_campaign_dashboard_campaigns__campaign_id__dashboard_get", input)`)
+- Tier: `billable`: spends credits; the SDK never blindly retries it; confirm cost before bulk use
+- API-key scope: `campaigns:run`
+
+The AI campaign dashboard. A GET THAT CAN SPEND CREDIT.
+
+On a cache hit it is free and instant. On a MISS - or when the cached copy
+is stale and the campaign's documents have changed - it dispatches a
+background job that generates the assessment with a model, and returns
+`is_generating: true`. So the first call for a campaign costs money even
+though it is a GET.
+
+That is why it is tiered `billable` rather than `read`: the heuristic's
+`ACTIVE_GET_MARKERS` exist for exactly this shape and none of them matches
+`/dashboard`. Poll every few seconds while `is_generating` is true;
+polling does not re-dispatch.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.campaign_id` | `string` | yes | Campaign id or slug. |
+
+**Returns** `ApiResponse_StudioContentPayload_`: the envelope `{ data: StudioContentPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+// billable: spends credits; the SDK never blindly retries it; confirm cost before bulk use.
+const result = await g8.api.campaigns.getCampaignDashboard({ path: { campaign_id: "id" } });
+```
+
+---
+
+<a id="op-getcampaigngeneratedfile"></a>
+
+### `g8.api.campaigns.getCampaignGeneratedFile(input)`
+
+**Get Campaign Generated File**
+
+- HTTP: `GET /api/v1/campaigns/{campaign_id}/files/{file_type}`
+- operationId: `get_campaign_generated_file_campaigns__campaign_id__files__file_type__get` (also callable as `g8.api.call("get_campaign_generated_file_campaigns__campaign_id__files__file_type__get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `campaigns:read`
+
+One generated file's content. FREE.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.campaign_id` | `string` | yes | Campaign id or slug. |
+| `path.file_type` | `string` | yes | A file type from `GET /campaigns/{campaign_id}/files`. |
+
+**Returns** `ApiResponse_StudioContentPayload_`: the envelope `{ data: StudioContentPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.campaigns.getCampaignGeneratedFile({ path: { campaign_id: "id", file_type: "example" } });
+```
+
+---
+
+<a id="op-getcampaigngenerationoptions"></a>
+
+### `g8.api.campaigns.getCampaignGenerationOptions(input?)`
+
+**Get Campaign Generation Options**
+
+- HTTP: `GET /api/v1/campaigns/generation-options`
+- operationId: `get_campaign_generation_options_campaigns_generation_options_get` (also callable as `g8.api.call("get_campaign_generation_options_campaigns_generation_options_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `campaigns:read`
+
+The supported generation contract: goals, channels, execution targets. FREE.
+
+The SOURCE of the vocabularies `/generate-ideas` and `/generate-ideas-async`
+accept. Read it before generating, because an unrecognised channel is
+silently ignored rather than rejected.
+
+**Input**: none.
+
+**Returns** `ApiResponse_StudioContentPayload_`: the envelope `{ data: StudioContentPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.campaigns.getCampaignGenerationOptions();
+```
+
+---
+
+<a id="op-getcampaigngenerationstatus"></a>
+
+### `g8.api.campaigns.getCampaignGenerationStatus(input)`
+
+**Get Campaign Generation Status**
+
+- HTTP: `GET /api/v1/campaigns/{campaign_id}/status`
+- operationId: `get_campaign_generation_status_campaigns__campaign_id__status_get` (also callable as `g8.api.call("get_campaign_generation_status_campaigns__campaign_id__status_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `campaigns:read`
+
+Whether the campaign's documents have finished generating. FREE.
+
+The poll target after creating a campaign: generation runs in the
+background and this reports its progress.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.campaign_id` | `string` | yes | Campaign id or slug. |
+
+**Returns** `ApiResponse_StudioContentPayload_`: the envelope `{ data: StudioContentPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.campaigns.getCampaignGenerationStatus({ path: { campaign_id: "id" } });
+```
+
+---
+
+<a id="op-getcampaignideastaskstatus"></a>
+
+### `g8.api.campaigns.getCampaignIdeasTaskStatus(input)`
+
+**Get Campaign Ideas Task Status**
+
+- HTTP: `GET /api/v1/campaigns/ideas/status/{task_id}`
+- operationId: `get_campaign_ideas_task_status_campaigns_ideas_status__task_id__get` (also callable as `g8.api.call("get_campaign_ideas_task_status_campaigns_ideas_status__task_id__get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `campaigns:read`
+
+Progress of a background idea-generation run. FREE - the poll target.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.task_id` | `string` | yes | Task id returned by `POST /campaigns/generate-ideas-async`. |
+
+**Returns** `ApiResponse_StudioContentPayload_`: the envelope `{ data: StudioContentPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.campaigns.getCampaignIdeasTaskStatus({ path: { task_id: "id" } });
+```
+
+---
+
+<a id="op-linklandingpagetocampaign"></a>
+
+### `g8.api.campaigns.linkLandingPageToCampaign(input)`
+
+**Link Landing Page To Campaign**
+
+- HTTP: `POST /api/v1/campaigns/{campaign_id}/landing-pages`
+- operationId: `link_landing_page_to_campaign_campaigns__campaign_id__landing_pages_post` (also callable as `g8.api.call("link_landing_page_to_campaign_campaigns__campaign_id__landing_pages_post", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `campaigns:write`
+
+Attach an existing landing page to this campaign. FREE.
+
+A link, not a copy: the page is unchanged and can be linked to more than
+one campaign. Create the page with `POST /landing-pages` first.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.campaign_id` | `string` | yes | Campaign id or slug. |
+| `body` | `LinkLandingPageRequest` | yes | Request body; fields below. |
+
+Body fields (`LinkLandingPageRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.landing_page_id` | `string` | yes |  |
+
+**Returns** `ApiResponse_StudioContentPayload_`: the envelope `{ data: StudioContentPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.campaigns.linkLandingPageToCampaign({ path: { campaign_id: "id" }, body: { landing_page_id: "id" } });
+```
+
+---
+
+<a id="op-listcampaignaudiencelistoptions"></a>
+
+### `g8.api.campaigns.listCampaignAudienceListOptions(input?)`
+
+**List Campaign Audience List Options**
+
+- HTTP: `GET /api/v1/campaigns/audience-lists/options`
+- operationId: `list_campaign_audience_list_options_campaigns_audience_lists_options_get` (also callable as `g8.api.call("list_campaign_audience_list_options_campaigns_audience_lists_options_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `campaigns:read`
+
+Contact lists a campaign can be built on. FREE.
+
+Scoped to what the CREDENTIAL can see: a key narrowed away from lists gets
+the lists it is entitled to, not all of them.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `query.search` | `string \| null` | no | Substring match on the list name. |
+
+**Returns** `ApiResponse_StudioContentListPayload_`: the envelope `{ data: StudioContentListPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`StudioContentListPayload` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `items` | `Array<unknown>` | no |  |
+
+**Example**
+
+```ts
+const result = await g8.api.campaigns.listCampaignAudienceListOptions();
+```
+
+---
+
+<a id="op-listcampaigngeneratedfiles"></a>
+
+### `g8.api.campaigns.listCampaignGeneratedFiles(input)`
+
+**List Campaign Generated Files**
+
+- HTTP: `GET /api/v1/campaigns/{campaign_id}/files`
+- operationId: `list_campaign_generated_files_campaigns__campaign_id__files_get` (also callable as `g8.api.call("list_campaign_generated_files_campaigns__campaign_id__files_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `campaigns:read`
+
+The generated files of a campaign, by type. FREE.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.campaign_id` | `string` | yes | Campaign id or slug. |
+
+**Returns** `ApiResponse_StudioContentListPayload_`: the envelope `{ data: StudioContentListPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`StudioContentListPayload` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `items` | `Array<unknown>` | no |  |
+
+**Example**
+
+```ts
+const result = await g8.api.campaigns.listCampaignGeneratedFiles({ path: { campaign_id: "id" } });
+```
+
+---
+
+<a id="op-listcampaignlandingpages"></a>
+
+### `g8.api.campaigns.listCampaignLandingPages(input)`
+
+**List Campaign Landing Pages**
+
+- HTTP: `GET /api/v1/campaigns/{campaign_id}/landing-pages`
+- operationId: `list_campaign_landing_pages_campaigns__campaign_id__landing_pages_get` (also callable as `g8.api.call("list_campaign_landing_pages_campaigns__campaign_id__landing_pages_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `campaigns:read`
+
+The landing pages this campaign runs on. FREE.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.campaign_id` | `string` | yes | Campaign id or slug. |
+
+**Returns** `ApiResponse_StudioContentListPayload_`: the envelope `{ data: StudioContentListPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`StudioContentListPayload` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `items` | `Array<unknown>` | no |  |
+
+**Example**
+
+```ts
+const result = await g8.api.campaigns.listCampaignLandingPages({ path: { campaign_id: "id" } });
+```
+
+---
+
+<a id="op-listcampaignsforpicker"></a>
+
+### `g8.api.campaigns.listCampaignsForPicker(input?)`
+
+**List Campaigns For Picker**
+
+- HTTP: `GET /api/v1/campaigns/picker`
+- operationId: `list_campaigns_for_picker_campaigns_picker_get` (also callable as `g8.api.call("list_campaigns_for_picker_campaigns_picker_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `campaigns:read`
+
+Every campaign in the org, id and name only. FREE.
+
+UNSCOPED BY DESIGN, and that is worth knowing: it deliberately ignores the
+own/team/all campaign scope so a picker can offer every campaign a call
+could be logged against. It returns identifiers, not campaign content - use
+`GET /campaigns` for the scoped, full list.
+
+**Input**: none.
+
+**Returns** `ApiResponse_StudioContentListPayload_`: the envelope `{ data: StudioContentListPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`StudioContentListPayload` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `items` | `Array<unknown>` | no |  |
+
+**Example**
+
+```ts
+const result = await g8.api.campaigns.listCampaignsForPicker();
+```
+
+---
+
+<a id="op-previewcampaignaudienceprofile"></a>
+
+### `g8.api.campaigns.previewCampaignAudienceProfile(input)`
+
+**Preview Campaign Audience Profile**
+
+- HTTP: `POST /api/v1/campaigns/audience-profile/preview`
+- operationId: `preview_campaign_audience_profile_campaigns_audience_profile_preview_post` (also callable as `g8.api.call("preview_campaign_audience_profile_campaigns_audience_profile_preview_post", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `campaigns:read`
+
+Profile an audience list before building a campaign on it. FREE.
+
+Aggregates the list's titles, seniority and industries so the campaign
+can be aimed at who is actually on it. Nothing is created.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body` | `AudienceProfilePreviewRequest` | yes | Request body; fields below. |
+
+Body fields (`AudienceProfilePreviewRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.audience_id` | `integer` | yes |  |
+
+**Returns** `ApiResponse_StudioContentPayload_`: the envelope `{ data: StudioContentPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.campaigns.previewCampaignAudienceProfile({ body: { audience_id: 123 } });
+```
+
+---
+
+<a id="op-previewcampaigndocumentmanifest"></a>
+
+### `g8.api.campaigns.previewCampaignDocumentManifest(input)`
+
+**Preview Campaign Document Manifest**
+
+- HTTP: `POST /api/v1/campaigns/document-manifest/preview`
+- operationId: `preview_campaign_document_manifest_campaigns_document_manifest_preview_post` (also callable as `g8.api.call("preview_campaign_document_manifest_campaigns_document_manifest_preview_post", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `campaigns:read`
+
+Which documents a campaign with these channels would generate. FREE.
+
+A dry run of the generation contract: nothing is created and no model
+runs. The same answer `POST /campaigns` acts on.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body` | `CampaignDocumentManifestRequest` | yes | Request body; fields below. |
+
+Body fields (`CampaignDocumentManifestRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.channels` | `Array<string>` | yes |  |
+| `body.audience_source` | `string \| null` | no |  |
+| `body.campaign_focus` | `string \| null` | no | default `"outbound"` |
+| `body.execution_targets` | `Array<string> \| null` | no |  |
+
+**Returns** `ApiResponse_StudioContentPayload_`: the envelope `{ data: StudioContentPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.campaigns.previewCampaignDocumentManifest({ body: { channels: ["example"] } });
+```
+
+---
+
+<a id="op-recommendcampaignpersonas"></a>
+
+### `g8.api.campaigns.recommendCampaignPersonas(input)`
+
+**Recommend Campaign Personas**
+
+- HTTP: `POST /api/v1/campaigns/recommend-personas`
+- operationId: `recommend_campaign_personas_campaigns_recommend_personas_post` (also callable as `g8.api.call("recommend_campaign_personas_campaigns_recommend_personas_post", input)`)
+- Tier: `billable`: spends credits; the SDK never blindly retries it; confirm cost before bulk use
+- API-key scope: `campaigns:run`
+
+Recommend target personas and a strategy. SPENDS CREDIT.
+
+An LLM pass over the company's own data. Its path carries no marker, so
+the tier heuristic called it an ordinary write; it is corrected with an
+explicit rule.
+
+`organization_id` in the body is IGNORED - the organisation is always the
+API key's own. It is accepted because the app's model carries it, and
+rejecting a field Studio itself sends would be a gratuitous 422.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body` | `PersonaRecommendationRequest` | yes | Request body; fields below. |
+
+Body fields (`PersonaRecommendationRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.website_url` | `string` | yes |  |
+| `body.organization_id` | `string \| null` | no | Ignored. The organisation is the API key's own. |
+
+**Returns** `ApiResponse_StudioContentPayload_`: the envelope `{ data: StudioContentPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+// billable: spends credits; the SDK never blindly retries it; confirm cost before bulk use.
+const result = await g8.api.campaigns.recommendCampaignPersonas({ body: { website_url: "https://example.com" } });
+```
+
+---
+
+<a id="op-regeneratecampaigndocument"></a>
+
+### `g8.api.campaigns.regenerateCampaignDocument(input)`
+
+**Regenerate Campaign Document**
+
+- HTTP: `POST /api/v1/campaigns/{campaign_id}/documents/{document_id}/regenerate`
+- operationId: `regenerate_campaign_document_campaigns__campaign_id__documents__document_id__regenerate_post` (also callable as `g8.api.call("regenerate_campaign_document_campaigns__campaign_id__documents__document_id__regenerate_post", input)`)
+- Tier: `billable`: spends credits; the SDK never blindly retries it; confirm cost before bulk use
+- API-key scope: `campaigns:run`
+
+Rewrite ONE campaign document with AI. SPENDS CREDIT.
+
+The document is marked `generating` and a background job rewrites it from
+the campaign's current context; poll `GET /campaigns/{campaign_id}/documents/{document_id}`.
+The current content is replaced.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.campaign_id` | `string` | yes | Campaign id or slug. |
+| `path.document_id` | `string` | yes | Campaign document id. |
+
+**Returns** `ApiResponse_StudioContentPayload_`: the envelope `{ data: StudioContentPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+// billable: spends credits; the SDK never blindly retries it; confirm cost before bulk use.
+const result = await g8.api.campaigns.regenerateCampaignDocument({ path: { campaign_id: "id", document_id: "id" } });
+```
+
+---
+
+<a id="op-suggestcampaignconcepts"></a>
+
+### `g8.api.campaigns.suggestCampaignConcepts(input)`
+
+**Suggest Campaign Concepts**
+
+- HTTP: `POST /api/v1/campaigns/suggest`
+- operationId: `suggest_campaign_concepts_campaigns_suggest_post` (also callable as `g8.api.call("suggest_campaign_concepts_campaigns_suggest_post", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `campaigns:read`
+
+Rank the top 15 campaign CONCEPTS from the playbook library for a goal.
+
+Semantic search over the concept library plus rule-based scoring (fit,
+asset readiness, goal, channel feasibility). No generative model runs and
+nothing is created - `POST /campaigns/generate-ideas` is the generative,
+credit-spending counterpart. `organization_id` in the body is ignored.
+
+Spends nothing.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body` | `SuggestCampaignsRequest` | yes | Request body; fields below. |
+
+Body fields (`SuggestCampaignsRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.campaign_goal` | `string` | yes |  |
+| `body.website_url` | `string` | yes |  |
+| `body.campaign_type` | `string \| null` | no | default `"all"` |
+| `body.organization_id` | `string \| null` | no | Ignored. The organisation is the API key's own. |
+| `body.target_persona` | `string \| null` | no |  |
+
+**Returns** `ApiResponse_StudioContentPayload_`: the envelope `{ data: StudioContentPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.campaigns.suggestCampaignConcepts({
+  body: { campaign_goal: "example", website_url: "https://example.com" },
+});
+```
+
+---
+
+<a id="op-togglecampaignideafavorite"></a>
+
+### `g8.api.campaigns.toggleCampaignIdeaFavorite(input)`
+
+**Toggle Campaign Idea Favorite**
+
+- HTTP: `POST /api/v1/campaigns/ideas/{idea_id}/favorite`
+- operationId: `toggle_campaign_idea_favorite_campaigns_ideas__idea_id__favorite_post` (also callable as `g8.api.call("toggle_campaign_idea_favorite_campaigns_ideas__idea_id__favorite_post", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `campaigns:write`
+
+TOGGLE the favourite flag on an idea. FREE.
+
+A toggle, not a setter - the app has no explicit-value form, so a retried
+request flips the state back rather than being idempotent. Read the
+returned value rather than assuming the call set it.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.idea_id` | `string` | yes | Campaign idea id. |
+
+**Returns** `ApiResponse_StudioContentPayload_`: the envelope `{ data: StudioContentPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.campaigns.toggleCampaignIdeaFavorite({ path: { idea_id: "id" } });
+```
+
+---
+
+<a id="op-triggeraudiencepipeline"></a>
+
+### `g8.api.campaigns.triggerAudiencePipeline(input)`
+
+**Trigger Audience Pipeline**
+
+- HTTP: `POST /api/v1/campaigns/{campaign_id}/audience-pipeline/trigger`
+- operationId: `trigger_audience_pipeline_campaigns__campaign_id__audience_pipeline_trigger_post` (also callable as `g8.api.call("trigger_audience_pipeline_campaigns__campaign_id__audience_pipeline_trigger_post", input)`)
+- Tier: `billable`: spends credits; the SDK never blindly retries it; confirm cost before bulk use
+- API-key scope: `campaigns:run`
+
+SPENDS CREDITS. Starts the pipeline from the targeting document as it is now.
+
+Clears any filters previously accepted for this campaign so they are
+re-extracted from the (possibly edited) document, then dispatches the run:
+list, intent keywords, bulk enrichment - which spends credits per contact
+with no ceiling but the list size. 422 when the campaign has no targeting
+document with structured data. Poll `status` for progress.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.campaign_id` | `string` | yes | Campaign id or slug; resolved inside the key's organisation. |
+
+**Returns** `ApiResponse_AudiencePipelineTriggerResult_`: the envelope `{ data: AudiencePipelineTriggerResult, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`AudiencePipelineTriggerResult` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `campaign_id` | `string` | yes |  |
+| `status` | `string` | yes |  |
+| `chain_id` | `string \| null` | no |  |
+
+**Example**
+
+```ts
+// billable: spends credits; the SDK never blindly retries it; confirm cost before bulk use.
+const result = await g8.api.campaigns.triggerAudiencePipeline({ path: { campaign_id: "id" } });
+```
+
+---
+
+<a id="op-unlinklandingpagefromcampaign"></a>
+
+### `g8.api.campaigns.unlinkLandingPageFromCampaign(input)`
+
+**Unlink Landing Page From Campaign**
+
+- HTTP: `DELETE /api/v1/campaigns/{campaign_id}/landing-pages/{landing_page_id}`
+- operationId: `unlink_landing_page_from_campaign_campaigns__campaign_id__landing_pages__landing_page_id__delete` (also callable as `g8.api.call("unlink_landing_page_from_campaign_campaigns__campaign_id__landing_pages__landing_page_id__delete", input)`)
+- Tier: `destructive`: deletes or archives data; confirm with a human before calling
+- API-key scope: `campaigns:delete`
+
+Detach a landing page from this campaign. The PAGE IS NOT DELETED.
+
+It keeps serving at every URL it is published at - unlinking is an
+organisational act, not a takedown. Use
+`POST /landing-pages/{id}/unpublish` for that.
+
+The app has a SECOND route for this same operation, spelled
+`DELETE /v1/landing-pages/campaigns/{campaign_id}/{landing_page_id}`. Only
+this spelling is published: two paths for one act is how a caller ends up
+reading one and writing the other.
+
+Spends nothing.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.campaign_id` | `string` | yes | Campaign id or slug. |
+| `path.landing_page_id` | `string` | yes | The landing page to detach. |
+
+**Returns** `ApiResponse_StudioContentPayload_`: the envelope `{ data: StudioContentPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+// destructive: deletes or archives data; confirm with a human before calling.
+const result = await g8.api.campaigns.unlinkLandingPageFromCampaign({ path: { campaign_id: "id", landing_page_id: "id" } });
+```
+
+---
+
+<a id="op-updatecampaignidea"></a>
+
+### `g8.api.campaigns.updateCampaignIdea(input)`
+
+**Update Campaign Idea**
+
+- HTTP: `PATCH /api/v1/campaigns/ideas/{idea_id}`
+- operationId: `update_campaign_idea_campaigns_ideas__idea_id__patch` (also callable as `g8.api.call("update_campaign_idea_campaigns_ideas__idea_id__patch", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `campaigns:write`
+
+Edit an idea in place. FREE.
+
+The ownership scope IS the permission gate here, exactly as in the app -
+there is no separate `campaigns:write` check on this route, so the
+per-record gate is the only thing between a key and another user's idea.
+That is why it is re-declared rather than assumed.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.idea_id` | `string` | yes | Campaign idea id. |
+| `body` | `Record<string, unknown>` | yes | Request body; fields below. |
+
+**Returns** `ApiResponse_StudioContentPayload_`: the envelope `{ data: StudioContentPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.campaigns.updateCampaignIdea({ path: { idea_id: "id" }, body: {} });
+```