Skip to main content
GET
/
v1
/
knowledge-documents
/
{id}
Get knowledge document details
curl --request GET \
  --url https://api.example.com/v1/knowledge-documents/{id} \
  --header 'Authorization: Bearer <token>'
{
  "createdAt": "<string>",
  "id": "<string>",
  "name": "<string>",
  "summary": "<string>",
  "url": "<string>"
}

Authorizations

​
Authorization
string
header
required

API key starting with sk_. Generate one in Settings > API Keys.

Path Parameters

​
id
string
required

Knowledge document ID.

Response

200 - application/json

Default Response

​
createdAt
string
required

ISO 8601 creation date.

​
id
string
required

Unique identifier of the knowledge document.

​
name
string
required

Name of the document.

​
status
enum<string> | null
required

Processing status.

Available options:
pending,
success,
failed
​
summary
string | null
required

Summary of the document content.

​
type
enum<string> | null
required

Document type.

Available options:
text,
url,
file
​
url
string | null
required

Source URL (for URL-type documents).