curl --request POST \
--url https://app.octavehq.com/api/v2/asset/update \
--header 'Content-Type: application/json' \
--header 'api_key: <api-key>' \
--data '
{
"uuid": "<string>",
"identifier": "<string>",
"description": "<string>",
"entryPoint": "<string>",
"vanitySlug": "<string>"
}
'import requests
url = "https://app.octavehq.com/api/v2/asset/update"
payload = {
"uuid": "<string>",
"identifier": "<string>",
"description": "<string>",
"entryPoint": "<string>",
"vanitySlug": "<string>"
}
headers = {
"api_key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {api_key: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
uuid: '<string>',
identifier: '<string>',
description: '<string>',
entryPoint: '<string>',
vanitySlug: '<string>'
})
};
fetch('https://app.octavehq.com/api/v2/asset/update', 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://app.octavehq.com/api/v2/asset/update",
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([
'uuid' => '<string>',
'identifier' => '<string>',
'description' => '<string>',
'entryPoint' => '<string>',
'vanitySlug' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"api_key: <api-key>"
],
]);
$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://app.octavehq.com/api/v2/asset/update"
payload := strings.NewReader("{\n \"uuid\": \"<string>\",\n \"identifier\": \"<string>\",\n \"description\": \"<string>\",\n \"entryPoint\": \"<string>\",\n \"vanitySlug\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("api_key", "<api-key>")
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://app.octavehq.com/api/v2/asset/update")
.header("api_key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"uuid\": \"<string>\",\n \"identifier\": \"<string>\",\n \"description\": \"<string>\",\n \"entryPoint\": \"<string>\",\n \"vanitySlug\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.octavehq.com/api/v2/asset/update")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["api_key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"uuid\": \"<string>\",\n \"identifier\": \"<string>\",\n \"description\": \"<string>\",\n \"entryPoint\": \"<string>\",\n \"vanitySlug\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"data": {
"uuid": "<string>",
"identifier": "<string>",
"description": "<string>",
"type": "website",
"entryPoint": "<string>",
"storagePath": "<string>",
"currentVersion": 123,
"latestVersion": 123,
"vanitySlug": "<string>",
"vanityUrl": "<string>",
"siteUrl": "<string>",
"previewUrl": "<string>",
"thumbnailUrl": "<string>",
"status": "published",
"privacy": "only_me",
"externallyShared": true,
"openLink": true,
"canEdit": false,
"canManage": false,
"owner": "<string>",
"ownerEmail": null,
"metadata": {
"filesMap": [
{
"filename": "<string>",
"size": 123,
"mimeType": "<string>",
"path": "<string>",
"createdAt": "<string>"
}
],
"siteMap": {
"totalFiles": 123,
"totalSize": 123,
"entryPoint": "<string>",
"root": {
"type": "dir",
"name": "<string>",
"path": "<string>",
"fileCount": 123,
"totalSize": 123,
"children": [
{
"type": "file",
"name": "<string>",
"path": "<string>",
"size": 123,
"mimeType": "<string>",
"isEntryPoint": true
}
]
}
}
},
"skillMetadata": {
"name": "<string>",
"description": "<string>"
},
"createdAt": "<string>",
"updatedAt": "<string>"
}
}{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
}
}Update Asset
Update an asset’s editable fields — any of identifier, description, entry point, privacy, status, and vanitySlug. privacy and status are independent: publishing does NOT make an asset public — set privacy to ‘public’ for that. vanitySlug claims a workspace-unique friendly URL (409 if taken; null clears it). Provide the uuid plus at least one field to change; returns the updated asset.
curl --request POST \
--url https://app.octavehq.com/api/v2/asset/update \
--header 'Content-Type: application/json' \
--header 'api_key: <api-key>' \
--data '
{
"uuid": "<string>",
"identifier": "<string>",
"description": "<string>",
"entryPoint": "<string>",
"vanitySlug": "<string>"
}
'import requests
url = "https://app.octavehq.com/api/v2/asset/update"
payload = {
"uuid": "<string>",
"identifier": "<string>",
"description": "<string>",
"entryPoint": "<string>",
"vanitySlug": "<string>"
}
headers = {
"api_key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {api_key: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
uuid: '<string>',
identifier: '<string>',
description: '<string>',
entryPoint: '<string>',
vanitySlug: '<string>'
})
};
fetch('https://app.octavehq.com/api/v2/asset/update', 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://app.octavehq.com/api/v2/asset/update",
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([
'uuid' => '<string>',
'identifier' => '<string>',
'description' => '<string>',
'entryPoint' => '<string>',
'vanitySlug' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"api_key: <api-key>"
],
]);
$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://app.octavehq.com/api/v2/asset/update"
payload := strings.NewReader("{\n \"uuid\": \"<string>\",\n \"identifier\": \"<string>\",\n \"description\": \"<string>\",\n \"entryPoint\": \"<string>\",\n \"vanitySlug\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("api_key", "<api-key>")
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://app.octavehq.com/api/v2/asset/update")
.header("api_key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"uuid\": \"<string>\",\n \"identifier\": \"<string>\",\n \"description\": \"<string>\",\n \"entryPoint\": \"<string>\",\n \"vanitySlug\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.octavehq.com/api/v2/asset/update")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["api_key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"uuid\": \"<string>\",\n \"identifier\": \"<string>\",\n \"description\": \"<string>\",\n \"entryPoint\": \"<string>\",\n \"vanitySlug\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"data": {
"uuid": "<string>",
"identifier": "<string>",
"description": "<string>",
"type": "website",
"entryPoint": "<string>",
"storagePath": "<string>",
"currentVersion": 123,
"latestVersion": 123,
"vanitySlug": "<string>",
"vanityUrl": "<string>",
"siteUrl": "<string>",
"previewUrl": "<string>",
"thumbnailUrl": "<string>",
"status": "published",
"privacy": "only_me",
"externallyShared": true,
"openLink": true,
"canEdit": false,
"canManage": false,
"owner": "<string>",
"ownerEmail": null,
"metadata": {
"filesMap": [
{
"filename": "<string>",
"size": 123,
"mimeType": "<string>",
"path": "<string>",
"createdAt": "<string>"
}
],
"siteMap": {
"totalFiles": 123,
"totalSize": 123,
"entryPoint": "<string>",
"root": {
"type": "dir",
"name": "<string>",
"path": "<string>",
"fileCount": 123,
"totalSize": 123,
"children": [
{
"type": "file",
"name": "<string>",
"path": "<string>",
"size": 123,
"mimeType": "<string>",
"isEntryPoint": true
}
]
}
}
},
"skillMetadata": {
"name": "<string>",
"description": "<string>"
},
"createdAt": "<string>",
"updatedAt": "<string>"
}
}{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
}
}Authorizations
Body
UUID of the asset to update. e.g. '4f1e2a90-8b3d-4c21-9e07-2a1b3c4d5e6f'
New identifier/slug. e.g. 'q3-launch-microsite'
1 - 255New description. e.g. 'Updated Q3 launch page'
1New entry file served at the root. e.g. 'index.html'
1 - 255New privacy tier — an ordered ladder, each strictly more permissive: only_me (owner only), workspace (owner + workspace members), public (anyone with the URL). e.g. 'public'
only_me, workspace, public New lifecycle status. One of: published, unpublished. Independent of privacy — this does NOT make an asset public or private; use privacy for that. e.g. 'published'
published, unpublished Vanity slug for a friendly URL — unique within the workspace; the server answers 409 (conflict) when another asset already holds it. Setting one gives the asset a vanityUrl; pass null to clear the slug (and its vanityUrl). e.g. 'q3-launch'
1