Assistants

List assistant knowledge

Fetch all contents for the organization.

get/orgs/assistants/{assistant_id}/knowledge/contents

Request

  • Base URL: https://api.useinvent.com
  • URL: https://api.useinvent.com/orgs/assistants/{assistant_id}/knowledge/contents
  • Auth: HTTP bearer

Path parameters

assistant_idstring required

The ID of the assistant

Query parameters

searchstring

Filter knowledge contents by title

type'ALL' | 'TEXT' | 'FILE' | 'URL'

Only this kind of content; ALL (default) for every kind.

status'ALL' | 'PENDING' | 'PROCESSING' | 'PROCESSED' | 'FAILED'

Only this indexing status; ALL (default) for every status.

pagenumber

Page number

takenumber

Number of items to take

nextstring

Next page token (Only used on special endpoints)

progressiveboolean

Skip the total count: pagination-count is exact on the last page, and one more than the items so far while more pages exist (Only used on special endpoints)

Response

An array of contents.

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.