Knowledge

Update content URL

Update the URL of an existing content.

patch/orgs/knowledge/contents/{content_id}/url

Request

Base URL: https://api.useinvent.com
URL: https://api.useinvent.com/orgs/knowledge/contents/{content_id}/url
Auth: HTTP bearer

Path parameters

content_idstring required

The ID of the content

Request body

exclude_path_patternsstring[]

URL content, crawl only: skip paths matching these (e.g. '/admin/*').

include_path_patternsstring[]

URL content, crawl only: only follow paths matching these (e.g. '/docs/*').

mode'CRAWL' | 'SINGLE_URL'

Mode of URL content processing

Example request

{
  "exclude_path_patterns": [
    "/admin/*",
    "/private/*"
  ],
  "include_path_patterns": [
    "/docs/*",
    "/api/*"
  ]
}

Response

idstring required

titlestring required

Title of the vector

type'TEXT' | 'FILE' | 'URL' required

Type of the vector content

parent_content_idstring

Parent content ID

sizenumber required

Size of the vector in bytes

chunks_processednumber required

Number of chunks processed for the vector

chunks_countnumber required

Number of chunks in the vector

errorstring nullable required

Error message if vector processing failed

status'PENDING' | 'PROCESSING' | 'PROCESSED' | 'FAILED' required

Status of vector processing

created_atstring date-time nullable required

updated_atstring date-time nullable required

Example response

{
  "content": {
    "file": {
      "file_filename": "document.pdf",
      "file_size": 1024,
      "file_mimetype": "application/pdf"
    }
  },
  "children": [
    {
      "content": {
        "file": {
          "file_filename": "document.pdf",
          "file_size": 1024,
          "file_mimetype": "application/pdf"
        }
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.