Skip to main content
PATCH
/
orgs
/
{org_id}
/
knowledge
/
contents
/
{content_id}
/
url
cURL
curl --request PATCH \
  --url https://api.example.com/orgs/{org_id}/knowledge/contents/{content_id}/url \
  --header 'Content-Type: application/json' \
  --data '
{
  "exclude_path_patterns": [
    "/admin/*",
    "/private/*"
  ],
  "include_path_patterns": [
    "/docs/*",
    "/api/*"
  ]
}
'
{
  "id": "<string>",
  "title": "<string>",
  "type": "TEXT",
  "content": {
    "type": "TEXT",
    "text": "<string>"
  },
  "size": 123,
  "chunks_processed": 123,
  "chunks_count": 123,
  "error": "<string>",
  "status": "PENDING",
  "created_at": "2023-12-25",
  "updated_at": "2023-12-25",
  "parent_content_id": "<string>",
  "children": [
    {
      "id": "<string>",
      "status": "PENDING",
      "title": "<string>",
      "content": {
        "type": "TEXT",
        "text": "<string>"
      },
      "size": 123,
      "chunks_processed": 123,
      "chunks_count": 123,
      "error": "<string>",
      "created_at": "2023-12-25",
      "updated_at": "2023-12-25",
      "parent_content_id": "<string>"
    }
  ]
}

Path Parameters

org_id
string
required
content_id
string
required

Body

Schema for updating a vector

exclude_path_patterns
string[]

Exclude paths patterns

Maximum array length: 256
Maximum string length: 2048
Example:
["/admin/*", "/private/*"]
include_path_patterns
string[]

Include paths patterns

Maximum array length: 256
Maximum string length: 2048
Example:
["/docs/*", "/api/*"]

Response

200 - application/json

Schema for vector content

id
string
required
title
string
required

Title of the vector

type
enum<string>
required

Type of the vector content

Available options:
TEXT,
FILE,
URL
content
object
required

Content configuration schema for different vector input types

size
number
required

Size of the vector in bytes

chunks_processed
number
required

Number of chunks processed for the vector

chunks_count
number
required

Number of chunks in the vector

error
string | null
required

Error message if vector processing failed

status
enum<string>
required

Status of vector processing

Available options:
PENDING,
PROCESSING,
PROCESSED,
FAILED
created_at
string<date> | null
required
updated_at
string<date> | null
required
parent_content_id
string

Parent content ID

children
object[]

Children (for URL crawl parents)