Create a Fluid OS widget package version

POST

api

company

fluid_os

widget_package_versions

Create a Fluid OS widget package version

curl --request POST \
  --url https://api.fluid.app/api/company/fluid_os/widget_package_versions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "package_key": "<string>",
  "version": "<string>",
  "builder_version": "<string>",
  "cli_version": "<string>",
  "runtime_version": "<string>",
  "manifest_hash": "<string>",
  "manifest": {},
  "artifacts": [
    {
      "path": "widget.js",
      "contentType": "application/javascript",
      "sha256": "<string>",
      "bytes": 1
    }
  ],
  "build_metadata": {}
}
'

import requests

url = "https://api.fluid.app/api/company/fluid_os/widget_package_versions"

payload = {
    "package_key": "<string>",
    "version": "<string>",
    "builder_version": "<string>",
    "cli_version": "<string>",
    "runtime_version": "<string>",
    "manifest_hash": "<string>",
    "manifest": {},
    "artifacts": [
        {
            "path": "widget.js",
            "contentType": "application/javascript",
            "sha256": "<string>",
            "bytes": 1
        }
    ],
    "build_metadata": {}
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    package_key: '<string>',
    version: '<string>',
    builder_version: '<string>',
    cli_version: '<string>',
    runtime_version: '<string>',
    manifest_hash: '<string>',
    manifest: {},
    artifacts: [
      {
        path: 'widget.js',
        contentType: 'application/javascript',
        sha256: '<string>',
        bytes: 1
      }
    ],
    build_metadata: {}
  })
};

fetch('https://api.fluid.app/api/company/fluid_os/widget_package_versions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.fluid.app/api/company/fluid_os/widget_package_versions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'package_key' => '<string>',
    'version' => '<string>',
    'builder_version' => '<string>',
    'cli_version' => '<string>',
    'runtime_version' => '<string>',
    'manifest_hash' => '<string>',
    'manifest' => [
        
    ],
    'artifacts' => [
        [
                'path' => 'widget.js',
                'contentType' => 'application/javascript',
                'sha256' => '<string>',
                'bytes' => 1
        ]
    ],
    'build_metadata' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api.fluid.app/api/company/fluid_os/widget_package_versions"

	payload := strings.NewReader("{\n  \"package_key\": \"<string>\",\n  \"version\": \"<string>\",\n  \"builder_version\": \"<string>\",\n  \"cli_version\": \"<string>\",\n  \"runtime_version\": \"<string>\",\n  \"manifest_hash\": \"<string>\",\n  \"manifest\": {},\n  \"artifacts\": [\n    {\n      \"path\": \"widget.js\",\n      \"contentType\": \"application/javascript\",\n      \"sha256\": \"<string>\",\n      \"bytes\": 1\n    }\n  ],\n  \"build_metadata\": {}\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.fluid.app/api/company/fluid_os/widget_package_versions")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"package_key\": \"<string>\",\n  \"version\": \"<string>\",\n  \"builder_version\": \"<string>\",\n  \"cli_version\": \"<string>\",\n  \"runtime_version\": \"<string>\",\n  \"manifest_hash\": \"<string>\",\n  \"manifest\": {},\n  \"artifacts\": [\n    {\n      \"path\": \"widget.js\",\n      \"contentType\": \"application/javascript\",\n      \"sha256\": \"<string>\",\n      \"bytes\": 1\n    }\n  ],\n  \"build_metadata\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.fluid.app/api/company/fluid_os/widget_package_versions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"package_key\": \"<string>\",\n  \"version\": \"<string>\",\n  \"builder_version\": \"<string>\",\n  \"cli_version\": \"<string>\",\n  \"runtime_version\": \"<string>\",\n  \"manifest_hash\": \"<string>\",\n  \"manifest\": {},\n  \"artifacts\": [\n    {\n      \"path\": \"widget.js\",\n      \"contentType\": \"application/javascript\",\n      \"sha256\": \"<string>\",\n      \"bytes\": 1\n    }\n  ],\n  \"build_metadata\": {}\n}"

response = http.request(request)
puts response.read_body

{
  "version_id": 123,
  "artifact_base_url": "<string>",
  "uploads": [
    {
      "path": "<string>",
      "upload_url": "<string>",
      "public_url": "<string>"
    }
  ],
  "warnings": [
    {
      "scope": "git_sync",
      "type": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "message": "<string>",
  "error": "<string>",
  "error_message": "<string>",
  "errors": "<string>",
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z"
  }
}

{
  "message": "<string>",
  "error": "<string>",
  "error_message": "<string>",
  "errors": "<string>",
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z"
  }
}

{
  "message": "<string>",
  "error": "<string>",
  "error_message": "<string>",
  "errors": "<string>",
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z"
  }
}

{
  "message": "<string>",
  "error": "<string>",
  "error_message": "<string>",
  "errors": "<string>",
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z"
  }
}

Authorizations

Authorization

string

header

required

Bearer token authentication

Body

application/json

Request payload

package_key

string

required

Non-empty, object-path-safe company-owned widget package key. Use URL-safe characters only; . and .. are not accepted.

Minimum string length: 1

Pattern: ^(?!\.\.?$)[A-Za-z0-9._~-]+$

version

string

required

Non-empty, object-path-safe widget package version identifier accepted in the URL and upload path. Dotted versions such as 1.0.0 are accepted; only exact . or .. path segments and characters outside [A-Za-z0-9._~-] are rejected.

Minimum string length: 1

Pattern: ^(?!\.\.?$)[A-Za-z0-9._~-]+$

builder_version

string

required

Fluid OS builder version that produced this package.

Minimum string length: 1

cli_version

string

required

Fluid OS CLI version that published this package.

Minimum string length: 1

runtime_version

string

required

Fluid OS runtime version targeted by this package.

Minimum string length: 1

manifest_hash

string

required

SHA256 checksum of the serialized manifest JSON.

Minimum string length: 1

manifest

object

required

Widget package manifest JSON. It must use the supported widget manifest structure, contain at least one extractable widget type, and every widget type in that structure must use the company-owned prefix company.<package_key>..

Show child attributes

artifacts

(Widget script artifact · object | Widget manifest artifact · object | Stylesheet artifact · object | Source map artifact · object)[]

required

Top-level package artifacts to upload. The list must include widget.js and manifest.json.

Minimum array length: 2

Artifact metadata required before Fluid OS widget package upload URLs can be issued. Artifact paths must be unique within the request, and the artifact list must include widget.js and manifest.json before upload URLs are issued. Artifact paths are top-level package artifact filenames only; accepted names are widget.js, manifest.json, *.css, and *.js.map with no slash paths. Accepted content types are application/javascript for widget.js, application/json for manifest.json and *.js.map, and text/css for *.css. Byte sizes are non-negative and checked against configured per-artifact and bundle limits; defaults are 5 MiB per artifact and 10 MiB per bundle unless environment config changes them.

Widget script artifact
Widget manifest artifact
Stylesheet artifact
Source map artifact

Show child attributes

build_metadata

object

Optional publisher metadata stored with the package version.

Show child attributes

Response

Created

Upload session details for a pending Fluid OS widget package version.

version_id

integer

required

artifact_base_url

string<uri>

required

uploads

object[]

required

Show child attributes

warnings

object[]

Present when a best-effort side effect of the publish failed — currently only the widget's Git repo provisioning (scope git_sync). The publish itself succeeded, but fluid widget clone will not work until a later publish re-provisions the repo.

Show child attributes

Create a Fluid OS widget package version

curl --request POST \
  --url https://api.fluid.app/api/company/fluid_os/widget_package_versions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "package_key": "<string>",
  "version": "<string>",
  "builder_version": "<string>",
  "cli_version": "<string>",
  "runtime_version": "<string>",
  "manifest_hash": "<string>",
  "manifest": {},
  "artifacts": [
    {
      "path": "widget.js",
      "contentType": "application/javascript",
      "sha256": "<string>",
      "bytes": 1
    }
  ],
  "build_metadata": {}
}
'

import requests

url = "https://api.fluid.app/api/company/fluid_os/widget_package_versions"

payload = {
    "package_key": "<string>",
    "version": "<string>",
    "builder_version": "<string>",
    "cli_version": "<string>",
    "runtime_version": "<string>",
    "manifest_hash": "<string>",
    "manifest": {},
    "artifacts": [
        {
            "path": "widget.js",
            "contentType": "application/javascript",
            "sha256": "<string>",
            "bytes": 1
        }
    ],
    "build_metadata": {}
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    package_key: '<string>',
    version: '<string>',
    builder_version: '<string>',
    cli_version: '<string>',
    runtime_version: '<string>',
    manifest_hash: '<string>',
    manifest: {},
    artifacts: [
      {
        path: 'widget.js',
        contentType: 'application/javascript',
        sha256: '<string>',
        bytes: 1
      }
    ],
    build_metadata: {}
  })
};

fetch('https://api.fluid.app/api/company/fluid_os/widget_package_versions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.fluid.app/api/company/fluid_os/widget_package_versions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'package_key' => '<string>',
    'version' => '<string>',
    'builder_version' => '<string>',
    'cli_version' => '<string>',
    'runtime_version' => '<string>',
    'manifest_hash' => '<string>',
    'manifest' => [
        
    ],
    'artifacts' => [
        [
                'path' => 'widget.js',
                'contentType' => 'application/javascript',
                'sha256' => '<string>',
                'bytes' => 1
        ]
    ],
    'build_metadata' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api.fluid.app/api/company/fluid_os/widget_package_versions"

	payload := strings.NewReader("{\n  \"package_key\": \"<string>\",\n  \"version\": \"<string>\",\n  \"builder_version\": \"<string>\",\n  \"cli_version\": \"<string>\",\n  \"runtime_version\": \"<string>\",\n  \"manifest_hash\": \"<string>\",\n  \"manifest\": {},\n  \"artifacts\": [\n    {\n      \"path\": \"widget.js\",\n      \"contentType\": \"application/javascript\",\n      \"sha256\": \"<string>\",\n      \"bytes\": 1\n    }\n  ],\n  \"build_metadata\": {}\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.fluid.app/api/company/fluid_os/widget_package_versions")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"package_key\": \"<string>\",\n  \"version\": \"<string>\",\n  \"builder_version\": \"<string>\",\n  \"cli_version\": \"<string>\",\n  \"runtime_version\": \"<string>\",\n  \"manifest_hash\": \"<string>\",\n  \"manifest\": {},\n  \"artifacts\": [\n    {\n      \"path\": \"widget.js\",\n      \"contentType\": \"application/javascript\",\n      \"sha256\": \"<string>\",\n      \"bytes\": 1\n    }\n  ],\n  \"build_metadata\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.fluid.app/api/company/fluid_os/widget_package_versions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"package_key\": \"<string>\",\n  \"version\": \"<string>\",\n  \"builder_version\": \"<string>\",\n  \"cli_version\": \"<string>\",\n  \"runtime_version\": \"<string>\",\n  \"manifest_hash\": \"<string>\",\n  \"manifest\": {},\n  \"artifacts\": [\n    {\n      \"path\": \"widget.js\",\n      \"contentType\": \"application/javascript\",\n      \"sha256\": \"<string>\",\n      \"bytes\": 1\n    }\n  ],\n  \"build_metadata\": {}\n}"

response = http.request(request)
puts response.read_body

{
  "version_id": 123,
  "artifact_base_url": "<string>",
  "uploads": [
    {
      "path": "<string>",
      "upload_url": "<string>",
      "public_url": "<string>"
    }
  ],
  "warnings": [
    {
      "scope": "git_sync",
      "type": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "message": "<string>",
  "error": "<string>",
  "error_message": "<string>",
  "errors": "<string>",
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z"
  }
}

{
  "message": "<string>",
  "error": "<string>",
  "error_message": "<string>",
  "errors": "<string>",
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z"
  }
}

{
  "message": "<string>",
  "error": "<string>",
  "error_message": "<string>",
  "errors": "<string>",
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z"
  }
}

{
  "message": "<string>",
  "error": "<string>",
  "error_message": "<string>",
  "errors": "<string>",
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z"
  }
}

Overview

Storefront

Commerce

Checkout

Members

Messaging

People

Payments

DAM

Website

Portal

Content and tools

Analytics

Sales channels

Settings

FairShare SDK

Droplets

Developers

Portal & Widgets

Create a Fluid OS widget package version

Authorizations

Body

Response