Skip to content
Follow yggy on LinkedInFollow @yggy_tech on X

Get document upload configuration

GET
/api/v1/documents/config
curl --request GET \
--url https://api.yggy.tech/api/v1/documents/config \
--header 'Authorization: Bearer <token>'

Returns accepted file extensions, max file size, and other upload constraints. Clients should use this to configure file pickers and validation.

Upload configuration

Media type application/json
object
allowedExtensions
required
Array<string>
maxFileSizeMb
required
number
audio
required
object
enabled
required

True when voice transcription is configured on this deployment

boolean
maxSeconds
required

Longest voice recording accepted, in seconds

integer
dictation
required
object
enabled
required

True when live dictation in yggy notes is available on this deployment

boolean
maxSeconds
required

Longest dictation recording accepted, in seconds. Depends on the speech backend.

integer
Example generated
{
"allowedExtensions": [
"example"
],
"maxFileSizeMb": 1,
"audio": {
"enabled": true,
"maxSeconds": 1
},
"dictation": {
"enabled": true,
"maxSeconds": 1
}
}