curl --request PATCH \
--url https://api.eda.prisme.ai/v2/orgs/{orgSlug}/api-keys/{keyId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"permissions": [
"<string>"
],
"scopes": [
"<string>"
],
"expiresAt": "2023-11-07T05:31:56Z",
"disabled": true
}
'import requests
url = "https://api.eda.prisme.ai/v2/orgs/{orgSlug}/api-keys/{keyId}"
payload = {
"name": "<string>",
"permissions": ["<string>"],
"scopes": ["<string>"],
"expiresAt": "2023-11-07T05:31:56Z",
"disabled": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
permissions: ['<string>'],
scopes: ['<string>'],
expiresAt: '2023-11-07T05:31:56Z',
disabled: true
})
};
fetch('https://api.eda.prisme.ai/v2/orgs/{orgSlug}/api-keys/{keyId}', 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.eda.prisme.ai/v2/orgs/{orgSlug}/api-keys/{keyId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'permissions' => [
'<string>'
],
'scopes' => [
'<string>'
],
'expiresAt' => '2023-11-07T05:31:56Z',
'disabled' => true
]),
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.eda.prisme.ai/v2/orgs/{orgSlug}/api-keys/{keyId}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"permissions\": [\n \"<string>\"\n ],\n \"scopes\": [\n \"<string>\"\n ],\n \"expiresAt\": \"2023-11-07T05:31:56Z\",\n \"disabled\": true\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.eda.prisme.ai/v2/orgs/{orgSlug}/api-keys/{keyId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"permissions\": [\n \"<string>\"\n ],\n \"scopes\": [\n \"<string>\"\n ],\n \"expiresAt\": \"2023-11-07T05:31:56Z\",\n \"disabled\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.eda.prisme.ai/v2/orgs/{orgSlug}/api-keys/{keyId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"permissions\": [\n \"<string>\"\n ],\n \"scopes\": [\n \"<string>\"\n ],\n \"expiresAt\": \"2023-11-07T05:31:56Z\",\n \"disabled\": true\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"slug": "<string>",
"name": "<string>",
"permissions": [
"<string>"
],
"scopes": [
"<string>"
],
"expiresAt": "2023-11-07T05:31:56Z",
"disabled": true,
"createdAt": "<string>",
"updatedAt": "<string>"
}{
"error": "AuthenticationError",
"message": "Unauthenticated"
}{
"error": "ForbiddenError",
"message": "Forbidden"
}{
"error": "ObjectNotFound",
"message": "<string>"
}Patch v2orgs api keys
Update an API key (name, permissions, expiration, disabled status)
curl --request PATCH \
--url https://api.eda.prisme.ai/v2/orgs/{orgSlug}/api-keys/{keyId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"permissions": [
"<string>"
],
"scopes": [
"<string>"
],
"expiresAt": "2023-11-07T05:31:56Z",
"disabled": true
}
'import requests
url = "https://api.eda.prisme.ai/v2/orgs/{orgSlug}/api-keys/{keyId}"
payload = {
"name": "<string>",
"permissions": ["<string>"],
"scopes": ["<string>"],
"expiresAt": "2023-11-07T05:31:56Z",
"disabled": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
permissions: ['<string>'],
scopes: ['<string>'],
expiresAt: '2023-11-07T05:31:56Z',
disabled: true
})
};
fetch('https://api.eda.prisme.ai/v2/orgs/{orgSlug}/api-keys/{keyId}', 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.eda.prisme.ai/v2/orgs/{orgSlug}/api-keys/{keyId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'permissions' => [
'<string>'
],
'scopes' => [
'<string>'
],
'expiresAt' => '2023-11-07T05:31:56Z',
'disabled' => true
]),
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.eda.prisme.ai/v2/orgs/{orgSlug}/api-keys/{keyId}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"permissions\": [\n \"<string>\"\n ],\n \"scopes\": [\n \"<string>\"\n ],\n \"expiresAt\": \"2023-11-07T05:31:56Z\",\n \"disabled\": true\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.eda.prisme.ai/v2/orgs/{orgSlug}/api-keys/{keyId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"permissions\": [\n \"<string>\"\n ],\n \"scopes\": [\n \"<string>\"\n ],\n \"expiresAt\": \"2023-11-07T05:31:56Z\",\n \"disabled\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.eda.prisme.ai/v2/orgs/{orgSlug}/api-keys/{keyId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"permissions\": [\n \"<string>\"\n ],\n \"scopes\": [\n \"<string>\"\n ],\n \"expiresAt\": \"2023-11-07T05:31:56Z\",\n \"disabled\": true\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"slug": "<string>",
"name": "<string>",
"permissions": [
"<string>"
],
"scopes": [
"<string>"
],
"expiresAt": "2023-11-07T05:31:56Z",
"disabled": true,
"createdAt": "<string>",
"updatedAt": "<string>"
}{
"error": "AuthenticationError",
"message": "Unauthenticated"
}{
"error": "ForbiddenError",
"message": "Forbidden"
}{
"error": "ObjectNotFound",
"message": "<string>"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
Array of permission strings. Convention: {product}:{resource}:{action} Wildcards: Use * at end only (e.g., orgs:* matches orgs:members:manage) Platform permissions: - orgs:* (full org access) - orgs:members:manage, orgs:roles:manage, orgs:manage - orgs:branding:manage, orgs:navigation:manage - orgs:subscriptions:view, orgs:subscriptions:manage - orgs:apikeys:manage, orgs:invites:manage, orgs:join-rules:manage - secure-chat:, store:, knowledge:, builder: - agent-builder:, analytics:view, platform-admin: Custom app permissions: {app-slug}:{resource}:{action} Example: my-crm:contacts:read, my-crm:deals:manage Super admin: ["*"] (matches everything)
Optional resource patterns restricting where permissions apply. Format: resourceType:resourceId
Response
Success
Internal role ID
Unique slug identifying the API key within the org
Array of permission strings. Convention: {product}:{resource}:{action} Wildcards: Use * at end only (e.g., orgs:* matches orgs:members:manage) Platform permissions: - orgs:* (full org access) - orgs:members:manage, orgs:roles:manage, orgs:manage - orgs:branding:manage, orgs:navigation:manage - orgs:subscriptions:view, orgs:subscriptions:manage - orgs:apikeys:manage, orgs:invites:manage, orgs:join-rules:manage - secure-chat:, store:, knowledge:, builder: - agent-builder:, analytics:view, platform-admin: Custom app permissions: {app-slug}:{resource}:{action} Example: my-crm:contacts:read, my-crm:deals:manage Super admin: ["*"] (matches everything)
Optional string array of resource patterns restricting where permissions apply. Format: resourceType:resourceId. Examples: agents:agent-abc-123, models:gpt-4o, orgs:acme, agents:, models:, *
Was this page helpful?