Skip to main content
GET
/
developers
/
api_keys
/
scopes
List API key scopes
curl --request GET \
  --url https://gateway.prem.io/developers/api_keys/scopes
{
  "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"
}

Response

List of available API key scopes

​
status
enum<integer>
required

Status code of the response

Available options:
200,
201,
202
​
data
object
required

Response data containing the requested object

​
message
string | null
required

Message of the response, human readable

Example:

"Resource created successfully"

​
env
enum<string>
required

API environment

Available options:
development,
production
​
error
string | null

Error message of the response, human readable

Example:

"Invalid email address"

​
log

Useful informaiton, not always present, to debug the response

Examples:
{ "request_id": "req_1234567890" }

"Some pertinent log message"

​
validator

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
string<uuid> | null

Support ID linked to the response, used to identify it when talking with our team

Example:

"support_uuidv7-something-else"