cURL
curl --request POST \
--url https://api.useanima.sh/v1/vault/credentials/{id}/use \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"url": "<string>",
"agentId": "<string>",
"headers": {},
"body": "<string>"
}
'import requests
url = "https://api.useanima.sh/v1/vault/credentials/{id}/use"
payload = {
"url": "<string>",
"agentId": "<string>",
"headers": {},
"body": "<string>"
}
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({
url: '<string>',
agentId: '<string>',
headers: {},
body: JSON.stringify('<string>')
})
};
fetch('https://api.useanima.sh/v1/vault/credentials/{id}/use', 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.useanima.sh/v1/vault/credentials/{id}/use",
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([
'url' => '<string>',
'agentId' => '<string>',
'headers' => [
],
'body' => '<string>'
]),
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.useanima.sh/v1/vault/credentials/{id}/use"
payload := strings.NewReader("{\n \"url\": \"<string>\",\n \"agentId\": \"<string>\",\n \"headers\": {},\n \"body\": \"<string>\"\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.useanima.sh/v1/vault/credentials/{id}/use")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"url\": \"<string>\",\n \"agentId\": \"<string>\",\n \"headers\": {},\n \"body\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.useanima.sh/v1/vault/credentials/{id}/use")
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 \"url\": \"<string>\",\n \"agentId\": \"<string>\",\n \"headers\": {},\n \"body\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"status": 123,
"headers": {},
"body": "<string>",
"truncated": true
}API Reference
Post vaultcredentials use
POST
/
vault
/
credentials
/
{id}
/
use
cURL
curl --request POST \
--url https://api.useanima.sh/v1/vault/credentials/{id}/use \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"url": "<string>",
"agentId": "<string>",
"headers": {},
"body": "<string>"
}
'import requests
url = "https://api.useanima.sh/v1/vault/credentials/{id}/use"
payload = {
"url": "<string>",
"agentId": "<string>",
"headers": {},
"body": "<string>"
}
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({
url: '<string>',
agentId: '<string>',
headers: {},
body: JSON.stringify('<string>')
})
};
fetch('https://api.useanima.sh/v1/vault/credentials/{id}/use', 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.useanima.sh/v1/vault/credentials/{id}/use",
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([
'url' => '<string>',
'agentId' => '<string>',
'headers' => [
],
'body' => '<string>'
]),
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.useanima.sh/v1/vault/credentials/{id}/use"
payload := strings.NewReader("{\n \"url\": \"<string>\",\n \"agentId\": \"<string>\",\n \"headers\": {},\n \"body\": \"<string>\"\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.useanima.sh/v1/vault/credentials/{id}/use")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"url\": \"<string>\",\n \"agentId\": \"<string>\",\n \"headers\": {},\n \"body\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.useanima.sh/v1/vault/credentials/{id}/use")
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 \"url\": \"<string>\",\n \"agentId\": \"<string>\",\n \"headers\": {},\n \"body\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"status": 123,
"headers": {},
"body": "<string>",
"truncated": true
}Authorizations
BearerAuthApiKeyAuth
JWT Bearer token obtained from authentication. Pass as: Authorization: Bearer
Path Parameters
Credential ID to broker the call with
Body
application/json
Make an outbound HTTP call with the credential attached server-side. The plaintext secret is never returned — the agent only sees the upstream response.
HTTP method for the outbound call
Available options:
GET, POST, PUT, PATCH, DELETE, HEAD Absolute https:// URL. Its host MUST be on the credential's allowlist.
Agent ID (optional when using an agent API key)
Extra request headers. Any Authorization / auth header is ignored and replaced by the credential.
Show child attributes
Show child attributes
Raw request body (encode JSON yourself).
Response
200 - application/json
OK
The upstream response, scrubbed of the injected credential.
