Citations
List citations
Returns every citation collected across the active project. The response is paginated, with the newest citations returned first by default.
/api/v1/citations
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
| page | integer | Optional | The page number to return. Defaults to |
| per_page | integer | Optional | The number of items per page. Defaults to |
| response_id | integer | Optional | Limit results to citations belonging to a single response. |
| sort_by | string | Optional | The column to sort by. Defaults to |
| sort_order | string | Optional | The direction to sort by. Each endpoint has its own default. |
| include | string | Optional | A comma-separated list of related resources to include in the response. Allowed values: |
Response
Response schema
| Field | Type | Description |
|---|---|---|
| data | Citation[] | |
| links | PaginationLinks | |
| meta | PaginationMeta |
The citation object
| Field | Type | Description |
|---|---|---|
| id | integer | The unique ID of the citation. |
| url | string | The URL that the AI engine cited. |
| title | string | The title of the cited page, if known. |
| description | string | A short description of the cited page, if known. |
| domain | string | The domain of the source that this citation belongs to. |
| position | integer | The one-indexed order in which the citation appeared in the response. A position of |
| created_at | datetime | When the citation was recorded. |
| updated_at | datetime | When the citation was last updated. |