Hillwinds APIDocs
For AI Agents

Machine-readable endpoint index

Every operation the live API exposes today (103 operations across 78 paths, generated from OpenAPI at build time).

OpenAPI covers 103 operations across 78 paths
The live spec at /v1/openapi.json is authoritative for the operation list, query parameters, types, and enums. It does not ship complete response schemas; use the per-resource API reference pages for response shapes.

Endpoints

MethodPathSummary
GET/v1/api-keysList API keys
POST/v1/api-keysCreate child API key
DELETE/v1/api-keys/{key_id}Revoke API key
POST/v1/api-keys/{key_id}/rotateRotate API key
GET/v1/broker-officesList broker offices
GET/v1/broker-offices/autocompleteAutocomplete broker offices
GET/v1/broker-offices/export.csvExport broker offices CSV
GET/v1/broker-offices/{id}Get broker office
GET/v1/broker-offices/{id}/tagsList broker office tags
GET/v1/brokersList brokers
GET/v1/brokers/autocompleteAutocomplete brokers
GET/v1/brokers/export.csvExport brokers CSV
GET/v1/brokers/lookupLookup broker
GET/v1/brokers/{id}Get broker
GET/v1/brokers/{id}/tagsList broker tags
GET/v1/companiesList companies
GET/v1/companies/autocompleteAutocomplete companies
POST/v1/companies/batchBatch lookup companies
GET/v1/companies/export.csvExport companies CSV
GET/v1/companies/lookupLookup company
GET/v1/companies/{id}Get company
GET/v1/companies/{id}/tagsList company tags
GET/v1/creditsCheck credit balance
GET/v1/credits/usageCredit usage history
GET/v1/credits/usage/by-endpointCredit usage grouped by endpoint
GET/v1/credits/usage/by-keyCredit usage grouped by API key
GET/v1/data-flagsList data quality flags
POST/v1/data-flagsCreate data quality flag
PATCH/v1/data-flags/bulkInternal reviewer: bulk approve or reject data quality flags
PATCH/v1/data-flags/{id}Internal reviewer: approve or reject data quality flag
DELETE/v1/data-flags/{id}Internal reviewer: delete data quality flag
GET/v1/dynamic-tagsList saved dynamic tags
POST/v1/dynamic-tagsCreate a saved dynamic tag
GET/v1/dynamic-tags/{id}Get a saved dynamic tag
PATCH/v1/dynamic-tags/{id}Edit a saved dynamic tag
DELETE/v1/dynamic-tags/{id}Delete a saved dynamic tag
GET/v1/filter-optionsList filter options
GET/v1/filter-options/broker-officesGet broker office filter details
GET/v1/filter-options/brokersGet broker filter details
GET/v1/filter-options/companiesGet company filter details
GET/v1/filter-options/personnelGet personnel filter details
GET/v1/filter-options/top_brokersGet top broker filter values
GET/v1/filter-options/{key}Get filter option values
GET/v1/filter-options/{resource}/{filter}Get resource filter values
GET/v1/identitiesList marketing identities
POST/v1/identitiesCreate a marketing identity
GET/v1/identities/schemaGet the marketing identity JSON structure
GET/v1/identities/{id}Get a marketing identity
PATCH/v1/identities/{id}Edit a marketing identity
DELETE/v1/identities/{id}Delete a marketing identity
POST/v1/identities/{id}/duplicateDuplicate a marketing identity
POST/v1/identities/{id}/shareCreate or retrieve an identity share link
GET/v1/identity-generation-jobs/{job_id}Get marketing identity generation status
GET/v1/identity-shares/{token}Get a shared marketing identity
GET/v1/llms-full.txtRead the complete plain-text API reference
GET/v1/llms.txtList machine-readable API discovery links and core endpoints
POST/v1/lookalikesFind similar entities
GET/v1/personnelList personnel
GET/v1/personnel/autocompleteAutocomplete personnel
POST/v1/personnel/batchBatch enrich personnel by company EIN or personnel id
GET/v1/personnel/export.csvExport personnel CSV
GET/v1/personnel/{id}Get personnel
GET/v1/personnel/{id}/tagsList personnel tags
POST/v1/reportsCreate API bug report
GET/v1/review-flagsList review flags
POST/v1/review-flagsCreate review flag (alias of data-flags)
PATCH/v1/review-flags/bulkInternal reviewer: bulk approve or reject review flags
PATCH/v1/review-flags/{id}Internal reviewer: approve or reject review flag
DELETE/v1/review-flags/{id}Internal reviewer: delete review flag
GET/v1/tagsList tags
POST/v1/tagsCreate tag
DELETE/v1/tagsDelete tag by entity id and tag
POST/v1/tags/bulkBulk create tags
GET/v1/tags/entitiesList entities for tag
DELETE/v1/tags/{id}Delete tag
GET/v1/usage/ai-costsReport internal writing AI costs
GET/v1/usage/by-endpointCredit usage grouped by endpoint
GET/v1/usage/by-keyCredit usage grouped by API key
GET/v1/usage/writingReport writing API usage
GET/v1/whoamiInspect current caller
GET/v1/writing-ctasList personal writing CTAs
POST/v1/writing-ctasCreate a personal writing CTA
GET/v1/writing-ctas/{id}Get a personal writing CTA
PATCH/v1/writing-ctas/{id}Edit a personal writing CTA
DELETE/v1/writing-ctas/{id}Delete a personal writing CTA
GET/v1/writing-jobsList writing generation jobs
POST/v1/writing-jobsStart email or LinkedIn generation
POST/v1/writing-jobs/batchStart writing generation for up to 25 targets
GET/v1/writing-jobs/{job_id}Get a writing generation job
GET/v1/writing-playsList personal writing plays
POST/v1/writing-playsAdd one or more personal writing plays
GET/v1/writing-plays/{id}Get a personal writing play
PATCH/v1/writing-plays/{id}Edit a personal writing play
DELETE/v1/writing-plays/{id}Delete a personal writing play
GET/v1/writing-subjectsList saved subject lines
POST/v1/writing-subjectsCreate a saved subject line
GET/v1/writing-subjects/{id}Get a saved subject line
PATCH/v1/writing-subjects/{id}Edit a saved subject line
DELETE/v1/writing-subjects/{id}Delete a saved subject line
GET/v1/writing/optionsList selectable writing inputs
GET/v1/writing/temperatureGet Personal Play temperature
POST/v1/writing/temperatureSet Personal Play temperature
PATCH/v1/writing/temperatureSet Personal Play temperature
Generated on every build
This table is generated directly from OpenAPI before the site build, so new and removed operations cannot drift from the deployed specification.
PreviousRecipe LibraryNext Field Tiers