Create Webhook Key
POST
/
agent_api_keys
Create Api Key
curl --request POST \
--url https://api.example.com/agent_api_keys \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"agent_id": "<string>",
"agent_name": "<string>",
"api_key": "<string>",
"api_key_type": "external"
}
'import requests
url = "https://api.example.com/agent_api_keys"
payload = {
"name": "<string>",
"agent_id": "<string>",
"agent_name": "<string>",
"api_key": "<string>",
"api_key_type": "external"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
agent_id: '<string>',
agent_name: '<string>',
api_key: '<string>',
api_key_type: 'external'
})
};
fetch('https://api.example.com/agent_api_keys', 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.example.com/agent_api_keys",
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>',
'agent_id' => '<string>',
'agent_name' => '<string>',
'api_key' => '<string>',
'api_key_type' => 'external'
]),
CURLOPT_HTTPHEADER => [
"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.example.com/agent_api_keys"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"agent_id\": \"<string>\",\n \"agent_name\": \"<string>\",\n \"api_key\": \"<string>\",\n \"api_key_type\": \"external\"\n}")
req, _ := http.NewRequest("POST", url, payload)
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.example.com/agent_api_keys")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"agent_id\": \"<string>\",\n \"agent_name\": \"<string>\",\n \"api_key\": \"<string>\",\n \"api_key_type\": \"external\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/agent_api_keys")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"agent_id\": \"<string>\",\n \"agent_name\": \"<string>\",\n \"api_key\": \"<string>\",\n \"api_key_type\": \"external\"\n}"
response = http.request(request)
puts response.read_body{
"agent_id": "<string>",
"api_key": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"id": "<string>",
"name": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Body
application/json
The name of the agent's API key.
The UUID of the agent
The name of the agent - if not provided, the agent_id must be set.
Optionally provide the API key value - if not set, one will be generated.
The type of the agent API key (external by default).
Available options:
internal, external, github, slack Response
Successful Response
The UUID of the agent
The value of the newly created API key.
The type of the created agent API key (external).
Available options:
internal, external, github, slack When the agent API key was created
The unique identifier of the agent API key.
The optional name of the agent API key.
Was this page helpful?
⌘I
Create Api Key
curl --request POST \
--url https://api.example.com/agent_api_keys \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"agent_id": "<string>",
"agent_name": "<string>",
"api_key": "<string>",
"api_key_type": "external"
}
'import requests
url = "https://api.example.com/agent_api_keys"
payload = {
"name": "<string>",
"agent_id": "<string>",
"agent_name": "<string>",
"api_key": "<string>",
"api_key_type": "external"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
agent_id: '<string>',
agent_name: '<string>',
api_key: '<string>',
api_key_type: 'external'
})
};
fetch('https://api.example.com/agent_api_keys', 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.example.com/agent_api_keys",
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>',
'agent_id' => '<string>',
'agent_name' => '<string>',
'api_key' => '<string>',
'api_key_type' => 'external'
]),
CURLOPT_HTTPHEADER => [
"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.example.com/agent_api_keys"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"agent_id\": \"<string>\",\n \"agent_name\": \"<string>\",\n \"api_key\": \"<string>\",\n \"api_key_type\": \"external\"\n}")
req, _ := http.NewRequest("POST", url, payload)
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.example.com/agent_api_keys")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"agent_id\": \"<string>\",\n \"agent_name\": \"<string>\",\n \"api_key\": \"<string>\",\n \"api_key_type\": \"external\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/agent_api_keys")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"agent_id\": \"<string>\",\n \"agent_name\": \"<string>\",\n \"api_key\": \"<string>\",\n \"api_key_type\": \"external\"\n}"
response = http.request(request)
puts response.read_body{
"agent_id": "<string>",
"api_key": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"id": "<string>",
"name": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}