Add or replace a provider key
curl --request PUT \
--url https://api.getoneprofile.ai/provider-keys/{integration_type}/key/ \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"credentials": {}
}
'import requests
url = "https://api.getoneprofile.ai/provider-keys/{integration_type}/key/"
payload = { "credentials": {} }
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({credentials: {}})
};
fetch('https://api.getoneprofile.ai/provider-keys/{integration_type}/key/', 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.getoneprofile.ai/provider-keys/{integration_type}/key/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'credentials' => [
]
]),
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://api.getoneprofile.ai/provider-keys/{integration_type}/key/"
payload := strings.NewReader("{\n \"credentials\": {}\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api.getoneprofile.ai/provider-keys/{integration_type}/key/")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"credentials\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getoneprofile.ai/provider-keys/{integration_type}/key/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"credentials\": {}\n}"
response = http.request(request)
puts response.read_body{
"checked_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"created_by_user_id": "<string>",
"credits_remaining": 123,
"health": "unchecked",
"health_detail": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"integration_type": "<string>",
"key_hint": "<string>",
"provider_name": "<string>",
"running_low": true,
"updated_at": "2023-11-07T05:31:56Z",
"updated_by_user_id": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>",
"issues": [
{
"input": "<string>",
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}provider-keys
Add or replace a provider key
Save the workspace’s own key with a provider, in place of any it holds. The key is checked with the provider first: one it refuses is not saved. One the provider can’t be reached to check is saved as unchecked, and its first lookup settles it. Paid plans only. Not through the AI Assistant: a key works like a password.
PUT
/
provider-keys
/
{integration_type}
/
key
/
Add or replace a provider key
curl --request PUT \
--url https://api.getoneprofile.ai/provider-keys/{integration_type}/key/ \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"credentials": {}
}
'import requests
url = "https://api.getoneprofile.ai/provider-keys/{integration_type}/key/"
payload = { "credentials": {} }
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({credentials: {}})
};
fetch('https://api.getoneprofile.ai/provider-keys/{integration_type}/key/', 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.getoneprofile.ai/provider-keys/{integration_type}/key/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'credentials' => [
]
]),
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://api.getoneprofile.ai/provider-keys/{integration_type}/key/"
payload := strings.NewReader("{\n \"credentials\": {}\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api.getoneprofile.ai/provider-keys/{integration_type}/key/")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"credentials\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getoneprofile.ai/provider-keys/{integration_type}/key/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"credentials\": {}\n}"
response = http.request(request)
puts response.read_body{
"checked_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"created_by_user_id": "<string>",
"credits_remaining": 123,
"health": "unchecked",
"health_detail": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"integration_type": "<string>",
"key_hint": "<string>",
"provider_name": "<string>",
"running_low": true,
"updated_at": "2023-11-07T05:31:56Z",
"updated_by_user_id": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>",
"issues": [
{
"input": "<string>",
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}Body
application/json
Response
Successful Response
A workspace's key with one provider. Never the key: its last four characters.
Was this page helpful?