Sign in

v1

latestOpenAPI 3.0.22026-07-174617345.8 KB
Pages Metadata

Update metadata for a certain page.

Update the metadata for a specific page identified by its unique pageId. This endpoint allows you to update the associated metadata of the page.

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

Path parameters

projectIdinteger required

The id of an agent (formerly known as project) in which page is stored.

pageIdinteger required

The id of a page in which metadata will be updated.

Request body

titlestring nullable

The title of the document used in citations

urlstring nullable

The url of the document used in citations

descriptionstring nullable

The description of the document used in citations

imagestring nullable

The url of the image used in citations

Example request

{
  "title": "Title",
  "url": "https://example.com/",
  "description": "One to two sentences.",
  "image": "https://example.com/image.png"
}

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"
  }
}