WayloAIWaylo Docs
APIReferenceDocuments

Get a document

GET
/documents/{id}

One document, by id, with its chunk progress.

Access: workspace_viewer · API key documents:read

Authorization

api-key
headerAuthorizationBearer <sk_waylo_<lookup><secret><checksum>>

Path Parameters

id*string

Header Parameters

Authorization*string

Your API key.

Response Body

Success

application/json
  1. response
id*string
workspaceId*string
name*string
description*string|null
active*boolean
filename*string
contentType*string
sizeBytes*number
status*string
Value in"uploaded""processing""ready""failed"
error*string|null
chunkCount*number
embeddedChunkCount*number
createdByUserId*|
Formatuuid
createdByUserName*string|null
updatedByUserId*|
Formatuuid
updatedByUserName*string|null
createdAt*string
Formatdate-time
updatedAt*string
Formatdate-time
Example Request
curl -X GET 'https://api.poc.app.waylovoice.ai/documents/string' \  -H 'Authorization: Bearer sk_waylo_...'
Example Response
{  "id": "string",  "workspaceId": "string",  "name": "string",  "description": "string",  "active": true,  "filename": "string",  "contentType": "string",  "sizeBytes": 0,  "status": "uploaded",  "error": "string",  "chunkCount": 0,  "embeddedChunkCount": 0,  "createdByUserId": "4d2aef9a-17b0-44e6-902e-616812033620",  "createdByUserName": "string",  "updatedByUserId": "b38eaad7-8efa-49e7-b0aa-619916a3821e",  "updatedByUserName": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Download a document GET

The original file, streamed back through the API as an attachment. **Access:** workspace_viewer · API key `documents:read`

List documents GET

Documents in one workspace, offset-paginated, most recently updated first. **Access:** workspace_viewer · API key `documents:read`