Generate brief — Brigg developers

Access & visibility

Allow customers.GenerateBrief on your API key.

Acting member required. Send Brigg-Act-As with an approved member account ID. The key supplies permissions; the member selects whose data is used.

The selected member must be active and approved by the credential. This selects whose private data is used; the credential supplies permissions. Private ownership and project boundaries still apply.

Set up authentication · Choose permissions

Request fields

Send a JSON object with the following fields. Required fields must be included; omit optional fields you do not need.

targetobjectRequired

The record or content item to which this operation applies.

Nested fields

typestringRequired

The record's type: core:Meeting, core:Company or core:Person.

At least 1 character. At most 60 characters.

idstringRequired

Visible Company, Person or Meeting record ID. Match it to target.type; an account ID cannot be used here.

At least 1 character. At most 80 characters.

forcebooleanOptional

Regenerate a fresh brief. Omit or send false to reuse it. Other readiness, permission and credit checks still apply.

Start, wait, then review

Find the target with List companies, List people or List meetings. Pass its resource type and record ID together.
Call this operation. started: true means work was queued, not that the brief is ready. Keep the returned job_id.
Poll Get job with the same acting member until it completes, fails or needs input. Respect retry_at when supplied.
Review the brief on that record in Brigg. The current public record models do not expose the brief body; the job result identifies the affected record, not the generated text. Use this operation to refresh Brigg's briefing, not to obtain generated prose for another system.

When no job starts

fresh means the existing brief can be reused. already_running means another run is working on this target; this response does not include that run's job ID. scrape_pending waits for linked website content. awaiting_first_prep waits for the meeting's initial preparation. no_target means the target disappeared or is no longer available. Other reasons can be returned; retain the reason for diagnostics instead of assuming every no-op means success.

force: true bypasses the freshness check only. It does not bypass an active run, pending source material, access checks or credit checks. Starting generation uses workspace credits; reusing a fresh brief starts no new generation.

Response

Returns 200 OK with a JSON body.

okbooleanRequired

Whether the action completed successfully.

startedbooleanRequired

True when new background work started. False requires inspecting reason; neither value means generation has completed.

reasonstringOptional

Why no new work started, for example fresh, already_running, scrape_pending or awaiting_first_prep. Treat this as an open set of outcomes.

job_idstringOptional

Present when new work starts. Poll Get job as the same member.

Errors & retries

Set BRIGG_REQUEST_ID once for each logical action. The samples send it as Idempotency-Key. Reuse the same value and body on retries, including after a timeout; a missing response does not prove the action failed.

For rate limits, follow the server’s retry guidance and back off. See HTTP errors and safe retries and limits.

HTTP status	Code	What to do
400	`invalid_json`	Send a JSON object with Content-Type: application/json.
400	`invalid_input`	Check the request fields and types. Supply a stable Idempotency-Key containing 1–200 characters.
401	`invalid_key`	The workspace API key is missing, invalid or revoked.
403	`forbidden`	Check the key’s operation and resource grants. Supply Brigg-Act-As with a member authorized by the key’s delegation grant. The selected member must be active and approved by the credential. This selects whose private data is used; the credential supplies permissions. Private ownership and project boundaries still apply.
404	`not_found`	The requested operation or resource is not available to this credential.
429	`rate_limited`	Wait for Retry-After before retrying. Reuse the original Idempotency-Key.

Next steps

Download OpenAPI · Versioning & retirement

JSON schemas

Use the complete schemas for validation or client generation.

Full request JSON schema

{
  "type": "object",
  "properties": {
    "target": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string",
          "minLength": 1,
          "maxLength": 60,
          "description": "The record's type: core:Meeting, core:Company or core:Person."
        },
        "id": {
          "type": "string",
          "minLength": 1,
          "maxLength": 80,
          "description": "Visible Company, Person or Meeting record ID. Match it to target.type; an account ID cannot be used here."
        }
      },
      "required": [
        "type",
        "id"
      ],
      "additionalProperties": false,
      "description": "The record or content item to which this operation applies."
    },
    "force": {
      "type": "boolean",
      "description": "Regenerate a fresh brief. Omit or send false to reuse it. Other readiness, permission and credit checks still apply."
    }
  },
  "required": [
    "target"
  ],
  "additionalProperties": false,
  "examples": [
    {
      "target": {
        "type": "core:Company",
        "id": "e_company_northstar"
      }
    }
  ]
}

