Skip to main content
GET
/
brand-voices
List brand voices
curl --request GET \
  --url https://app.mavera.io/api/v1/brand-voices \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "label": "<string>",
      "usage_context": "<string>",
      "error": "<string>",
      "voice_summary": "<string>",
      "tone": {
        "adjectives": [
          "<string>"
        ],
        "dos": [
          "<string>"
        ],
        "donts": [
          "<string>"
        ]
      },
      "writing_style": {
        "sentence_structure": "<string>",
        "jargon_usage": "<string>"
      },
      "vocabulary": {
        "preferred_terms": [
          "<string>"
        ],
        "avoid_terms": [
          "<string>"
        ]
      },
      "example_phrases": [
        {
          "use_case": "<string>",
          "example": "<string>"
        }
      ],
      "sources": {
        "urls": [
          {
            "id": "<string>",
            "url": "<string>",
            "name": "<string>",
            "description": "<string>"
          }
        ],
        "documents": [
          {
            "id": "<string>",
            "name": "<string>",
            "description": "<string>",
            "file_type": "<string>",
            "file_size": 123
          }
        ]
      },
      "workspace_id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "has_more": true,
  "next_cursor": "<string>"
}

Authorizations

​
Authorization
string
header
required

API key prefixed with mvra_live_. Create keys at Settings > Developer > API Keys.

Query Parameters

​
workspace_id
string

Filter by workspace

​
status
enum<string>

Filter by status

Available options:
pending,
generating,
completed,
failed
​
search
string

Search by label

​
limit
integer
default:50

Maximum number of results (default 50, max 100)

Required range: 1 <= x <= 100
​
cursor
string

Cursor for pagination

Response

List of brand voices

​
object
enum<string>
Available options:
list
​
data
object[]
​
has_more
boolean

Whether there are more results available

​
next_cursor
string | null

Cursor to use for fetching the next page