ApiKeyCreatedResponse

Fields

Returned ONCE at creation — includes the plaintext key.

10 fields

created_at · required

string (date-time)

expires_at

string (date-time) or null

id · required

string (uuid)

is_active · required

boolean

key_hint · required

string

last_used_at

string (date-time) or null

name · required

string

project_id

string (uuid) or null

raw_key · required

string

scopes · required

array of string

Raw schema (JSON)

{
  "description": "Returned ONCE at creation — includes the plaintext key.",
  "properties": {
    "created_at": {
      "format": "date-time",
      "title": "Created At",
      "type": "string"
    },
    "expires_at": {
      "anyOf": [
        {
          "format": "date-time",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Expires At"
    },
    "id": {
      "format": "uuid",
      "title": "Id",
      "type": "string"
    },
    "is_active": {
      "title": "Is Active",
      "type": "boolean"
    },
    "key_hint": {
      "title": "Key Hint",
      "type": "string"
    },
    "last_used_at": {
      "anyOf": [
        {
          "format": "date-time",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Last Used At"
    },
    "name": {
      "title": "Name",
      "type": "string"
    },
    "project_id": {
      "anyOf": [
        {
          "format": "uuid",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Project Id"
    },
    "raw_key": {
      "title": "Raw Key",
      "type": "string"
    },
    "scopes": {
      "items": {
        "type": "string"
      },
      "title": "Scopes",
      "type": "array"
    }
  },
  "required": [
    "id",
    "name",
    "key_hint",
    "scopes",
    "is_active",
    "created_at",
    "raw_key"
  ],
  "title": "ApiKeyCreatedResponse",
  "type": "object"
}

Used by endpoints

One endpoint sends or returns this schema, on its own or inside another schema.

• POST /api/v1/keys — Create Api Key

Used by schemas

No other schema contains this one.

More details

• Specification: OpenAPI JSON