---
title: "Draft Brief"
method: POST
path: "/api/v1/scout/brief/draft"
tags: ["scout"]
---

# Draft Brief

`POST /api/v1/scout/brief/draft`

## Request

- Base URL: `https://api.nudgelink.co` (the document declares no server; this is the origin it was published from)
- URL: `https://api.nudgelink.co/api/v1/scout/brief/draft`
- Auth: HTTP bearer

"Describe it in words": a sentence -> a brief the page shows for review.
Never starts a run. Free for the customer; one small Haiku call.

## Request body

- BriefDraftRequest
  - `text` string, required

## Response `200`

Successful Response

- ScoutBrief: None = keep the campaign's value; a list (even empty) replaces it. ``mode``: titles (a role in a market), companies (those roles at the ``target_companies`` listed), lookalike (companies like ``seed_companies``, then the roles at the companies found).
  - `mode` 'titles' | 'companies' | 'lookalike', nullable
  - `target_companies` string[], nullable
  - `seed_companies` string[], nullable
  - `titles` string[], nullable
  - `industries` string[], nullable
  - `locations` string[], nullable
  - `exclude_titles` string[], nullable
  - `exclude_companies` string[], nullable

## Other responses

- `422`: Validation Error

---

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