API Introduction & Key Concepts

Understand the fundamental principles behind the Artefacts API.

API

2 min read

API Introduction & Key Concepts
Artefacts API Overview
Pricing
Rate Limiting

Welcome to the introductory guide to the Artefacts API! The API is an integral part of our platform, allowing developers and to harness the full power of Artefacts, integrating it into their applications or automating various tasks. In this section, we'll familiarize you with the core concepts and functionalities of the Artefacts API.

Artefacts API Overview

The Artefacts API is a RESTful API, which means it adheres to the conventions of Representational State Transfer. It uses standard HTTP methods (GET, POST, PUT, DELETE) and returns data in JSON format.

Core functionalities include:

  • Image to 3D (Preview): Create and retrieve Image to 3D Models.

  • Text to 3D(Preview): Create and retrieve Text to 3D Models.

  • Image and Text to 3D (Refine): Create and retrieve a Refined Model

Pricing

Artefacts AI API is a pay-as-you-go service. You need to purchase API usage based on your application's need before using Artefacts API. You can purchase API usage from the Top Up Page on the webapp.

The API pricing is still in beta, and we may change the pricing in the future. If you need more API usage with a lower price, please contact us at hi@artefacts.ai.

API Key Safety

Upon creation, API keys are no longer accessible through the dashboard, so ensure you promptly download and securely store them. It is crucial to maintain their confidentiality, as unauthorized individuals with access can utilize them to interact with the Artefacts API under your account. Should you suspect that your API key has been exposed, you have the option to invalidate it instantly from the dashboard. Once an API key is revoked, it becomes inoperative.

Rate Limiting

To safeguard against misuse that may adversely impact the service quality for all users, Artefacts API enforces a rate limiting mechanism. This restriction is imposed on a per-IP address basis, with a standard limit of 10 requests per second. Should you require an increased rate limit allowance, please contact our team: hi@artefacts.ai

API Introduction & Key Concepts
Artefacts API Overview
Pricing
Rate Limiting

© 2024 Artefacts.Ai, Inc

Designed by Artefacts Studio

© 2024 Artefacts.Ai, Inc

Designed by Artefacts Studio

© 2024 Artefacts.Ai, Inc

Designed by Artefacts Studio