dreamflare-icon

DreamFlare

API

Welcome to the DreamFlare Cloud API documentation. Our APIs provides powerful tools to interact with your AI-generated content stored in our cloud. You can perform a variety of operations, from uploading and managing content to retrieving analytics and collaboration details. We are excited to announce that we will soon provide an DreamFlare SDK for developers to further simplify integration with our services.

Base Endpoint: https://api.dreamflare.cloud/

API Endpoints

1. Upload Content

  • Endpoint: /upload
  • Method: POST
  • Description: Upload AI-generated images or videos to your DreamFlare Cloud account.
  • Parameters:
  • file: (required) The content file to be uploaded.
  • description: (optional) A description of the uploaded content.
  • tags: (optional) Comma-separated tags for categorizing the content.
  • userId: (required) The ID of the user uploading the content.

2. Get Content

  • Endpoint: /content/{contentId}
  • Method: GET
  • Description: Retrieve information about a specific content item.
  • Parameters:
  • contentId: (required) The ID of the content to retrieve.
  • userId: (required) The ID of the user requesting the content.

3. Delete Content

  • Endpoint: /content/{contentId}
  • Method: DELETE
  • Description: Delete a specific content item from your account.
  • Parameters:
  • contentId: (required) The ID of the content to delete.
  • userId: (required) The ID of the user deleting the content.

4. List Content

  • Endpoint: /content/list
  • Method: GET
  • Description: List all content items in your account.
  • Parameters:
  • userId: (required) The ID of the user listing the content.
  • limit: (optional) Number of content items to retrieve.
  • offset: (optional) Offset for pagination.

5. Update Content Metadata

  • Endpoint: /content/{contentId}/metadata
  • Method: PUT
  • Description: Update metadata for a specific content item.
  • Parameters:
  • contentId: (required) The ID of the content to update.
  • userId: (required) The ID of the user updating the content.
  • description: (optional) New description for the content.
  • tags: (optional) New comma-separated tags for the content.

6. Get Storage Usage

  • Endpoint: /storage/usage
  • Method: GET
  • Description: Retrieve the storage usage for your account.
  • Parameters:
  • userId: (required) The ID of the user requesting the storage usage.

7. Get API Usage

  • Endpoint: /api/usage
  • Method: GET
  • Description: Retrieve API usage statistics for your account.
  • Parameters:
  • userId: (required) The ID of the user requesting the API usage.

8. Generate API Key

  • Endpoint: /api/key/generate
  • Method: POST
  • Description: Generate a new API key for your account.
  • Parameters:
  • userId: (required) The ID of the user generating the API key.
  • description: (optional) A description for the new API key.

9. Revoke API Key

  • Endpoint: /api/key/{keyId}/revoke
  • Method: DELETE
  • Description: Revoke a specific API key.
  • Parameters:
  • keyId: (required) The ID of the API key to revoke.
  • userId: (required) The ID of the user revoking the API key.

10. Get Analytics

  • Endpoint: /analytics
  • Method: GET
  • Description: Retrieve analytics data for your content.
  • Parameters:
  • userId: (required) The ID of the user requesting analytics.
  • contentId: (optional) The ID of the specific content to retrieve analytics for.

11. Create Collaboration

  • Endpoint: /collaboration/create
  • Method: POST
  • Description: Create a new collaboration on a content item.
  • Parameters:
  • userId: (required) The ID of the user creating the collaboration.
  • contentId: (required) The ID of the content to collaborate on.
  • collaboratorId: (required) The ID of the collaborator.
  • permissions: (optional) Permissions for the collaborator (read/write).

12. List Collaborations

  • Endpoint: /collaboration/list
  • Method: GET
  • Description: List all collaborations for your account.
  • Parameters:
  • userId: (required) The ID of the user listing collaborations.

13. Update Collaboration

  • Endpoint: /collaboration/{collaborationId}
  • Method: PUT
  • Description: Update the details of a specific collaboration.
  • Parameters:
  • collaborationId: (required) The ID of the collaboration to update.
  • userId: (required) The ID of the user updating the collaboration.
  • permissions: (optional) New permissions for the collaborator (read/write).

14. Delete Collaboration

  • Endpoint: /collaboration/{collaborationId}
  • Method: DELETE
  • Description: Delete a specific collaboration.
  • Parameters:
  • collaborationId: (required) The ID of the collaboration to delete.
  • userId: (required) The ID of the user deleting the collaboration.

15. Get Content Versions

  • Endpoint: /content/{contentId}/versions
  • Method: GET
  • Description: Retrieve the version history of a specific content item.
  • Parameters:
  • contentId: (required) The ID of the content to retrieve versions for.
  • userId: (required) The ID of the user requesting versions.

Stay tuned for our upcoming SDK, which will make integrating with DreamFlare Cloud even easier for developers. Thank you for choosing DreamFlare Cloud for your AI-generated content storage needs!