← Lynx
API Reference
Protocol Documentation
Table of Contents
schemas/lynx/v1/feed.proto
Feed
| Field | Type | Label | Description |
|---|---|---|---|
| uuid | string | ||
| title | string | ||
| url | string | ||
| description | string | ||
| categories | string | repeated | |
| website_id | string |
schemas/lynx/v1/services/feed.proto
CreateFeedRequest
| Field | Type | Label | Description |
|---|---|---|---|
| data | schemas.lynx.v1.Feed |
CreateFeedResponse
| Field | Type | Label | Description |
|---|---|---|---|
| data | schemas.lynx.v1.Feed |
DeleteFeedRequest
| Field | Type | Label | Description |
|---|---|---|---|
| uuid | string |
DeleteFeedResponse
| Field | Type | Label | Description |
|---|---|---|---|
| success | bool |
GetFeedRequest
| Field | Type | Label | Description |
|---|---|---|---|
| uuid | string |
GetFeedResponse
| Field | Type | Label | Description |
|---|---|---|---|
| data | schemas.lynx.v1.Feed |
ListFeedsRequest
| Field | Type | Label | Description |
|---|---|---|---|
| count | int32 | optional | |
| cursor | string | optional |
ListFeedsResponse
| Field | Type | Label | Description |
|---|---|---|---|
| data | schemas.lynx.v1.Feed | repeated | |
| cursor | string | ||
| count | int32 |
UpdateFeedRequest
| Field | Type | Label | Description |
|---|---|---|---|
| uuid | string | ||
| data | schemas.lynx.v1.Feed |
UpdateFeedResponse
| Field | Type | Label | Description |
|---|---|---|---|
| data | schemas.lynx.v1.Feed |
FeedService
| Method Name | Request Type | Response Type | Description |
|---|---|---|---|
| ListFeeds | ListFeedsRequest | ListFeedsResponse | |
| GetFeed | GetFeedRequest | GetFeedResponse | |
| CreateFeed | CreateFeedRequest | CreateFeedResponse | |
| UpdateFeed | UpdateFeedRequest | UpdateFeedResponse | |
| DeleteFeed | DeleteFeedRequest | DeleteFeedResponse |
schemas/lynx/v1/website.proto
Website
| Field | Type | Label | Description |
|---|---|---|---|
| uuid | string | ||
| name | string | ||
| url | string | ||
| description | string |
schemas/lynx/v1/services/website.proto
CreateWebsiteRequest
| Field | Type | Label | Description |
|---|---|---|---|
| data | schemas.lynx.v1.Website |
CreateWebsiteResponse
| Field | Type | Label | Description |
|---|---|---|---|
| data | schemas.lynx.v1.Website |
DeleteWebsiteRequest
| Field | Type | Label | Description |
|---|---|---|---|
| uuid | string |
DeleteWebsiteResponse
| Field | Type | Label | Description |
|---|---|---|---|
| success | bool |
GetWebsiteRequest
| Field | Type | Label | Description |
|---|---|---|---|
| uuid | string |
GetWebsiteResponse
| Field | Type | Label | Description |
|---|---|---|---|
| data | schemas.lynx.v1.Website | ||
| metadata | WebsiteMetadata | optional |
ListWebsitesRequest
| Field | Type | Label | Description |
|---|---|---|---|
| count | int32 | optional | |
| cursor | string | optional |
ListWebsitesResponse
| Field | Type | Label | Description |
|---|---|---|---|
| data | schemas.lynx.v1.Website | repeated | |
| cursor | string | ||
| count | int32 |
RegenerateSummaryRequest
| Field | Type | Label | Description |
|---|---|---|---|
| uuid | string |
RegenerateSummaryResponse
| Field | Type | Label | Description |
|---|---|---|---|
| success | bool | ||
| summary | string |
UpdateWebsiteRequest
| Field | Type | Label | Description |
|---|---|---|---|
| uuid | string | ||
| data | schemas.lynx.v1.Website |
UpdateWebsiteResponse
| Field | Type | Label | Description |
|---|---|---|---|
| data | schemas.lynx.v1.Website |
WebsiteMetadata
| Field | Type | Label | Description |
|---|---|---|---|
| enrichment_status | string | ||
| enriched_at | google.protobuf.Timestamp | ||
| original_html_path | string | ||
| readable_content_path | string | ||
| status_code | int32 | ||
| content_type | string | ||
| content_length | int64 | ||
| checksum | string | ||
| title | string | ||
| description | string | ||
| og_image | string | ||
| favicon_url | string | ||
| canonical_url | string | ||
| language | string | ||
| charset | string | ||
| keywords | string | ||
| author | string | ||
| site_name | string | ||
| word_count | int32 | ||
| summary | string | ||
| summarized_at | google.protobuf.Timestamp |
WebsiteService
| Method Name | Request Type | Response Type | Description |
|---|---|---|---|
| ListWebsites | ListWebsitesRequest | ListWebsitesResponse | |
| GetWebsite | GetWebsiteRequest | GetWebsiteResponse | |
| CreateWebsite | CreateWebsiteRequest | CreateWebsiteResponse | |
| UpdateWebsite | UpdateWebsiteRequest | UpdateWebsiteResponse | |
| DeleteWebsite | DeleteWebsiteRequest | DeleteWebsiteResponse | |
| RegenerateSummary | RegenerateSummaryRequest | RegenerateSummaryResponse |
Scalar Value Types
| .proto Type | Notes | C++ | Java | Python | Go | C# | PHP | Ruby |
|---|---|---|---|---|---|---|---|---|
| double | double | double | float | float64 | double | float | Float | |
| float | float | float | float | float32 | float | float | Float | |
| int32 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) |
| int64 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. | int64 | long | int/long | int64 | long | integer/string | Bignum |
| uint32 | Uses variable-length encoding. | uint32 | int | int/long | uint32 | uint | integer | Bignum or Fixnum (as required) |
| uint64 | Uses variable-length encoding. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum or Fixnum (as required) |
| sint32 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) |
| sint64 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int64 | long | int/long | int64 | long | integer/string | Bignum |
| fixed32 | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | uint32 | int | int | uint32 | uint | integer | Bignum or Fixnum (as required) |
| fixed64 | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum |
| sfixed32 | Always four bytes. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) |
| sfixed64 | Always eight bytes. | int64 | long | int/long | int64 | long | integer/string | Bignum |
| bool | bool | boolean | boolean | bool | bool | boolean | TrueClass/FalseClass | |
| string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String | str/unicode | string | string | string | String (UTF-8) |
| bytes | May contain any arbitrary sequence of bytes. | string | ByteString | str | []byte | ByteString | string | String (ASCII-8BIT) |