Documentation
Search
K
Comment on page

Get collections

A quick guide on how to get collections via API
In order to get collections via API, a user needs to get the process_id from one of the following places:
  • Get processes endpoint
  • Create process endpoint
  • URL e.g. https://workspace.alphamoon.ai/queue/2080d36bf94c4147b2e543104342fc2f

Get collections endpoint

The following endpoint returns the list of collections along with collection_ids:
get
/
api/v0.3/processes/{process_id}/collections
Get collections
API call
Server response
curl -X 'GET' \
'https://workspace.alphamoon.ai/api/v0.3/processes/93580f176efb48cda64f25cba74d8ca4/collections?offset=0&limit=100&order=created_date%3Adesc' \
-H 'accept: application/json' \
-H 'Authorization: Basic API_KEY_BASE64_ENCODED'
{
"collections": [
{
"id": "5c8c5791635c44c4b74e08fd5e79163c",
"name": "Invoice example.pdf",
"files": [
{
"id": "b59ef112be5641cdadf9f9e81a13f0d6",
"collectionId": "5c8c5791635c44c4b74e08fd5e79163c",
"name": "Invoice example.pdf",
"status": "Needs Review",
"progress": 100,
"numberOfPages": 1,
"createdAt": "2023-07-13T12:16:33Z",
"updatedAt": "2023-07-13T12:16:48Z",
"metadata": {}
}
],
"priority": false,
"split": false,
"status": "Needs Review",
"progress": 100,
"numberOfPages": 1,
"processId": "93580f176efb48cda64f25cba74d8ca4",
"createdAt": "2023-07-13T12:16:33Z",
"updatedAt": "2023-07-13T12:16:48Z",
"metadata": {}
}
],
"pagination": {
"offset": 0,
"limit": 100,
"total": 1
}
}
:

See next: