Spacely AI Enterprise Old
  • Introduction
    • Overview
    • Getting Started
    • Authentication
    • Rate Limiting
  • API Endpoints
    • GET Resources
    • POST Generate Standard
    • POST Generate Advance
    • POST Generate Style Transfer
    • GET Polling Data
  • Furniture Partnership
    • How can you link your products to Spacely AI?
    • Option 1 : CSV file with image directories
    • Option 2 : CSV file with image urls
    • An example of furniture images
  • Learn More
    • FAQs
    • Support
Powered by GitBook
On this page
  • Endpoint
  • Example

Was this helpful?

  1. API Endpoints

POST Generate Standard

Generate unlimited space designs.

Endpoint

POST https://api.spacely.ai/api/v1/generate/standard

This endpoint is used to standard generate

Headers

Name
Type
Description

X-API-KEY*

String

Request Body

Name
Type
Description

model*

String

The model name of the project.

(e.g., "spacely-v1", "spacely-unfurnished-space", "spacely-style-transfer").

imageUrl*

String

The URL of the image representing the room or space to be designed/renovated.

spaceType*

String

The type of the space (e.g., "bedroom", "living_room", "kitchen", etc.).

spaceStyle*

String

The style of the space (e.g., "modern", "minimalist", "industrial_loft", etc.).

spaceColor

String

The primary color theme or set used in the space (optional).

(e.g., "set_1", "set_2", "set_3", etc.)

styleUrl

String

The URL pointing to additional references or inspirations for the design

materialsIds

String[]

An array of material IDs representing the materials used in the project (e.g., "paper_wallpaper", "particle_board", "porcelain_tile", etc.).

renovateType*

String

The type of renovation, whether "residential", "commercial" or "exterior"

{
  "data": "ea6abee1-ed4b-4ca8-0000-2c215150bf9e"
}

Example

curl --location 'https://api.spacely.ai/api/v1/generate/standard' \
--header 'X-API-KEY: YOUR_X_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
    "model": "spacely-v1",
    "imageUrl": IMAGE_URL,
    "spaceType": "bedroom",
    "spaceStyle": "modern",
    "spaceColor": "",
    "renovateType": "residential",
    "styleUrl": "",
    "materialsIds": [
        "paper_wallpaper",
        "particle_board",
        "porceline_tile"
    ]
}'
var myHeaders = new Headers();
myHeaders.append("X-API-KEY", YOUR_X_API_KEY);
myHeaders.append("Content-Type", "application/json");

var raw = JSON.stringify({
  "model": "spacely-v1",
  "imageUrl": IMAGE_URL,
  "spaceType": "bedroom",
  "spaceStyle": "modern",
  "spaceColor": "",
  "renovateType": "residential",
  "styleUrl": "",
  "materialsIds": [
    "paper_wallpaper",
    "particle_board",
    "porceline_tile"
  ]
});

var requestOptions = {
  method: 'POST',
  headers: myHeaders,
  body: raw,
  redirect: 'follow'
};

fetch("https://api.spacely.ai/api/v1/generate/standard", requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));
const axios = require('axios');
let data = JSON.stringify({
  "model": "spacely-v1",
  "imageUrl": IMAGE_URL,
  "spaceType": "bedroom",
  "spaceStyle": "modern",
  "spaceColor": "",
  "renovateType": "residential",
  "styleUrl": "",
  "materialsIds": [
    "paper_wallpaper",
    "particle_board",
    "porceline_tile"
  ]
});

let config = {
  method: 'post',
  maxBodyLength: Infinity,
  url: 'https://api.spacely.ai/api/v1/generate/standard',
  headers: { 
    'X-API-KEY': YOUR_X_API_KEY, 
    'Content-Type': 'application/json'
  },
  data : data
};

axios.request(config)
.then((response) => {
  console.log(JSON.stringify(response.data));
})
.catch((error) => {
  console.log(error);
});
package main

import (
  "fmt"
  "strings"
  "net/http"
  "io/ioutil"
)

func main() {

  url := "https://api.spacely.ai/api/v1/generate/standard"
  method := "POST"

  payload := strings.NewReader(`{
    "model": "spacely-v1",
    "imageUrl": IMAGE_URL
    "spaceType": "bedroom",
    "spaceStyle": "modern",
    "spaceColor": "",
    "renovateType": "residential",
    "styleUrl": "",
    "materialsIds": [
        "paper_wallpaper",
        "particle_board",
        "porceline_tile"
    ]
}`)

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, payload)

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("X-API-KEY", YOUR_API_KEY)
  req.Header.Add("Content-Type", "application/json")

  res, err := client.Do(req)
  if err != nil {
    fmt.Println(err)
    return
  }
  defer res.Body.Close()

  body, err := ioutil.ReadAll(res.Body)
  if err != nil {
    fmt.Println(err)
    return
  }
  fmt.Println(string(body))
}
import requests
import json

url = "https://api.spacely.ai/api/v1/generate/standard"

payload = json.dumps({
  "model": "spacely-v1",
  "imageUrl": IMAGE_URL
  "spaceType": "bedroom",
  "spaceStyle": "modern",
  "spaceColor": "",
  "renovateType": "residential",
  "styleUrl": "",
  "materialsIds": [
    "paper_wallpaper",
    "particle_board",
    "porceline_tile"
  ]
})
headers = {
  'X-API-KEY': YOUR_API_KEY,
  'Content-Type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)
PreviousGET ResourcesNextPOST Generate Advance

Last updated 1 year ago

Was this helpful?

(e.g., "").

https://storage.googleapis.com/spacely/public/image/roomstyle3/bathroom-modern.jpg