Clarifai · Schema

apiKey

Clarifai apiKey schema

AIComputer VisionNLPImage RecognitionObject DetectionText AnalysisVisual SearchMachine LearningCustom Model TraininggRPC

Properties

Name	Type	Description
id	string	The id of this key, it is used for authorization.
type	string
description	string
scopes	array
endpoints	array
apps	array	The apps that this key give you access to, it is empty if this key is personal_access_token API key can only give you access to a single app.
created_at	string
expires_at	string
authorized_idp_ids	array
organization_id	string	The organization associated with the key, if any. This is applicable only for PAT keys.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/clarifai/refs/heads/main/json-schema/apiKey.json",
  "title": "apiKey",
  "description": "Clarifai apiKey schema",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The id of this key, it is used for authorization."
    },
    "type": {
      "type": "string",
      "title": "The type of key, it can be app_specific_key (default) or personal_access_token"
    },
    "description": {
      "type": "string",
      "title": "The description"
    },
    "scopes": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "title": "The low-level scopes this key has"
    },
    "endpoints": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "title": "The endpoint-level scopes this key has"
    },
    "apps": {
      "type": "array",
      "items": {
        "type": "object",
        "$ref": "#/definitions/apiApp"
      },
      "description": "The apps that this key give you access to, it is empty if this key is personal_access_token\nAPI key can only give you access to a single app."
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "title": "When the key was created. We follow the XXXX timestamp\nformat. We use https://www.ietf.org/rfc/rfc3339.txt format:\n\"2006-01-02T15:04:05.999999Z\" so you can expect results like\nthe following from the API:\n\"2017-04-11T21:50:50.223962Z\""
    },
    "expires_at": {
      "type": "string",
      "format": "date-time",
      "title": "When does the key expires, the key won't expire if this is empty"
    },
    "authorized_idp_ids": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "title": "list of idp ids at which key is currently authorized"
    },
    "organization_id": {
      "type": "string",
      "description": "The organization associated with the key, if any. This is applicable only for PAT keys."
    }
  }
}