Pages Metadata

Update document metadata.

Changed on

Updates custom metadata fields for a document. Use this to add tags, categories, or other organizational information that helps manage your knowledge base.

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

Request

Path parameters

projectIdinteger required
Example:1

The unique agent id.

pageIdinteger required
Example:1

The unique page id.

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.",
    "summary": "A reserved example domain used for illustration in documentation, which anyone may cite without asking for permission.",
    "image": "https://www.example.com/image.png"
  }
}

Changes

    • warning

      added the new 422.00 enum value to the / response property for the response status

    • warning

      added the new 422.00 enum value to the / response property for the response status

    • warning

      added the new 422.00 enum value to the / response property for the response status

    • warning

      added the new 422.00 enum value to the / response property for the response status

    • info

      added the non-success response with the status

    • info

      added the optional property / to the response with the status

    • info

      endpoint added