List API key scopes
curl --request GET \
--url https://gateway.prem.io/developers/api_keys/scopesimport requests
url = "https://gateway.prem.io/developers/api_keys/scopes"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://gateway.prem.io/developers/api_keys/scopes', 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://gateway.prem.io/developers/api_keys/scopes",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://gateway.prem.io/developers/api_keys/scopes"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://gateway.prem.io/developers/api_keys/scopes")
.asString();require 'uri'
require 'net/http'
url = URI("https://gateway.prem.io/developers/api_keys/scopes")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"status": 200,
"data": {
"scopes": [
"api_key.create",
"api_key.read",
"api_key.update",
"api_key.delete",
"users.read",
"users.update",
"users_sessions.read",
"chats.completion",
"tools.execute",
"files_encrypted.create",
"files_encrypted.read",
"audio.transcription",
"audio.translation"
]
},
"error": null,
"log": null,
"validator": null,
"support_id": null,
"message": null,
"env": "development"
}{
"status": 401,
"error": "Some error message",
"message": null,
"env": "development",
"log": {
"request_id": "req_1234567890"
},
"support_id": "support_uuidv7-something-else",
"data": {},
"validator": {
"email": "Invalid email address",
"password": "Password is required"
}
}{
"status": 403,
"error": "Some error message",
"message": null,
"env": "development",
"log": {
"request_id": "req_1234567890"
},
"support_id": "support_uuidv7-something-else",
"data": {},
"validator": {
"email": "Invalid email address",
"password": "Password is required"
}
}API Keys
List API key scopes
List all available scopes for API keys
GET
/
developers
/
api_keys
/
scopes
List API key scopes
curl --request GET \
--url https://gateway.prem.io/developers/api_keys/scopesimport requests
url = "https://gateway.prem.io/developers/api_keys/scopes"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://gateway.prem.io/developers/api_keys/scopes', 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://gateway.prem.io/developers/api_keys/scopes",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://gateway.prem.io/developers/api_keys/scopes"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://gateway.prem.io/developers/api_keys/scopes")
.asString();require 'uri'
require 'net/http'
url = URI("https://gateway.prem.io/developers/api_keys/scopes")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"status": 200,
"data": {
"scopes": [
"api_key.create",
"api_key.read",
"api_key.update",
"api_key.delete",
"users.read",
"users.update",
"users_sessions.read",
"chats.completion",
"tools.execute",
"files_encrypted.create",
"files_encrypted.read",
"audio.transcription",
"audio.translation"
]
},
"error": null,
"log": null,
"validator": null,
"support_id": null,
"message": null,
"env": "development"
}{
"status": 401,
"error": "Some error message",
"message": null,
"env": "development",
"log": {
"request_id": "req_1234567890"
},
"support_id": "support_uuidv7-something-else",
"data": {},
"validator": {
"email": "Invalid email address",
"password": "Password is required"
}
}{
"status": 403,
"error": "Some error message",
"message": null,
"env": "development",
"log": {
"request_id": "req_1234567890"
},
"support_id": "support_uuidv7-something-else",
"data": {},
"validator": {
"email": "Invalid email address",
"password": "Password is required"
}
}Response
List of available API key scopes
Status code of the response
Available options:
200, 201, 202 Response data containing the requested object
Show child attributes
Show child attributes
Message of the response, human readable
Example:
"Resource created successfully"
API environment
Available options:
development, production Error message of the response, human readable
Example:
"Invalid email address"
Useful informaiton, not always present, to debug the response
Examples:
{ "request_id": "req_1234567890" }
"Some pertinent log message"
Validator response object, each key is the field name and value is the error message
Example:
{
"email": "Invalid email address",
"password": "Password is required"
}
Support ID linked to the response, used to identify it when talking with our team
Example:
"support_uuidv7-something-else"