buzzabout docs
API referenceEndpoints

Patterns

Read a discovered pattern and walk into its constituent items + posts.

A pattern is the artefact a pattern detection produces — a named, clustered view of a dataset that groups posts by recurring narrative or angle. Patterns are read-only on the API; create them via pattern detections or via a tracking agent.

Pricing

Free — no credits charged. The cost lives on the upstream pattern-detection or tracking-agent run that produced the pattern. See Pricing.

Endpoints

GET
/v1/patterns/{pattern_id}

Authorization

ApiKeyAuth
x-api-key<token>

Buzzabout API key, beginning with bz_live_ (or bz_test_ for staging-only keys).

In: header

Path Parameters

pattern_id*Pattern Id

Response Body

application/json

application/json

curl -X GET "https://example.com/v1/patterns/string"
null
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}
GET
/v1/patterns/{pattern_id}/items/{item_id}

Authorization

ApiKeyAuth
x-api-key<token>

Buzzabout API key, beginning with bz_live_ (or bz_test_ for staging-only keys).

In: header

Path Parameters

pattern_id*Pattern Id
item_id*Item Id

Response Body

application/json

application/json

curl -X GET "https://example.com/v1/patterns/string/items/string"
null
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Shape

GET /v1/patterns/{id} returns a top-level summary plus an items[] array of PatternItem summaries. Each item carries:

  • A short title and synopsis.
  • A post_count (how many posts cluster into it).
  • An item_id you can use to drill into the underlying posts.

GET /v1/patterns/{pattern_id}/items/{item_id} expands one item with the full list of constituent posts. Use the mentions endpoint with the returned post_refs to fetch the post bodies.

Pattern in references[]

Assistant turns sometimes cite a pattern under references[] with { "type": "pattern", "id": "pt_..." }. Resolve via the endpoint above.

Next steps

On this page