Introduction

Welcome to the Meshy documentation, your comprehensive guide to exploring our powerful API and plugins. Here, you will find detailed information, practical examples, and best practices to help you effectively integrate and utilize our services in your applications.

Overview

The Meshy API is a RESTful API that allows you to programmatically interact with Meshy. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs. You can use it to create and get task results generated by Meshy in your own applications.

You can use the Meshy API in test mode, which doesn't affect your live data or cost your credits. The test mode is enabled when you set the test_mode query parameter to true in your requests for any task generation endpoints.

To get started, you need to know the base URL for the Meshy API endpoints:

https://api.meshy.ai

How to Use These Docs

These docs are designed to help you get started with Meshy as quickly as possible. They cover all the main features of Meshy, and provide detailed information on how to use them.

On the left side of the page, you'll find a sidebar with links to all the main sections of the documentation. You can use this sidebar to navigate to the section you're interested in.

For quick access to a specific page, you can use the search bar at the top, or the search shortcut (Ctrl+K or Cmd+K).

Just Getting Started?

For a quick introduction to using the Meshy API, check out our Quickstart page where you'll find essential information to help you get started with your first API requests and integrations.

Resources

For more information about Meshy's API and plugins, check out the following resources: