Skip to main content
GET
/
v2
/
hc-folders
/
public
curl --request GET \
  --url 'https://api-prod.usefini.com/v2/hc-folders/public?botId=4f5ef695-d03b-4d56-8fef-7f2bd5c17ef3' \
  --header 'Authorization: Bearer fini_your_api_key'
Use this route to inspect the current knowledge folders snapshot in the workspace.

Headers

Authorization
string
required
Bearer token containing your Fini workspace API key. Format: Bearer fini_... The key needs read scope.

Query parameters

botId
string
Optional agent ID. When supplied, Fini returns the tree scoped to that agent’s attached folders.
curl --request GET \
  --url 'https://api-prod.usefini.com/v2/hc-folders/public?botId=4f5ef695-d03b-4d56-8fef-7f2bd5c17ef3' \
  --header 'Authorization: Bearer fini_your_api_key'

Response

Returns a knowledge folders snapshot object. See Organize knowledge for the shared snapshot fields.
The workspace-API-key response includes id, createdAt, updatedAt, and snapshotObjV2.

Errors

The API key is missing, malformed, revoked, or invalid.
The API key does not include the read scope.
This usually means the workspace has no folders yet, or no folders attached to the botId you requested.