KnowledgeSourceResponse

Fields

16 fields

canonical_url · required

string

classification · required

string

content_hash

string or null

created_at · required

string (date-time)

external_id

string or null

id · required

string (uuid)

is_archived · required

boolean

last_synced_at

string (date-time) or null

owner_id

string (uuid) or null

project_id · required

string (uuid)

source_type · required

string

storage_path

string or null

sync_error

string or null

sync_status · required

string

title · required

string

updated_at

string (date-time) or null

Raw schema (JSON)

{
  "properties": {
    "canonical_url": {
      "title": "Canonical Url",
      "type": "string"
    },
    "classification": {
      "title": "Classification",
      "type": "string"
    },
    "content_hash": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Content Hash"
    },
    "created_at": {
      "format": "date-time",
      "title": "Created At",
      "type": "string"
    },
    "external_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "External Id"
    },
    "id": {
      "format": "uuid",
      "title": "Id",
      "type": "string"
    },
    "is_archived": {
      "title": "Is Archived",
      "type": "boolean"
    },
    "last_synced_at": {
      "anyOf": [
        {
          "format": "date-time",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Last Synced At"
    },
    "owner_id": {
      "anyOf": [
        {
          "format": "uuid",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Owner Id"
    },
    "project_id": {
      "format": "uuid",
      "title": "Project Id",
      "type": "string"
    },
    "source_type": {
      "title": "Source Type",
      "type": "string"
    },
    "storage_path": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Storage Path"
    },
    "sync_error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Sync Error"
    },
    "sync_status": {
      "title": "Sync Status",
      "type": "string"
    },
    "title": {
      "title": "Title",
      "type": "string"
    },
    "updated_at": {
      "anyOf": [
        {
          "format": "date-time",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Updated At"
    }
  },
  "required": [
    "id",
    "project_id",
    "source_type",
    "title",
    "canonical_url",
    "sync_status",
    "classification",
    "is_archived",
    "created_at"
  ],
  "title": "KnowledgeSourceResponse",
  "type": "object"
}

Used by endpoints

4 endpoints send or return this schema, on its own or inside another schema.

• POST /api/v1/knowledge-sources — Create Knowledge Source
• GET /api/v1/knowledge-sources/{source_id} — Get Knowledge Source
• PATCH /api/v1/knowledge-sources/{source_id} — Update Knowledge Source
• GET /api/v1/knowledge-sources — List Knowledge Sources

Used by schemas

• KnowledgeSourceListResponse

More details

• Specification: OpenAPI JSON