🎉 vox.ai 디스코드 커뮤니티가 새로 열렸어요! 참여하기 →
지식 베이스
지식 베이스 문서 목록 조회
knowledge base에 연결된 source document 목록을 조회합니다. document type이나 처리 상태는 반복 query parameter로 필터링할 수 있습니다.
GET
/
knowledges
/
{knowledge_id}
/
documents
지식 베이스 문서 목록 조회
curl --request GET \
--url https://client-api.tryvox.co/v3/knowledges/{knowledge_id}/documents \
--header 'Authorization: Bearer <token>'{
"items": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"knowledge_id": 123,
"name": "<string>",
"document_type": "file",
"status": "uploading",
"created_at": 123,
"upload_percentage": 50,
"token_count": 123,
"webpage_urls": [
"<string>"
]
}
],
"total_count": 123,
"next_cursor": "<string>"
}Documentation Index
Fetch the complete documentation index at: https://docs.tryvox.co/llms.txt
Use this file to discover all available pages before exploring further.
Authorizations
조직 API 키를 Authorization: Bearer <token> 형식으로 보냅니다.
Path Parameters
GET /v3/knowledges에서 반환되는 숫자형 public knowledge ID입니다.
Required range:
x >= 1Query Parameters
이전 응답의 next_cursor 값입니다. 다음 페이지를 조회할 때 그대로 전달합니다.
반환할 최대 항목 수입니다. v3 목록 endpoint는 1~100을 허용합니다.
Required range:
1 <= x <= 100정렬 방향입니다. 허용값은 asc, desc입니다.
Available options:
asc, desc document 타입 필터 (복수 반복 가능). 예: ?document_type=file&document_type=text.
Available options:
file, text, webpage 상태 필터입니다. 여러 상태를 지원하는 endpoint에서는 query parameter를 반복해서 전달합니다.
Available options:
uploading, completed, failed Was this page helpful?
Previous
지식 베이스 문서 생성knowledge base 안에 text, webpage, file document를 생성합니다. document는 즉시 반환되며 처리는 비동기로 진행됩니다.
Next
⌘I
지식 베이스 문서 목록 조회
curl --request GET \
--url https://client-api.tryvox.co/v3/knowledges/{knowledge_id}/documents \
--header 'Authorization: Bearer <token>'{
"items": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"knowledge_id": 123,
"name": "<string>",
"document_type": "file",
"status": "uploading",
"created_at": 123,
"upload_percentage": 50,
"token_count": 123,
"webpage_urls": [
"<string>"
]
}
],
"total_count": 123,
"next_cursor": "<string>"
}