---
title: "Get Agent Discovery Campaign Brief"
method: GET
path: "/agent/onboarding/discovery/campaign-brief"
tags: ["Agents"]
---

# Get Agent Discovery Campaign Brief

`GET /agent/onboarding/discovery/campaign-brief`

## Request

- Base URL: `https://be.graph8.com/api/v1`
- URL: `https://be.graph8.com/api/v1/agent/onboarding/discovery/campaign-brief`
- Auth: HTTP bearer

The campaign brief the record would produce. A PREVIEW - it writes
nothing.

Deterministic and LLM-free: running it again after two more answers gives
the same document plus two facts, not a differently-worded one. That is
what makes it safe to poll while the interview is still going.

It never fills a gap to look finished. `open_musts` and `assumptions` come
back alongside the copy, because a brief that reads as complete while four
must-answer questions are open is how a silent gap becomes a confident
wrong campaign.

## Headers

- `Authorization` string, nullable
- `X-Target-Org-Id` string, nullable

## Response `200`

Successful Response

- ApiResponseOnboardingPayload
  - `data` OnboardingPayload, required: An open envelope for an onboarding or discovery result. Open on purpose. Discovery state carries a per-field coverage matrix whose field set is the product's own onboarding questionnaire - it changes as the questionnaire does, and a pinned mirror would silently DROP a field the customer had answered. On a surface whose whole job is "what do we still not know about you", a dropped field reads as an answered question.
  - `pagination` PaginationMeta
    - `page` integer, required: Current page number (1-indexed)
    - `limit` integer, required: Items per page
    - `total` integer, required: Total number of items
    - `has_next` boolean, required: Whether there are more pages
    - `next_cursor` string, nullable: Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers.
    - `total_available` integer, nullable: Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search.
    - `total_is_lower_bound` boolean, nullable: Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search.
    - `notes` string[], nullable: Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order.

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/graph8/apis/graph8-developer-api.md) · [All operations](https://skmtc.dev/graph8/apis/graph8-developer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/graph8/apis/graph8-developer-api/revisions/2e7cfa0ca921?raw)