Create Vault Share Link
curl --request POST \
--url https://odyssey.asteroid.ai/agents/v2/vault/share-links \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--data '
{
"name": "<string>",
"organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>",
"description": "<string>",
"fields": [
{
"label": "<string>",
"required": true,
"hint": "<string>"
}
],
"steps": [
{
"fieldKeys": [
"<string>"
],
"key": "<string>",
"title": "<string>",
"instructions": "<string>"
}
],
"templateId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'import requests
url = "https://odyssey.asteroid.ai/agents/v2/vault/share-links"
payload = {
"name": "<string>",
"organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>",
"description": "<string>",
"fields": [
{
"label": "<string>",
"required": True,
"hint": "<string>"
}
],
"steps": [
{
"fieldKeys": ["<string>"],
"key": "<string>",
"title": "<string>",
"instructions": "<string>"
}
],
"templateId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
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({
name: '<string>',
organizationId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
title: '<string>',
description: '<string>',
fields: [{label: '<string>', required: true, hint: '<string>'}],
steps: [
{
fieldKeys: ['<string>'],
key: '<string>',
title: '<string>',
instructions: '<string>'
}
],
templateId: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
})
};
fetch('https://odyssey.asteroid.ai/agents/v2/vault/share-links', 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/share-links",
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([
'name' => '<string>',
'organizationId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'title' => '<string>',
'description' => '<string>',
'fields' => [
[
'label' => '<string>',
'required' => true,
'hint' => '<string>'
]
],
'steps' => [
[
'fieldKeys' => [
'<string>'
],
'key' => '<string>',
'title' => '<string>',
'instructions' => '<string>'
]
],
'templateId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]),
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/share-links"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"organizationId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"fields\": [\n {\n \"label\": \"<string>\",\n \"required\": true,\n \"hint\": \"<string>\"\n }\n ],\n \"steps\": [\n {\n \"fieldKeys\": [\n \"<string>\"\n ],\n \"key\": \"<string>\",\n \"title\": \"<string>\",\n \"instructions\": \"<string>\"\n }\n ],\n \"templateId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\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/share-links")
.header("X-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"organizationId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"fields\": [\n {\n \"label\": \"<string>\",\n \"required\": true,\n \"hint\": \"<string>\"\n }\n ],\n \"steps\": [\n {\n \"fieldKeys\": [\n \"<string>\"\n ],\n \"key\": \"<string>\",\n \"title\": \"<string>\",\n \"instructions\": \"<string>\"\n }\n ],\n \"templateId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://odyssey.asteroid.ai/agents/v2/vault/share-links")
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 \"name\": \"<string>\",\n \"organizationId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"fields\": [\n {\n \"label\": \"<string>\",\n \"required\": true,\n \"hint\": \"<string>\"\n }\n ],\n \"steps\": [\n {\n \"fieldKeys\": [\n \"<string>\"\n ],\n \"key\": \"<string>\",\n \"title\": \"<string>\",\n \"instructions\": \"<string>\"\n }\n ],\n \"templateId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"
response = http.request(request)
puts response.read_body{
"link": {
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"expiresAt": "2023-11-07T05:31:56Z",
"failedSubmits": 123,
"fields": [
{
"key": "<string>",
"label": "<string>",
"required": true,
"type": "username",
"hint": "<string>"
}
],
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"itemKey": "<string>",
"kind": "login",
"name": "<string>",
"organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "pending",
"steps": [
{
"fieldKeys": [
"<string>"
],
"key": "<string>",
"title": "<string>",
"instructions": "<string>"
}
],
"title": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"completedAt": "2023-11-07T05:31:56Z",
"description": "<string>",
"lastFailedSubmitAt": "2023-11-07T05:31:56Z",
"resultItemId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"submittedIp": "<string>",
"submittedUserAgent": "<string>",
"templateId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"token": "<string>"
}{
"code": 400,
"message": "<string>"
}{
"code": 401,
"message": "<string>"
}{
"code": 403,
"message": "<string>"
}{
"code": 404,
"message": "<string>"
}{
"code": 409,
"message": "<string>"
}{
"code": 429,
"message": "<string>"
}{
"code": 500,
"message": "<string>"
}Vault
Create Vault Share Link
Create a credential request. The item key is derived from name. 409 when that key is held by an item or reserved by a pending link. 429 when the user exceeds the creation rate limit.
POST
/
vault
/
share-links
Create Vault Share Link
curl --request POST \
--url https://odyssey.asteroid.ai/agents/v2/vault/share-links \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--data '
{
"name": "<string>",
"organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>",
"description": "<string>",
"fields": [
{
"label": "<string>",
"required": true,
"hint": "<string>"
}
],
"steps": [
{
"fieldKeys": [
"<string>"
],
"key": "<string>",
"title": "<string>",
"instructions": "<string>"
}
],
"templateId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'import requests
url = "https://odyssey.asteroid.ai/agents/v2/vault/share-links"
payload = {
"name": "<string>",
"organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>",
"description": "<string>",
"fields": [
{
"label": "<string>",
"required": True,
"hint": "<string>"
}
],
"steps": [
{
"fieldKeys": ["<string>"],
"key": "<string>",
"title": "<string>",
"instructions": "<string>"
}
],
"templateId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
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({
name: '<string>',
organizationId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
title: '<string>',
description: '<string>',
fields: [{label: '<string>', required: true, hint: '<string>'}],
steps: [
{
fieldKeys: ['<string>'],
key: '<string>',
title: '<string>',
instructions: '<string>'
}
],
templateId: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
})
};
fetch('https://odyssey.asteroid.ai/agents/v2/vault/share-links', 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/share-links",
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([
'name' => '<string>',
'organizationId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'title' => '<string>',
'description' => '<string>',
'fields' => [
[
'label' => '<string>',
'required' => true,
'hint' => '<string>'
]
],
'steps' => [
[
'fieldKeys' => [
'<string>'
],
'key' => '<string>',
'title' => '<string>',
'instructions' => '<string>'
]
],
'templateId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]),
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/share-links"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"organizationId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"fields\": [\n {\n \"label\": \"<string>\",\n \"required\": true,\n \"hint\": \"<string>\"\n }\n ],\n \"steps\": [\n {\n \"fieldKeys\": [\n \"<string>\"\n ],\n \"key\": \"<string>\",\n \"title\": \"<string>\",\n \"instructions\": \"<string>\"\n }\n ],\n \"templateId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\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/share-links")
.header("X-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"organizationId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"fields\": [\n {\n \"label\": \"<string>\",\n \"required\": true,\n \"hint\": \"<string>\"\n }\n ],\n \"steps\": [\n {\n \"fieldKeys\": [\n \"<string>\"\n ],\n \"key\": \"<string>\",\n \"title\": \"<string>\",\n \"instructions\": \"<string>\"\n }\n ],\n \"templateId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://odyssey.asteroid.ai/agents/v2/vault/share-links")
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 \"name\": \"<string>\",\n \"organizationId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"fields\": [\n {\n \"label\": \"<string>\",\n \"required\": true,\n \"hint\": \"<string>\"\n }\n ],\n \"steps\": [\n {\n \"fieldKeys\": [\n \"<string>\"\n ],\n \"key\": \"<string>\",\n \"title\": \"<string>\",\n \"instructions\": \"<string>\"\n }\n ],\n \"templateId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"
response = http.request(request)
puts response.read_body{
"link": {
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"expiresAt": "2023-11-07T05:31:56Z",
"failedSubmits": 123,
"fields": [
{
"key": "<string>",
"label": "<string>",
"required": true,
"type": "username",
"hint": "<string>"
}
],
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"itemKey": "<string>",
"kind": "login",
"name": "<string>",
"organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "pending",
"steps": [
{
"fieldKeys": [
"<string>"
],
"key": "<string>",
"title": "<string>",
"instructions": "<string>"
}
],
"title": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"completedAt": "2023-11-07T05:31:56Z",
"description": "<string>",
"lastFailedSubmitAt": "2023-11-07T05:31:56Z",
"resultItemId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"submittedIp": "<string>",
"submittedUserAgent": "<string>",
"templateId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"token": "<string>"
}{
"code": 400,
"message": "<string>"
}{
"code": 401,
"message": "<string>"
}{
"code": 403,
"message": "<string>"
}{
"code": 404,
"message": "<string>"
}{
"code": 409,
"message": "<string>"
}{
"code": 429,
"message": "<string>"
}{
"code": 500,
"message": "<string>"
}Authorizations
Body
application/json
Required string length:
1 - 200Required string length:
1 - 200Maximum string length:
2000Inline field blueprint. Required when templateId is omitted.
Show child attributes
Show child attributes
Required when templateId is omitted.
Available options:
login, api_key, card, custom Inline step layout. Only valid with kind and fields; rejected with templateId.
Maximum array length:
20Show child attributes
Show child attributes
Org template to snapshot. Mutually exclusive with kind and fields.
Response
The request has succeeded and a new resource has been created as a result.

