Skip to main content

Introduction to the Fluence API

The Fluence API provides programmatic access to the decentralized Fluence compute marketplace, allowing developers to find, rent, and manage compute resources without using the web interface, enabling direct integration of Fluence's decentralized compute capabilities into applications and workflows. This document will help you understand how to integrate Fluence's decentralized compute capabilities into your applications and workflows.

info

All API endpoints are available at:

https://api.fluence.dev

API functionality​

The API enables you to:

  1. Search the marketplace - Find compute resources matching specific requirements for CPU, memory, storage, location, and budget
  2. Deploy virtual machines - Create and configure VMs with your choice of operating system and network settings
  3. Manage deployments - View active VMs, modify their configuration, and remove them when no longer needed
  4. Manage personal resources - View and edit SSH keys and other personal resources

Authentication​

The Fluence API uses API keys for authentication. All requests must include your API key in the Authorization header. You can read more about creating and managing API keys in the Fluence Console Settings guide.

Include your API key in the Authorization header with all API requests:

curl -X POST https://api.fluence.dev/vms/v3 \
  -H "Authorization: Bearer <YOUR_API_KEY>"

Request and response format​

The Fluence API accepts and returns data in JSON format. When making POST requests, set the Content-Type header to application/json:

curl -X POST https://api.fluence.dev/marketplace/offers \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <YOUR_API_KEY>" \
  -d '{
    "basicConfiguration": "cpu-4-ram-8gb-storage-25gb"
  }'

Common API endpoints​

The API is organized around these main resource areas:

EndpointDescription
/marketplace/*Endpoints for searching and discovering available compute offerings
/vms/*Endpoints for deploying and managing virtual machines
/ssh_keysEndpoints for managing SSH keys
info

You can find detailed information about all API endpoints in the Fluence API Reference.

API documentation resources​

Swagger UI​

The Fluence API also provides an Swagger UI that allows you to explore and try the API endpoints directly in your browser: https://api.fluence.dev/

API Reference​

The Fluence API also provides an API Reference that provides more technical details on how to use the API: https://api.fluence.dev/docs

Next steps​

Now that you are familiar with the basics of the Fluence API, you can explore the following guides to learn more:

  1. Find compute resources on the Fluence marketplace - Learn how to search for and compare compute offerings that match your requirements
  2. Deploy virtual machines on the Fluence marketplace - Learn how to deploy and configure VMs
  3. Manage your virtual machines on Fluence - Learn how to view, monitor, and delete your VMs