API Reference
Search your articles
Full-text search over the authenticated account’s own articles (matches title, description, source URL). q is required. Results are recency-ranked; pass limit (1–20, default 8) to size the page. This endpoint is page-limited rather than cursor-paginated because search is a ranked top-N, which a keyset cursor cannot express.
Authorization
BearerApiKey AuthorizationBearer <token>
A Shorty API key, sent as Authorization: Bearer <key>. An OAuth 2.1 access token issued to a connected app is also accepted on the same header.
In: header
Query Parameters
q*string
Length
1 <= lengthlimit?integer
Range
1 <= value <= 20Default
8article_type?string
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/v1/articles/search?q=string"{ "data": [ { "id": "string", "title": "string", "description": "string", "article_type": "string", "source_url": "string", "created_at": "string" } ], "count": -9007199254740991}