Skip to content

get Document

GET
/documents/{id}
id
required
string format: uuid

Result

object
id
required
string format: uuid
projectId
required
string format: uuid
nullable
conversationId
required
string format: uuid
nullable
title
required
string
kind
required
string
status
required
string
currentVersion
required
integer format: int32
>= 1 <= 2147483647
versions
required
Array<object>
object
id
required
string format: uuid
version
required
integer format: int32
>= 1 <= 2147483647
content
required
string
sources
required
Array<object>
object
id
required
string
title
required
string
text
required
string
kind
required
string
Allowed values: project legal
versionId
string
locator
string
mimeType
required
string
nullable
structure
required
object
schemaVersion
required
number
Allowed values: 1
blocks
required
Array
<= 5000 items
Any of:
object
id
required
string
>= 1 characters <= 100 characters
type
required
string
Allowed values: paragraph heading bullet
text
required
string
<= 400000 characters
level
integer format: int32
default: 1 >= 1 <= 3

Content-free public error; x-request-id identifies diagnostics

object
type
required
string format: uri
title
required
string
status
required
integer format: int32
>= 400 <= 599
code
required
string
requestId
string
reason
string
Allowed values: monthly_allowance concurrent_assignments
budget
object
monthlyLimit
required
number
nullable
concurrencyLimit
required
number
nullable
allowance
required
number
consumed
required
number
reserved
required
number
available
required
number
active
required
number
concurrency
required
number
resetAt
required
string format: date-time

Content-free public error; x-request-id identifies diagnostics

object
type
required
string format: uri
title
required
string
status
required
integer format: int32
>= 400 <= 599
code
required
string
requestId
string
reason
string
Allowed values: monthly_allowance concurrent_assignments
budget
object
monthlyLimit
required
number
nullable
concurrencyLimit
required
number
nullable
allowance
required
number
consumed
required
number
reserved
required
number
available
required
number
active
required
number
concurrency
required
number
resetAt
required
string format: date-time

Content-free public error; x-request-id identifies diagnostics

object
type
required
string format: uri
title
required
string
status
required
integer format: int32
>= 400 <= 599
code
required
string
requestId
string
reason
string
Allowed values: monthly_allowance concurrent_assignments
budget
object
monthlyLimit
required
number
nullable
concurrencyLimit
required
number
nullable
allowance
required
number
consumed
required
number
reserved
required
number
available
required
number
active
required
number
concurrency
required
number
resetAt
required
string format: date-time

Content-free public error; x-request-id identifies diagnostics

object
type
required
string format: uri
title
required
string
status
required
integer format: int32
>= 400 <= 599
code
required
string
requestId
string
reason
string
Allowed values: monthly_allowance concurrent_assignments
budget
object
monthlyLimit
required
number
nullable
concurrencyLimit
required
number
nullable
allowance
required
number
consumed
required
number
reserved
required
number
available
required
number
active
required
number
concurrency
required
number
resetAt
required
string format: date-time