Skip to main content
POST
Get AI Article Recommendations (ZeroClick-authenticated)

Authorizations

zc-signature
string
header
required

HMAC signature minted by ZeroClick over the raw request bytes, of the form t=<unix-seconds>,kid=<key-id>,v1=<hex-hmac>. The canonical string signed is t \n METHOD \n path+query \n sha256hex(body) \n zc-request-id \n zc-agent-id, and v1 = hex(HMAC_SHA256(secret, canonical)). Verified against the seller's signing secret keyed by kid, with a ±300s timestamp skew bound.

A missing or invalid signature is rejected with 401 invalid_zeroclick_signature; this is never failed open.

Headers

zc-request-id
string
required

ZeroClick request id, set by ZeroClick when it proxies the request. It is part of the signed canonical string, so a request without it cannot verify.

Example:

"zcreq_1"

zc-agent-id
string

Identifier of the buying agent. Used to partition logs/analytics by agent; becomes the synthesized caller identity (zeroclick:<agent-id>). Treated as an empty string when absent, which the signer must match.

Example:

"agt_1"

Query Parameters

data_model_id
string
required

Data model ID, starting with dm_. Browse and find data models in the Dappier Marketplace.

search_version
string

Optional search version override, forwarded to the retrieval pipeline.

Body

application/json
query
string
required

Natural language query, keyword, or URL. If a URL is specified, our AI analyzes the page context, summarizes it, and provides semantic recommendations based on the content.

similarity_top_k
integer
default:9

The number of articles to return.

ref
string

The site domain where AI recommendations are being displayed. Example format: dappier.com.

num_articles_ref
integer
default:0

The minimum number of articles from the ref domain specified above. The rest of the articles will come from other sites within the RAG model.

search_type
string

Optional search type forwarded to the retrieval pipeline.

search_algorithm
enum<string>

The search algorithm for retrieving articles. most_recent: Retrieves the most recent articles by publication date. semantic (default): Retrieves contextually relevant articles based on the query or the page content from the provided URL. most_recent_semantic: Performs semantic search and retrieves the most recent articles by publication date. trending: Performs a trending search and retrieves the most relevant articles to trending keywords in the past 24 hours.

Available options:
most_recent,
semantic,
most_recent_semantic,
trending
page
integer
default:1

Page number for pagination.

num_results
integer
default:10

Number of results per page.

Response

Article recommendations. Includes the zc-usage header settling usage with ZeroClick.

status
string

The status of the API response.

response
object