Full response JSON schema

{
  "type": "object",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Whether the action completed successfully."
    },
    "started": {
      "type": "boolean",
      "description": "True when new background work started. False requires inspecting reason; neither value means generation has completed."
    },
    "reason": {
      "type": "string",
      "description": "Why no new work started, for example fresh, already_running, scrape_pending or awaiting_first_prep. Treat this as an open set of outcomes."
    },
    "job_id": {
      "type": "string",
      "description": "Present when new work starts. Poll [Get job](/reference/workspace/GetJob) as the same member."
    }
  },
  "required": [
    "ok",
    "started"
  ],
  "additionalProperties": false,
  "examples": [
    {
      "ok": true,
      "started": true,
      "job_id": "job_brief_northstar"
    }
  ]
}

Try the request

Use your API key in a server environment.

Example scenario

Requires BRIGG_ACT_AS: an approved member account ID.

A stale brief starts a background job. The ID is fictional; use the ID your response returns.

Request

cURL

curl 'https://api.brigg.app/v1/operations/customers.GenerateBrief' \
  -H "Authorization: Bearer $BRIGG_API_KEY" \
  -H 'Content-Type: application/json' \
  -H "Brigg-Act-As: $BRIGG_ACT_AS" \
  -H "Idempotency-Key: $BRIGG_REQUEST_ID" \
  --data-raw '{
  "target": {
    "type": "core:Company",
    "id": "e_company_northstar"
  }
}'

TypeScript

const actAs = process.env.BRIGG_ACT_AS;
if (!actAs) throw new Error("Set BRIGG_ACT_AS to an approved member account ID.");

const requestId = process.env.BRIGG_REQUEST_ID;
if (!requestId) throw new Error("Set BRIGG_REQUEST_ID once per action and reuse it on retries.");

const response = await fetch("https://api.brigg.app/v1/operations/customers.GenerateBrief", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.BRIGG_API_KEY}`,
    "Content-Type": "application/json",
    "Brigg-Act-As": actAs,
    "Idempotency-Key": requestId, // Create once per action; reuse on retries.
  },
  body: JSON.stringify({
    "target": {
      "type": "core:Company",
      "id": "e_company_northstar"
    }
  }),
});
const result = await response.json();
if (!response.ok) throw new Error(`${response.status}: ${result.error} — ${result.message}`);
console.log(result);

Python

import json
import os
from urllib.request import Request, urlopen
from urllib.error import HTTPError

request_id = os.environ["BRIGG_REQUEST_ID"]  # Reuse for retries of this action.
payload = {
  "target": {
    "type": "core:Company",
    "id": "e_company_northstar"
  }
}
request = Request(
    "https://api.brigg.app/v1/operations/customers.GenerateBrief",
    data=json.dumps(payload).encode("utf-8"),
    headers={
        "Authorization": f"Bearer {os.environ['BRIGG_API_KEY']}",
        "Content-Type": "application/json",
        "Brigg-Act-As": os.environ["BRIGG_ACT_AS"],
        "Idempotency-Key": request_id,  # Create once per action; reuse on retries.
    },
    method="POST",
)
try:
    with urlopen(request) as response:
        print(json.load(response))
except HTTPError as error:
    print(error.code, json.load(error))
    raise

200 OK Response example

{
  "ok": true,
  "started": true,
  "job_id": "job_brief_northstar"
}

Illustrative values, not a live response.

The same request can return a no-op. There is no job to poll in this response.

Request

cURL

curl 'https://api.brigg.app/v1/operations/customers.GenerateBrief' \
  -H "Authorization: Bearer $BRIGG_API_KEY" \
  -H 'Content-Type: application/json' \
  -H "Brigg-Act-As: $BRIGG_ACT_AS" \
  -H "Idempotency-Key: $BRIGG_REQUEST_ID" \
  --data-raw '{
  "target": {
    "type": "core:Company",
    "id": "e_company_northstar"
  }
}'

TypeScript

const actAs = process.env.BRIGG_ACT_AS;
if (!actAs) throw new Error("Set BRIGG_ACT_AS to an approved member account ID.");

const requestId = process.env.BRIGG_REQUEST_ID;
if (!requestId) throw new Error("Set BRIGG_REQUEST_ID once per action and reuse it on retries.");

const response = await fetch("https://api.brigg.app/v1/operations/customers.GenerateBrief", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.BRIGG_API_KEY}`,
    "Content-Type": "application/json",
    "Brigg-Act-As": actAs,
    "Idempotency-Key": requestId, // Create once per action; reuse on retries.
  },
  body: JSON.stringify({
    "target": {
      "type": "core:Company",
      "id": "e_company_northstar"
    }
  }),
});
const result = await response.json();
if (!response.ok) throw new Error(`${response.status}: ${result.error} — ${result.message}`);
console.log(result);

