Advanced APIs

Domain intelligence

Get a structured overview of a company or website in one call: a summary, important pages, and sampled content.

Overview

Domain combines mapping, sampling, and summarization into a single asynchronous job. It returns a job_id you poll for the result.

POST/domain

Request

Request
curl https://api.ohsee.tech/domain \
  -H "Authorization: Bearer ohsee-<your-key>" \
  -H "Content-Type: application/json" \
  -d '{ "domain": "example.com", "sections": ["summary", "pricing", "docs"] }'

Parameters

FieldTypeDefaultDescription
domainrequiredstring-Hostname or URL. Bare hostnames are treated as https.
sectionsstring[]["summary", "important_pages", "pricing", "docs"]Which sections to build.
limitint40How many URLs to map while sampling (5 to 200).

Result

GET /jobs/{id}
{
  "job_id": "e5f6a7b8-...",
  "kind": "domain",
  "status": "succeeded",
  "credits": { "reserved": 14, "charged": 14, "refunded": 0 },
  "result": {
    "domain": "example.com",
    "summary": "Example Inc builds ...",
    "important_pages": { "pricing": [], "docs": [], "blog": [], "support": [] },
    "pages_sampled": [{ "url": "https://example.com", "content_preview": "..." }],
    "sections": ["summary", "pricing", "docs"]
  }
}
FieldTypeDescription
result.summarystring | nullOverview of the site.
result.important_pagesobjectGrouped links: pricing, docs, blog, support.
result.pages_sampledobject[]Sampled pages, each with url and content_preview.
result.sectionsstring[]Sections that were built.

Credits

Fixed cost of 5 credits plus 3 per requested section, independent of how much content is found.