Update Attribute

curl --request PATCH \
  --url https://api.aspect.inc/metadata/attributes/{attribute_id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "options": [
    {
      "label": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "color": "<string>",
      "archived": false
    }
  ],
  "category": "<string>",
  "generation_config": {
    "prompt": "<string>",
    "input_sources": [],
    "watch": {
      "resource_ids": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "asset_types": []
    }
  }
}
'

import requests

url = "https://api.aspect.inc/metadata/attributes/{attribute_id}"

payload = {
    "name": "<string>",
    "options": [
        {
            "label": "<string>",
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "color": "<string>",
            "archived": False
        }
    ],
    "category": "<string>",
    "generation_config": {
        "prompt": "<string>",
        "input_sources": [],
        "watch": {
            "resource_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
            "asset_types": []
        }
    }
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    options: [
      {
        label: '<string>',
        id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        color: '<string>',
        archived: false
      }
    ],
    category: '<string>',
    generation_config: {
      prompt: '<string>',
      input_sources: [],
      watch: {resource_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'], asset_types: []}
    }
  })
};

fetch('https://api.aspect.inc/metadata/attributes/{attribute_id}', 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.aspect.inc/metadata/attributes/{attribute_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'options' => [
        [
                'label' => '<string>',
                'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
                'color' => '<string>',
                'archived' => false
        ]
    ],
    'category' => '<string>',
    'generation_config' => [
        'prompt' => '<string>',
        'input_sources' => [
                
        ],
        'watch' => [
                'resource_ids' => [
                                '3c90c3cc-0d44-4b50-8888-8dd25736052a'
                ],
                'asset_types' => [
                                
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "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.aspect.inc/metadata/attributes/{attribute_id}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"options\": [\n    {\n      \"label\": \"<string>\",\n      \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"color\": \"<string>\",\n      \"archived\": false\n    }\n  ],\n  \"category\": \"<string>\",\n  \"generation_config\": {\n    \"prompt\": \"<string>\",\n    \"input_sources\": [],\n    \"watch\": {\n      \"resource_ids\": [\n        \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n      ],\n      \"asset_types\": []\n    }\n  }\n}")

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

	req.Header.Add("Authorization", "<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.patch("https://api.aspect.inc/metadata/attributes/{attribute_id}")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"options\": [\n    {\n      \"label\": \"<string>\",\n      \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"color\": \"<string>\",\n      \"archived\": false\n    }\n  ],\n  \"category\": \"<string>\",\n  \"generation_config\": {\n    \"prompt\": \"<string>\",\n    \"input_sources\": [],\n    \"watch\": {\n      \"resource_ids\": [\n        \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n      ],\n      \"asset_types\": []\n    }\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.aspect.inc/metadata/attributes/{attribute_id}")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"options\": [\n    {\n      \"label\": \"<string>\",\n      \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"color\": \"<string>\",\n      \"archived\": false\n    }\n  ],\n  \"category\": \"<string>\",\n  \"generation_config\": {\n    \"prompt\": \"<string>\",\n    \"input_sources\": [],\n    \"watch\": {\n      \"resource_ids\": [\n        \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n      ],\n      \"asset_types\": []\n    }\n  }\n}"

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "data_type": "string",
  "source": "system",
  "is_filterable": true,
  "is_displayable": true,
  "is_editable": true,
  "is_sortable": true,
  "created": "2023-11-07T05:31:56Z",
  "updated": "2023-11-07T05:31:56Z",
  "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "options": [
    {
      "label": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "color": "<string>",
      "archived": false
    }
  ],
  "category": "<string>",
  "asset_column": "<string>",
  "generation_config": {
    "prompt": "<string>",
    "input_sources": [
      "transcript"
    ],
    "watch": {
      "resource_ids": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "asset_types": [
        "video"
      ]
    }
  },
  "created_by_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

PATCH

metadata

attributes

{attribute_id}

Update Attribute

curl --request PATCH \
  --url https://api.aspect.inc/metadata/attributes/{attribute_id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "options": [
    {
      "label": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "color": "<string>",
      "archived": false
    }
  ],
  "category": "<string>",
  "generation_config": {
    "prompt": "<string>",
    "input_sources": [],
    "watch": {
      "resource_ids": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "asset_types": []
    }
  }
}
'

import requests

url = "https://api.aspect.inc/metadata/attributes/{attribute_id}"

payload = {
    "name": "<string>",
    "options": [
        {
            "label": "<string>",
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "color": "<string>",
            "archived": False
        }
    ],
    "category": "<string>",
    "generation_config": {
        "prompt": "<string>",
        "input_sources": [],
        "watch": {
            "resource_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
            "asset_types": []
        }
    }
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    options: [
      {
        label: '<string>',
        id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        color: '<string>',
        archived: false
      }
    ],
    category: '<string>',
    generation_config: {
      prompt: '<string>',
      input_sources: [],
      watch: {resource_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'], asset_types: []}
    }
  })
};

fetch('https://api.aspect.inc/metadata/attributes/{attribute_id}', 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.aspect.inc/metadata/attributes/{attribute_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'options' => [
        [
                'label' => '<string>',
                'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
                'color' => '<string>',
                'archived' => false
        ]
    ],
    'category' => '<string>',
    'generation_config' => [
        'prompt' => '<string>',
        'input_sources' => [
                
        ],
        'watch' => [
                'resource_ids' => [
                                '3c90c3cc-0d44-4b50-8888-8dd25736052a'
                ],
                'asset_types' => [
                                
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "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.aspect.inc/metadata/attributes/{attribute_id}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"options\": [\n    {\n      \"label\": \"<string>\",\n      \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"color\": \"<string>\",\n      \"archived\": false\n    }\n  ],\n  \"category\": \"<string>\",\n  \"generation_config\": {\n    \"prompt\": \"<string>\",\n    \"input_sources\": [],\n    \"watch\": {\n      \"resource_ids\": [\n        \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n      ],\n      \"asset_types\": []\n    }\n  }\n}")

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

	req.Header.Add("Authorization", "<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.patch("https://api.aspect.inc/metadata/attributes/{attribute_id}")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"options\": [\n    {\n      \"label\": \"<string>\",\n      \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"color\": \"<string>\",\n      \"archived\": false\n    }\n  ],\n  \"category\": \"<string>\",\n  \"generation_config\": {\n    \"prompt\": \"<string>\",\n    \"input_sources\": [],\n    \"watch\": {\n      \"resource_ids\": [\n        \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n      ],\n      \"asset_types\": []\n    }\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.aspect.inc/metadata/attributes/{attribute_id}")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"options\": [\n    {\n      \"label\": \"<string>\",\n      \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"color\": \"<string>\",\n      \"archived\": false\n    }\n  ],\n  \"category\": \"<string>\",\n  \"generation_config\": {\n    \"prompt\": \"<string>\",\n    \"input_sources\": [],\n    \"watch\": {\n      \"resource_ids\": [\n        \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n      ],\n      \"asset_types\": []\n    }\n  }\n}"

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "data_type": "string",
  "source": "system",
  "is_filterable": true,
  "is_displayable": true,
  "is_editable": true,
  "is_sortable": true,
  "created": "2023-11-07T05:31:56Z",
  "updated": "2023-11-07T05:31:56Z",
  "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "options": [
    {
      "label": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "color": "<string>",
      "archived": false
    }
  ],
  "category": "<string>",
  "asset_column": "<string>",
  "generation_config": {
    "prompt": "<string>",
    "input_sources": [
      "transcript"
    ],
    "watch": {
      "resource_ids": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "asset_types": [
        "video"
      ]
    }
  },
  "created_by_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

Aspect API key (sk_...) in Authorization header. 'Bearer ' optional.

Path Parameters

attribute_id

string<uuid>

required

Attribute ID

Body

application/json

API request schema for updating a metadata attribute. Omitted and null fields are untouched, except generation_config: null turns generation off.

name

string | null

Human-readable name, unique per project

Maximum string length: 255

options

SelectOption · object[] | null

For select types only

Show child attributes

Response

Successful Response

API response schema for metadata attribute.

string<uuid>

required

Unique identifier for this attribute

name

string

required

Human-readable display name

data_type

enum<string>

required

Type of value this attribute holds

Available options:

string,

integer,

float,

boolean,

datetime,

single_select,

multi_select,

user_id,

person_id,

object_id,

directory_id

source

enum<string>

required

Whether attribute is system-defined or user-created

Available options:

system,

user,

asset

is_filterable

boolean

required

Whether this attribute can be used in filters

is_displayable

boolean

required

Whether this attribute can be shown in generic metadata display UI

is_editable

boolean

required

Whether values for this attribute can be edited through metadata APIs

is_sortable

boolean

required

Whether assets can be sorted by this attribute

created

string<date-time>

required

When the attribute was created

updated

string<date-time>

required

When the attribute was last updated

project_id

string<uuid> | null

Project ID for project-specific attributes, null for system global

options

SelectOption · object[] | null

Available options for select types

Show child attributes

API Reference

API Endpoints

Update Attribute

Authorizations

Path Parameters

Body

Response