logo
Feature Endpoint
Brand Voice
GET

/custom/api/fetch/brand/voice/user

Headers

Authorizationrequired
string

Input the Authorization Bearer Token to authorize your API request.

Parameters

nameoptional
string

Brand voice name which is fuzzy matched when searching

start_countoptional
number

Start count of the brand voices for pagination. Minimum value is 1.

end_countoptional
number

End count of the brand voices for pagination. Minimum value is 1.

Response

brand_voice_entries
array

This array contains the list of brand voice objects.

Each brand voice object contains the following properties:

  1. 01.  _id: Brand Voice ID
  2. 02.  unique_id: User unique id
  3. 03.  created_date: Timestamp of creation
  4. 04.  updated_date: Timestamp of last update
  5. 05.  name: Name of the brand voice
  6. 06.  content_policy: Content policy guidelines
  7. 07.  extracted_keywords: Keywords extracted from the content
  8. 08.  writing_guidelines: Writing guidelines for the brand voice
  9. 09.  user_input: Object containing formatting preferences and style settings
  10. 10.  text: Input text for the brand voice
  11. 11.  deleted: Boolean flag indicating if brand voice is deleted
  12. 12.  require_guideline: Boolean flag for guideline requirement
Use _id (Brand Voice ID) in brand_voice attribute when calling the following endpoints:
Use in FactGPT
Use in AutoBlog
total_documents
number

Count of total uploaded brand voices

curl -X 'GET' \
'https://api-az.longshot.ai/custom/api/fetch/brand/voice/user?start_count=1&end_count=10&name=epub' \
-H 'accept: application/json' \
-H 'Authorization: Bearer <API_KEY>'                          
{
  "brand_voice_entries": [
    {
      "_id": "<brand voice id>",
      "created_date": "<timestamp>",
      "updated_date": "<timestamp>",
      "unique_id": "<unique id>",
      "content_policy": "content policy",
      "extracted_keywords": "keywords",
      "writing_guidelines": "guidelines",
      "user_input": {
        "acronym_style": "acronym_in_parentheses",
        "common_acronym": [
          ""
        ],
        "capitalization_nouns": true,
        "capitalization_case": "title case",
        "capitalization_names": true,
        "date_format": "DD/MM/YYYY",
        "currency_format": "symbol-amount",
        "spell_number_start_sentence": true,
        "commas_seperated_number": false,
        "space_between_unit": false,
        "time_format": "AM",
        "spell_timezone": false,
        "emoji": true,
        "punctuation": true,
        "readability_age": "12 years & above",
        "formality": "Casual",
        "tone": "Engaging"
      },
      "name": "<brand voice name>",
      "filename": null,
      "text": "<brand voice input text>",
      "deleted": false,
      "require_guideline": false
    }
  ],
  "total_documents": 10
}