Skip to main content

/content/folders

Learn how to access your folders and their contents in Promptitude's Content Storage using simple API endpoints.

Promptitude Team avatar
Written by Promptitude Team
Updated over a week ago

Promptitude's Content Storage API allows you to retrieve information about your folders and their contents without needing to access the platform directly.

Your Promptitude API key is required to use each endpoint below, this shall be of type Bearer Token.

When to Use Each Endpoint

  • Use Get all folders when you need an overview or are looking for a specific folder

  • Use Get folder contents by ID when you need guaranteed access to a specific folder

  • Use Get folder contents by name when you're working with unique folder names and prefer not to track IDs


Get all folders GET /v1/content/folders

Endpoint URL:

https://api.promptitude.io/v1/content/folders

This endpoint allows you to retrieve all folders available in your account’s Content Storage.

When you call this endpoint, you’ll receive a response with the following structure:

results object properties:

  • foldersCount: the total number of folders in your account.

  • folders: an array containing all folders and their properties.

Example response:

{
"code": 200,
"message": "OK",
"error": false,
"results": {
"foldersCount": 2,
"folders": [
{
"id": "NtTJc7Hiv0SQQlkPxvak",
"name": "recipes",
"contentsCount": 1,
"type": "manual",
"description": "My recipes folder"
}
]
}
}

This is particularly useful when you need to get an overview of your content organization or when you need to find a specific folder's ID to access its contents.


Get folder contents by folder Id GET /v1/content/folders/{folderId}/contents

Endpoint URL:

https://api.promptitude.io/v1/content/folders/{folderId}/contents

This endpoint allows you to retrieve all the contents uploaded to a specific folder, identified by its folderId.

When you call this endpoint, you’ll receive a response with the following structure:

results object properties:

  • contentsCount: the number of contents stored in the folder.

  • contents: an array containing all contents and their properties.

Example response:

{
"code": 200,
"message": "OK",
"error": false,
"results": {
"contentsCount": 3,
"contents": [
{
"id": "NMIzZBc1Zf6P46McVNz6",
"name": "PastaWithTomato.txt",
"fileType": "txt",
"description": "My tomato pasta recipe",
"status": "ready",
"chunksCount": 12,
"creationDate": "2025-10-28T08:22:21.753Z",
"creationUserName": "Promptitude",
"fileUrl": "https://firebasestorage...",
"tags": [
{
"id": "tjdqlazZgqJeWCAYWZzN",
"name": "Pastas"
}
],
"externalId": "PastaWithTomato",
"updatedDate": "2025-10-28T14:30:42.141Z"
}
]
}
}

This endpoint is perfect when you need to find specific content within a folder or when you want to check the status of your uploaded files.

📌 Important: Make sure you include the correct {folderId} in the endpoint URL.


Get folder contents by folder name GET /v1/content/folders/contents?folderName={folderName}

Endpoint URL:

https://api.promptitude.io/v1/content/folders/contents?folderName={folderName}

Use this endpoint to retrieve all contents stored within a specific folder. The folder is identified via the folderName query parameter.

The response will return the folder’s contents with the following structure:

results object properties:

  • contentsCount: the number of contents stored in the folder.

  • contents: an array containing all contents and their properties.

The response will be identical to the one returned by the folder ID endpoint.

📌 Important:

  • The folder name must match exactly, including uppercase and lowercase letters.

  • If multiple folders share the same name, only the first match will be returned.

  • For this reason, using the folder ID method is more reliable if you have folders with identical names.

✅ Best Practices

When working with these endpoints, keep these tips in mind:

  • Keep track of your folder IDs for the most reliable access to your content

  • Use descriptive, unique folder names to avoid confusion when accessing by name

  • Check the contents count before retrieving folder contents to know what to expect

  • Note the status field of content items to ensure they're ready for use

By understanding these simple endpoints, you can efficiently navigate and access your content in Promptitude's Content Storage, making it easier to integrate your stored content into your workflows.

Did this answer your question?