List files in a batch | Instabase AI Hub Documentation

curl "${API_ROOT}/v2/batches/<BATCH-ID>/files" \
  -H "Authorization: Bearer ${API_TOKEN}" \
  -H "IB-Context: ${IB_CONTEXT}"

{
  "nodes": [
    {
      "full_path": "/path/to/document1.pdf",
      "metadata": {
        "node_type": "file",
        "size": 1024,
        "modified_timestamp": 1647532800
      },
      "perms": {
        "can_read": true,
        "can_write": true,
        "can_delete": true
      },
      "name": "document1.pdf"
    },
    {
      "full_path": "/path/to/document2.pdf",
      "metadata": {
        "node_type": "file",
        "size": 2048,
        "modified_timestamp": 1647619200
      },
      "perms": {
        "can_read": true,
        "can_write": false,
        "can_delete": false
      },
      "name": "document2.pdf"
    }
  ],
  "next_page_token": "eyJwYWdlIjogMn0=",
  "has_more": true
}

Return a list of files in a batch.

Authentication

AuthorizationBearer

Bearer HTTP authentication.

Path parameters

batch_idintegerRequired

The batch ID.

Query parameters

page_sizeintegerOptional

The number of files to return in each page.

start_tokenstringOptional

The token to start the list from.

Response

Request successful.

nodeslist of objects

List of files in the batch.

next_page_tokenstring

Token for retrieving the next page of results.

has_moreboolean

Indicates whether there are more files to be retrieved.

Errors

404

Not Found Error

Authentication

Path parameters

Headers

Query parameters

Response

Errors