Getting Started

📖 Introduction

Welcome to the Marvia API, your gateway to seamlessly integrating with the Marvia platform.
This documentation will help you get started quickly with authentication, making requests, and handling responses.

Marvia helps businesses manage and distribute marketing materials with ease. With our API, you can automate workflows, manage templates, retrieve assets, and much more.

🌐 Base URL

All requests must be sent to:

https://api.getmarvia.com/

🔐 Authentication

✅ Supported Methods

Currently, the Marvia API supports Bearer Token Authentication. You must include your token in the Authorization header of your HTTP requests.

Example Header:

Authorization: Bearer YOUR_ACCESS_TOKEN

Replace YOUR_ACCESS_TOKEN with the token provided in your Marvia dashboard or by your administrator.

⚠️ Note: Your API token should be kept secure and never exposed in client-side code.

🛠️ Making Your First API Request

Example Using `curl`

Example Using JavaScript (Fetch API)

📦 Common API Endpoints

🎨 Templates

GET /v1/templates - List all templates.

GET /v1/templates/{id} - Retrieve template details.

🖼️ Assets

GET /v1/assets - List available assets.

POST /v1/assets - Upload a new asset.

👤 Users

GET /v1/users - List users.

GET /v1/users/{id} - Retrieve user details.

⚠️ Error Handling

The Marvia API returns standard HTTP status codes. Example:

200 OK - The request was successful.

400 Bad Request - The request was invalid or missing required parameters.

401 Unauthorized - Missing or invalid authentication token.

404 Not Found - The requested resource was not found.

500 Internal Server Error - Something went wrong on our end.

Example Error Response:

{
  "error": "Unauthorized",
  "message": "Invalid or missing token"
}

📄 Response Example

Successful response when listing assets:

{
  "data": [
    {
      "id": "asset_123",
      "name": "Spring Campaign Banner",
      "type": "image/png",
      "createdAt": "2025-05-15T12:00:00Z"
    },
    {
      "id": "asset_456",
      "name": "Summer Sale Poster",
      "type": "application/pdf",
      "createdAt": "2025-05-10T09:30:00Z"
    }
  ]
}

🎯 Example Use Case: Automating Asset Retrieval

Scenario:

You want to automatically pull the latest marketing assets every morning to update your digital signage.

Example Script (Node.js):

📝 Additional Resources

Full API Documentation

Marvia Support Portal

Marvia Website

API Status Page

📢 Feedback and Contribution

Have suggestions or spotted issues in the API documentation?
Feel free to contact Marvia support or contribute via our feedback form on the Support Portal.

📖 Introduction#

🌐 Base URL#

🔐 Authentication#

✅ Supported Methods#

Example Header:#

🛠️ Making Your First API Request#

Example Using curl#

Example Using JavaScript (Fetch API)#

📦 Common API Endpoints#

🎨 Templates#

🖼️ Assets#

👤 Users#

⚠️ Error Handling#

📄 Response Example#

🎯 Example Use Case: Automating Asset Retrieval#

Scenario:#

Example Script (Node.js):#

📝 Additional Resources#

📢 Feedback and Contribution#