Introduction

API

# Branimo API Documentation

# Endpoint

https://api.branimo.com/getBrand

# Request Description

This endpoint allows you to retrieve brand data based on the provided URL. The request should be sent via an HTTP POST method with the raw request body containing a JSON object with a "url" key.

# Request Body

url (string): The URL for which brand data is to be retrieved.

{
  "url": "https://example.com"
}

# Request Headers

  • APP-ID: [[YOUR-APP-ID]]
  • API-KEY: [[YOUR-API-KEY]]

# Response

The response will have a status code of 200 and a content type of application/json. The response body will contain a JSON object with the following schema: 

{
  "message": "",
  "brand_data": {
    "id": 0,
    "title": "",
    "slogan": "",
    "description": "",
    "primary_color": "",
    "secondary_color": "",
    "address": "",
    "socials": {
      "twitter": "",
      "youtube": "",
      "facebook": "",
      "linkedin": ""
    },
    "logo_url": "",
    "whois_info": "",
    "industry": "",
    "tech_stack": [""],
    "revenue": "",
    "employee_size": "",
    "gpt_company_brief": "",
    "gpt_primary_product": "",
    "gpt_clientele": ""
  }
}

# POST /getPersonalizedContents

This endpoint is used to retrieve personalized contents based on the provided target brand URL and types.

https://api.branimo.com/getPersonalizedContents

# Request Description

Send a POST request with the JSON payload containing the target_brand_url, types, and regenerate keys.

# Request Body 

{
  "target_brand_url": "[[Target Brand URL]]",
  "types": "presentation,email,linkedin",
  "regenerate": false
}

# Request Headers

  • Content-Type: application/json

# Response

The response is returned in JSON format with the following schema: 

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "data": {
      "type": "object",
      "properties": {
        "presentation": {
          "type": "object",
          "properties": {
            "content": {
              "type": "string"
            },
            "version": {
              "type": "string"
            },
            "id": {
              "type": "integer"
            }
          }
        },
        "email": {
          "type": "object",
          "properties": {
            "content": {
              "type": "string"
            },
            "version": {
              "type": "string"
            },
            "id": {
              "type": "integer"
            }
          }
        },
        "linkedin": {
          "type": "object",
          "properties": {
            "content": {
              "type": "string"
            },
            "version": {
              "type": "string"
            },
            "id": {
              "type": "integer"
            }
          }
        }
      }
    },
    "current_balance": {
      "type": "integer"
    }
  }
}