Python

import json
import os
from urllib.request import Request, urlopen
from urllib.error import HTTPError

request_id = os.environ["BRIGG_REQUEST_ID"]  # Reuse for retries of this action.
payload = {
  "target": {
    "type": "core:Company",
    "id": "e_company_northstar"
  }
}
request = Request(
    "https://api.brigg.app/v1/operations/customers.GenerateBrief",
    data=json.dumps(payload).encode("utf-8"),
    headers={
        "Authorization": f"Bearer {os.environ['BRIGG_API_KEY']}",
        "Content-Type": "application/json",
        "Brigg-Act-As": os.environ["BRIGG_ACT_AS"],
        "Idempotency-Key": request_id,  # Create once per action; reuse on retries.
    },
    method="POST",
)
try:
    with urlopen(request) as response:
        print(json.load(response))
except HTTPError as error:
    print(error.code, json.load(error))
    raise

200 OK Response example

{
  "ok": true,
  "started": false,
  "reason": "fresh"
}

Illustrative values, not a live response.

This can incur another generation charge. It still cannot start a duplicate active run.

Request

cURL

curl 'https://api.brigg.app/v1/operations/customers.GenerateBrief' \
  -H "Authorization: Bearer $BRIGG_API_KEY" \
  -H 'Content-Type: application/json' \
  -H "Brigg-Act-As: $BRIGG_ACT_AS" \
  -H "Idempotency-Key: $BRIGG_REQUEST_ID" \
  --data-raw '{
  "target": {
    "type": "core:Company",
    "id": "e_company_northstar"
  },
  "force": true
}'

TypeScript

const actAs = process.env.BRIGG_ACT_AS;
if (!actAs) throw new Error("Set BRIGG_ACT_AS to an approved member account ID.");

const requestId = process.env.BRIGG_REQUEST_ID;
if (!requestId) throw new Error("Set BRIGG_REQUEST_ID once per action and reuse it on retries.");

const response = await fetch("https://api.brigg.app/v1/operations/customers.GenerateBrief", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.BRIGG_API_KEY}`,
    "Content-Type": "application/json",
    "Brigg-Act-As": actAs,
    "Idempotency-Key": requestId, // Create once per action; reuse on retries.
  },
  body: JSON.stringify({
    "target": {
      "type": "core:Company",
      "id": "e_company_northstar"
    },
    "force": true
  }),
});
const result = await response.json();
if (!response.ok) throw new Error(`${response.status}: ${result.error} — ${result.message}`);
console.log(result);

Python

import json
import os
from urllib.request import Request, urlopen
from urllib.error import HTTPError

request_id = os.environ["BRIGG_REQUEST_ID"]  # Reuse for retries of this action.
payload = {
  "target": {
    "type": "core:Company",
    "id": "e_company_northstar"
  },
  "force": True
}
request = Request(
    "https://api.brigg.app/v1/operations/customers.GenerateBrief",
    data=json.dumps(payload).encode("utf-8"),
    headers={
        "Authorization": f"Bearer {os.environ['BRIGG_API_KEY']}",
        "Content-Type": "application/json",
        "Brigg-Act-As": os.environ["BRIGG_ACT_AS"],
        "Idempotency-Key": request_id,  # Create once per action; reuse on retries.
    },
    method="POST",
)
try:
    with urlopen(request) as response:
        print(json.load(response))
except HTTPError as error:
    print(error.code, json.load(error))
    raise

200 OK Response example

{
  "ok": true,
  "started": false,
  "reason": "already_running"
}

Illustrative values, not a live response.