CreateAPIKeyRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/scale-ai/json-schema/scale-ai-create-apikey-request-schema.json",
  "title": "CreateAPIKeyRequest",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/scale-ai-agent-apikeys-api-openapi.yml#/components/schemas/CreateAPIKeyRequest",
  "properties": {
    "agent_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Agent Id",
      "description": "The UUID of the agent"
    },
    "agent_name": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Agent Name",
      "description": "The name of the agent - if not provided, the agent_id must be set."
    },
    "name": {
      "type": "string",
      "title": "Name",
      "description": "The name of the agent's API key."
    },
    "api_key_type": {
      "$ref": "#/$defs/AgentAPIKeyType",
      "description": "The type of the agent API key (external by default).",
      "default": "external"
    },
    "api_key": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Api Key",
      "description": "Optionally provide the API key value - if not set, one will be generated."
    }
  },
  "type": "object",
  "required": [
    "name"
  ],
  "$defs": {
    "AgentAPIKeyType": {
      "type": "string",
      "enum": [
        "internal",
        "external",
        "github",
        "slack"
      ],
      "title": "AgentAPIKeyType"
    }
  }
}