Add Vault Item Field
curl --request POST \
--url https://odyssey.asteroid.ai/agents/v2/vault/items/{itemId}/fields \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--data '
{
"field": {
"label": "<string>",
"required": true,
"hint": "<string>"
},
"value": "<string>"
}
'import requests
url = "https://odyssey.asteroid.ai/agents/v2/vault/items/{itemId}/fields"
payload = {
"field": {
"label": "<string>",
"required": True,
"hint": "<string>"
},
"value": "<string>"
}
headers = {
"X-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
field: {label: '<string>', required: true, hint: '<string>'},
value: '<string>'
})
};
fetch('https://odyssey.asteroid.ai/agents/v2/vault/items/{itemId}/fields', 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://odyssey.asteroid.ai/agents/v2/vault/items/{itemId}/fields",
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([
'field' => [
'label' => '<string>',
'required' => true,
'hint' => '<string>'
],
'value' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-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://odyssey.asteroid.ai/agents/v2/vault/items/{itemId}/fields"
payload := strings.NewReader("{\n \"field\": {\n \"label\": \"<string>\",\n \"required\": true,\n \"hint\": \"<string>\"\n },\n \"value\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-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://odyssey.asteroid.ai/agents/v2/vault/items/{itemId}/fields")
.header("X-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"field\": {\n \"label\": \"<string>\",\n \"required\": true,\n \"hint\": \"<string>\"\n },\n \"value\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://odyssey.asteroid.ai/agents/v2/vault/items/{itemId}/fields")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"field\": {\n \"label\": \"<string>\",\n \"required\": true,\n \"hint\": \"<string>\"\n },\n \"value\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"createdAt": "2023-11-07T05:31:56Z",
"fields": [
{
"key": "<string>",
"label": "<string>",
"required": true,
"type": "username",
"valueUpdatedAt": "2023-11-07T05:31:56Z",
"hint": "<string>",
"legacyName": "<string>",
"readableValue": "<string>"
}
],
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"itemKey": "<string>",
"kind": "login",
"name": "<string>",
"organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"updatedAt": "2023-11-07T05:31:56Z",
"createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"lastRotatedAt": "2023-11-07T05:31:56Z",
"lastRotatedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"lastUsedAt": "2023-11-07T05:31:56Z",
"sourceAgentProfileId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"templateId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}{
"code": 400,
"message": "<string>"
}{
"code": 401,
"message": "<string>"
}{
"code": 403,
"message": "<string>"
}{
"code": 404,
"message": "<string>"
}{
"code": 409,
"message": "<string>"
}{
"code": 500,
"message": "<string>"
}Vault
Add Vault Item Field
POST
/
vault
/
items
/
{itemId}
/
fields
Add Vault Item Field
curl --request POST \
--url https://odyssey.asteroid.ai/agents/v2/vault/items/{itemId}/fields \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--data '
{
"field": {
"label": "<string>",
"required": true,
"hint": "<string>"
},
"value": "<string>"
}
'import requests
url = "https://odyssey.asteroid.ai/agents/v2/vault/items/{itemId}/fields"
payload = {
"field": {
"label": "<string>",
"required": True,
"hint": "<string>"
},
"value": "<string>"
}
headers = {
"X-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
field: {label: '<string>', required: true, hint: '<string>'},
value: '<string>'
})
};
fetch('https://odyssey.asteroid.ai/agents/v2/vault/items/{itemId}/fields', 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://odyssey.asteroid.ai/agents/v2/vault/items/{itemId}/fields",
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([
'field' => [
'label' => '<string>',
'required' => true,
'hint' => '<string>'
],
'value' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-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://odyssey.asteroid.ai/agents/v2/vault/items/{itemId}/fields"
payload := strings.NewReader("{\n \"field\": {\n \"label\": \"<string>\",\n \"required\": true,\n \"hint\": \"<string>\"\n },\n \"value\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-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://odyssey.asteroid.ai/agents/v2/vault/items/{itemId}/fields")
.header("X-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"field\": {\n \"label\": \"<string>\",\n \"required\": true,\n \"hint\": \"<string>\"\n },\n \"value\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://odyssey.asteroid.ai/agents/v2/vault/items/{itemId}/fields")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"field\": {\n \"label\": \"<string>\",\n \"required\": true,\n \"hint\": \"<string>\"\n },\n \"value\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"createdAt": "2023-11-07T05:31:56Z",
"fields": [
{
"key": "<string>",
"label": "<string>",
"required": true,
"type": "username",
"valueUpdatedAt": "2023-11-07T05:31:56Z",
"hint": "<string>",
"legacyName": "<string>",
"readableValue": "<string>"
}
],
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"itemKey": "<string>",
"kind": "login",
"name": "<string>",
"organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"updatedAt": "2023-11-07T05:31:56Z",
"createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"lastRotatedAt": "2023-11-07T05:31:56Z",
"lastRotatedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"lastUsedAt": "2023-11-07T05:31:56Z",
"sourceAgentProfileId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"templateId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}{
"code": 400,
"message": "<string>"
}{
"code": 401,
"message": "<string>"
}{
"code": 403,
"message": "<string>"
}{
"code": 404,
"message": "<string>"
}{
"code": 409,
"message": "<string>"
}{
"code": 500,
"message": "<string>"
}Authorizations
Path Parameters
Body
application/json
Response
The request has succeeded.
A vault item. Secret values live in WorkOS and never appear here.
Show child attributes
Show child attributes
Derived from name: kebab-case. Unique per organisation. Changes when the item is renamed.
Required string length:
1 - 64Pattern:
^[a-z0-9]+(?:-[a-z0-9]+)*$Kind of vault item. Templates and items need at least one field. Completeness is per-field required.
Available options:
login, api_key, card, custom Required string length:
1 - 200Set when this item was mirrored from a legacy agent-profile credentials set. Provenance only; the item is editable in the vault UI.
Template snapshotted at create. Provenance only.

