List Documents

GET /documents

Api key

Get all documents

Query parameters

folder_id string

Id of the folder to list documents for.
conversation_id string

Id of the conversation to only list documents the conversation is focused on.
keyword string

Keyword to filter the list to documents that partially match the name.

Responses

200 application/json

OK
Hide response attributes Show response attributes object
- data array[object]
  
  Hide data attributes Show data attributes object
  
  id string
  
  name string
  
  status string
  
  Learning status of the document, Synced means the document has been learned.
  
  Values are syncing, synced, or sync_failed.
  
  content_url string(url)
  
  URL to download the content as html file.
  
  folder_id string
  
  created_at integer(int64)
- meta object
  
  Hide meta attribute Show meta attribute object
  
  pagination object
  
  Hide pagination attributes Show pagination attributes object
  
  count integer
  
  total integer
  
  per_page integer
  
  total_pages integer
  
  next_page integer | null
  
  previous_page integer | null

GET /documents

curl \
 --request GET https://getcody.ai/api/v1/documents \
 --header "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

{
  "data": [
    {
      "id": "string",
      "name": "string",
      "status": "syncing",
      "content_url": "string",
      "folder_id": "string",
      "created_at": 42
    }
  ],
  "meta": {
    "pagination": {
      "count": 42,
      "total": 42,
      "per_page": 42,
      "total_pages": 42,
      "next_page": 42,
      "previous_page": 42
    }
  }
}