Hanzo
OpenapiWorld

Replaces the caller project's news pipeline and returns what was stored.

Replaces the caller project's news pipeline and returns what was stored.

PUT /v1/world/pipeline

Addresshttps://api.hanzo.ai/v1/world/pipeline
MethodPUT
Operationput_world_pipeline
AuthAuthorization: Bearer $HANZO_API_KEY

Replaces the caller project's news pipeline and returns what was stored. It is a WHOLE replacement, not a patch: a field the request leaves out is stored empty, so sending only feeds clears the filters.

Every feed URL is validated HERE, at the write boundary — http(s) only, and the host must be on the server's allowlist — so a stored pipeline can never name a host the fetcher would later refuse, and the allowlist is one decision in one place rather than a check at each fetch.

Request

5 fields, body application/json (required).

FieldInTypeRequiredDescription
feedsbodystring[]Feeds is the RSS/Atom feed URLs to read, at most 64.
filtersbodyFilters
filters.keywordsbodystring[]Keywords keeps only items whose TITLE contains one of these, case-insensitively.
filters.regionsbodystring[]Regions keeps only items whose TITLE contains one of these, matched case-insensitively as a substring.
filters.sourcesbodystring[]Sources keeps only items whose outlet name contains one of these, case-insensitively.

Response

StatusBodyMeaning
200pipelineViewok

200 body — 10 fields.

FieldInTypeAlwaysDescription
createdAtbodystringCreatedAt is when the pipeline was first stored, RFC3339 UTC.
defaultbodybooleanDefault is true when no pipeline is stored for this project and these are the built-in world feeds.
feedsbodystring[]Feeds is the RSS/Atom feed URLs the pipeline reads.
filtersbodyFilters
filters.keywordsbodystring[]Keywords keeps only items whose TITLE contains one of these, case-insensitively.
filters.regionsbodystring[]Regions keeps only items whose TITLE contains one of these, matched case-insensitively as a substring.
filters.sourcesbodystring[]Sources keeps only items whose outlet name contains one of these, case-insensitively.
orgbodystringOrg is the tenant the pipeline belongs to, resolved server-side from the validated principal.
projectbodystringProject is the org sub-scope the pipeline belongs to.
updatedAtbodystringUpdatedAt is when it was last written, RFC3339 UTC.

Failure carries the platform error shape — see Errors.

Examples

hanzo world pipeline replace

World API · All Hanzo APIs · Interactive reference

How is this guide?

On this page