PydanticAI · Schema

APIKeyRead

AIAgentsPythonLLMType SafetyStructured OutputsDependency InjectionOpenAIAnthropicGeminiObservabilityFramework

Properties

Name	Type	Description
id	string
organization_id	string
name	string
description	object
scopes	array
project_id	object
project_name	object
all_projects	boolean
created_by	object
created_by_name	object
created_at	string
last_used_at	object
expires_at	object
user_id	object
active	boolean
updated_at	object
updated_by	object
claims	object

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://pydantic.dev/schemas/APIKeyRead",
  "title": "APIKeyRead",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "title": "Id"
    },
    "organization_id": {
      "type": "string",
      "format": "uuid",
      "title": "Organization Id"
    },
    "name": {
      "type": "string",
      "title": "Name"
    },
    "description": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Description"
    },
    "scopes": {
      "items": {
        "$ref": "#/components/schemas/OAuthScopeId"
      },
      "type": "array",
      "title": "Scopes"
    },
    "project_id": {
      "anyOf": [
        {
          "type": "string",
          "format": "uuid"
        },
        {
          "type": "null"
        }
      ],
      "title": "Project Id"
    },
    "project_name": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Project Name"
    },
    "all_projects": {
      "type": "boolean",
      "title": "All Projects"
    },
    "created_by": {
      "anyOf": [
        {
          "type": "string",
          "format": "uuid"
        },
        {
          "type": "null"
        }
      ],
      "title": "Created By"
    },
    "created_by_name": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Created By Name"
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "title": "Created At"
    },
    "last_used_at": {
      "anyOf": [
        {
          "type": "string",
          "format": "date-time"
        },
        {
          "type": "null"
        }
      ],
      "title": "Last Used At"
    },
    "expires_at": {
      "anyOf": [
        {
          "type": "string",
          "format": "date-time"
        },
        {
          "type": "null"
        }
      ],
      "title": "Expires At"
    },
    "user_id": {
      "anyOf": [
        {
          "type": "string",
          "format": "uuid"
        },
        {
          "type": "null"
        }
      ],
      "title": "User Id"
    },
    "active": {
      "type": "boolean",
      "title": "Active"
    },
    "updated_at": {
      "anyOf": [
        {
          "type": "string",
          "format": "date-time"
        },
        {
          "type": "null"
        }
      ],
      "title": "Updated At"
    },
    "updated_by": {
      "anyOf": [
        {
          "type": "string",
          "format": "uuid"
        },
        {
          "type": "null"
        }
      ],
      "title": "Updated By"
    },
    "claims": {
      "$ref": "#/components/schemas/APIKeyClaims"
    }
  },
  "type": "object",
  "required": [
    "id",
    "organization_id",
    "name",
    "description",
    "scopes",
    "project_id",
    "project_name",
    "all_projects",
    "created_by",
    "created_by_name",
    "created_at",
    "last_used_at",
    "expires_at",
    "user_id",
    "active",
    "updated_at",
    "updated_by"
  ]
}