v1

latestOpenAPI 3.0.22026-07-174617345.8 KB
Pages Metadata

Get the Metadata for a certain page.

Retrieve the Metadata for a page based on its unique identifier. This endpoint allows you to fetch the metadata associated with a specific page.

get/api/v1/projects/{projectId}/pages/{pageId}/metadata

Path parameters

projectIdinteger required

The unique identifier of the agent (formerly known as project).

pageIdstring required

The unique identifier of the page.

Response

Get the document metadata data for a citation

status'error' | 'success'

The status of the response

Example response

{
  "status": "success",
  "data": {
    "id": 1,
    "url": "https://www.example.com",
    "title": "Example Domain",
    "description": "This domain is for use in illustrative examples in documents. You may use this domain in literature without prior coordination or asking for permission.",
    "image": "https://www.example.com/image.png"
  }
}