Summaries

List company summaries

GET
/v1/companies/summaries

Lists previously generated summaries for a domain, newest first — the same operation as GET /v1/companies/signals/summaries, on its new home. Reads are free.

Authorization

ApiKeyAuth
AuthorizationBearer <token>

API key authentication using Bearer token. Format: sk_live_ followed by a secure random string.

In: header

Query Parameters

domain*string
limit?integer
Range1 <= value <= 100
Default20
offset?integer
Range0 <= value
Default0

Response Body

application/json

application/json

curl -X GET "https://example.com/v1/companies/summaries?domain=string"
{  "results": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "summary": [        {          "description": "string",          "referenceQuestions": [            "string"          ],          "qualification": "disqualified",          "sources": [            {              "url": "http://example.com",              "title": "string",              "snippet": "string"            }          ]        }      ],      "status": "in_progress",      "signalsCount": 0,      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    }  ],  "total": 0,  "limit": 0,  "offset": 0,  "count": 0}

Generate a company summary

POST
/v1/companies/summaries

Generates a summary of the completed enrichments for a domain — the same operation as POST /v1/companies/signals/summaries, on its new home (decision 26: the API resource is summaries; "Brief" stays the in-app word). The legacy route stays free until its announced sunset; use this route going forward.

Returns 204 when the domain has no completed enrichments to summarize, and 409 when a summary for the domain is already being generated.

Credits

0.25 credits, charged only when a summary is FRESHLY generated (a 200 with new content): 204, 409, errors, and repeat calls served from the stored summary (no new enrichments completed since it was written) never charge. A summary is one LLM pass over enrichments you already paid for — priced below the cheapest prebuilt enrichment type (decision 20), and billed once per pass, however many times you re-read it.

Authorization

ApiKeyAuth
AuthorizationBearer <token>

API key authentication using Bearer token. Format: sk_live_ followed by a secure random string.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

domain*string

The company domain to generate a summary for (e.g., "acme.com")

Match^[a-zA-Z0-9]([a-zA-Z0-9\-]{0,61}[a-zA-Z0-9])?(\.[a-zA-Z0-9]([a-zA-Z0-9\-]{0,61}[a-zA-Z0-9])?)*$
Length1 <= length <= 253

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/companies/summaries" \  -H "Content-Type: application/json" \  -d '{    "domain": "string"  }'
{  "summary": [    {      "description": "string",      "referenceQuestions": [        "string"      ],      "qualification": "disqualified",      "sources": [        {          "url": "http://example.com",          "title": "string",          "snippet": "string"        }      ]    }  ]}

On this page

SummariesList company summariesGenerate a company summary