Skip to main content
GET
Get a document

Authorizations

Authorization
string
header
required

Workspace API key (wk_). GET endpoints require the Workspace read API scope, POST endpoints the Workspace write API scope.

Path Parameters

agentId
string
required

The agent id.

docId
string
required

The document id to fetch.

Response

Success. Empty result sets are also 200.

A single document. Unlike the list endpoint, this one runs the payload through redaction, so credential-shaped fields inside data read [redacted].

id
string
required
name
string
required
scope
string
required

"agent", "chat", "trigger", "workspace" or "team".

agentId
string
description
string
isFolder
boolean
parentFolderId
string
hasIndexFile
boolean

Folders only: the folder renders as an app.

mimeType
string
chatId
string

Set when scope is chat.

agentVisibility
string

"hidden", "summary" (default) or "full".

published
boolean
publishOriginalFile
boolean
publishedFileUrl
string
publicPermissions
object
fileUrl
string
fileSize
number

Bytes.

textContent
string

Omitted when excludeContent=true.

textContentLength
number

Characters in textContent, present even without the content.

data
any

Structured payload for data documents. Omitted when excludeContent=true.

dataItemCount
number
dataSchema
string
changedBy
object
changedAt
string

ISO 8601 timestamp.

{key}
any