Create API key

http
POST /api-keys

Create an API key and return its secret once.

Servers

json
[
  {
    "url": "https://api.veryfront.com"
  }
]

Authentication

json
[
  {
    "bearerAuth": []
  },
  {
    "apiKeyAuth": []
  }
]
json
{
  "bearerAuth": {
    "type": "http",
    "scheme": "bearer",
    "bearerFormat": "JWT or API Key",
    "description": "Use a JWT bearer token or a Veryfront API key in the `Authorization` header."
  },
  "apiKeyAuth": {
    "type": "apiKey",
    "in": "header",
    "name": "X-API-Key",
    "description": "Alternative API key header for `vf_<prefix>_<secret>` tokens."
  }
}

Request body

json
{
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "properties": {
          "project_reference": {
            "type": "string",
            "description": "Project ID or slug. Creating a project-scoped key requires project.api_keys.manage. Omit for a user-level key; a project-scoped API-key caller retains its enforced project when this field is omitted."
          },
          "name": {
            "type": "string",
            "minLength": 1,
            "maxLength": 255
          },
          "scopes": {
            "type": "array",
            "items": {
              "type": "string",
              "examples": [
                "*",
                "read",
                "write",
                "delete",
                "releases:read",
                "releases:write",
                "releases:delete",
                "releases:*",
                "deployments:read",
                "deployments:write",
                "deployments:delete",
                "deployments:*",
                "projects:read",
                "projects:write",
                "projects:delete",
                "projects:*",
                "components:read",
                "components:write",
                "components:delete",
                "components:*",
                "files:read",
                "files:write",
                "files:delete",
                "files:*",
                "uploads:read",
                "uploads:write",
                "uploads:delete",
                "uploads:*",
                "users:read",
                "users:write",
                "users:delete",
                "users:*",
                "pages:read",
                "pages:write",
                "pages:delete",
                "pages:*",
                "cache:read",
                "cache:write",
                "cache:delete",
                "cache:*",
                "runs:read",
                "runs:write",
                "runs:delete",
                "runs:*",
                "integrations:read",
                "integrations:write",
                "integrations:delete",
                "integrations:*",
                "conversations:read",
                "conversations:write",
                "conversations:delete",
                "conversations:*",
                "agents:read",
                "agents:write",
                "agents:delete",
                "agents:*",
                "runtime:read",
                "runtime:write",
                "runtime:delete",
                "runtime:*",
                "sandboxes:read",
                "sandboxes:write",
                "sandboxes:delete",
                "sandboxes:*"
              ]
            },
            "description": "Requested permissions. Schema examples list all currently supported values. Omitted or empty scopes default to read-only (read). Project keys remain restricted by their project and creation permission."
          },
          "expires_at": {
            "type": "string"
          }
        },
        "required": [
          "name"
        ]
      }
    }
  }
}

Responses

201

API key created successfully

json
{
  "description": "API key created successfully",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid"
          },
          "project_id": {
            "type": [
              "string",
              "null"
            ],
            "format": "uuid"
          },
          "user_id": {
            "type": "string",
            "format": "uuid"
          },
          "name": {
            "type": "string"
          },
          "key": {
            "type": "string"
          },
          "key_prefix": {
            "type": "string"
          },
          "expires_at": {
            "type": [
              "string",
              "null"
            ]
          },
          "created_at": {
            "type": "string"
          },
          "scopes": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "scope": {
            "type": "string",
            "enum": [
              "account",
              "project"
            ],
            "description": "Whether the key is restricted to one project or applies to the account. An account-wide key acts with its owner’s project roles, limited by the key’s scopes. Unlike project-scoped keys, it can inherit the owner’s administrative authority: `write` can allow API key creation, and `delete` can allow project deletion."
          }
        },
        "required": [
          "id",
          "project_id",
          "user_id",
          "name",
          "key",
          "key_prefix",
          "expires_at",
          "created_at",
          "scopes",
          "scope"
        ]
      }
    }
  }
}

400

Bad request

json
{
  "description": "Bad request",
  "content": {
    "application/problem+json": {
      "schema": {
        "$ref": "#/components/schemas/Problem"
      }
    }
  }
}

401

Unauthorized

json
{
  "description": "Unauthorized",
  "content": {
    "application/problem+json": {
      "schema": {
        "$ref": "#/components/schemas/Problem"
      }
    }
  }
}

403

Forbidden

json
{
  "description": "Forbidden",
  "content": {
    "application/problem+json": {
      "schema": {
        "$ref": "#/components/schemas/Problem"
      }
    }
  }
}

404

Not found

json
{
  "description": "Not found",
  "content": {
    "application/problem+json": {
      "schema": {
        "$ref": "#/components/schemas/Problem"
      }
    }
  }
}

500

Server error

json
{
  "description": "Server error",
  "content": {
    "application/problem+json": {
      "schema": {
        "$ref": "#/components/schemas/Problem"
      }
    }
  }
}

503

internal: authentication state is temporarily unavailable and the request was not processed; retry shortly.

json
{
  "description": "internal: authentication state is temporarily unavailable and the request was not processed; retry shortly.",
  "content": {
    "application/problem+json": {
      "schema": {
        "$ref": "#/components/schemas/Problem"
      }
    }
  }
}

Referenced contracts

components/schemas/Problem

json
{
  "type": "object",
  "properties": {
    "cause": {
      "type": "string",
      "enum": [
        "schedule_concurrency_forbidden",
        "schedule_fire_in_progress",
        "schedule_run_limit_reached"
      ],
      "description": "Schedule admission refusal."
    },
    "idempotency": {
      "type": "object",
      "properties": {
        "state": {
          "type": "string",
          "enum": [
            "in_progress",
            "payload_mismatch",
            "outcome_unknown"
          ]
        },
        "operation": {
          "type": "string",
          "minLength": 1
        },
        "retryable": {
          "type": "boolean"
        },
        "retry_after_seconds": {
          "type": [
            "integer",
            "null"
          ],
          "minimum": 0
        },
        "expires_at": {
          "type": [
            "string",
            "null"
          ]
        },
        "recovery": {
          "type": "object",
          "properties": {
            "available": {
              "type": "boolean"
            },
            "description": {
              "type": "string"
            },
            "resource_url": {
              "type": "string"
            }
          },
          "required": [
            "available",
            "description"
          ]
        }
      },
      "required": [
        "state",
        "operation",
        "retryable",
        "retry_after_seconds",
        "expires_at"
      ],
      "description": "Replay status, retry timing, and recovery lookup."
    },
    "type": {
      "type": "string",
      "description": "URI reference identifying the problem type",
      "example": "https://api.veryfront.com/errors/validation-failed"
    },
    "title": {
      "type": "string",
      "description": "Short human-readable summary of the problem",
      "example": "Validation Failed"
    },
    "status": {
      "type": "integer",
      "minimum": 100,
      "maximum": 599,
      "description": "HTTP status code",
      "example": 400
    },
    "code": {
      "type": "string",
      "description": "Stable machine-readable error code",
      "example": "RUN_INVALID_INPUT"
    },
    "detail": {
      "type": "string",
      "description": "Human-readable explanation specific to this occurrence",
      "example": "The 'email' field must be a valid email address"
    },
    "instance": {
      "type": "string",
      "description": "URI reference identifying the specific occurrence",
      "example": "/projects/my-project/members"
    },
    "slug": {
      "type": "string",
      "description": "Stable identifier for the problem type",
      "example": "validation-failed"
    },
    "category": {
      "type": "string",
      "enum": [
        "AUTH",
        "RESOURCE",
        "VALIDATION",
        "DATABASE",
        "SUBSCRIPTION",
        "INTEGRATION",
        "INTERNAL"
      ],
      "description": "API error category",
      "example": "VALIDATION"
    },
    "suggestion": {
      "type": "string",
      "description": "Suggested action to resolve the problem",
      "example": "Check the request body and query parameters against the API documentation."
    },
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "field": {
            "type": "string",
            "description": "Field path that caused the error",
            "example": "email"
          },
          "message": {
            "type": "string",
            "description": "Error message for this field",
            "example": "Invalid email format"
          },
          "code": {
            "type": "string",
            "description": "Error code for this field",
            "example": "INVALID_FORMAT"
          }
        },
        "required": [
          "field",
          "message"
        ]
      },
      "description": "Detailed field-level errors for validation failures"
    }
  },
  "required": [
    "type",
    "title",
    "status"
  ]
}

Operation contract

json
{
  "operationId": "createApiKey",
  "tags": [
    "identity-access/API keys/API keys"
  ],
  "summary": "Create API key",
  "description": "Create an API key and return its secret once.",
  "requestBody": {
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "properties": {
            "project_reference": {
              "type": "string",
              "description": "Project ID or slug. Creating a project-scoped key requires project.api_keys.manage. Omit for a user-level key; a project-scoped API-key caller retains its enforced project when this field is omitted."
            },
            "name": {
              "type": "string",
              "minLength": 1,
              "maxLength": 255
            },
            "scopes": {
              "type": "array",
              "items": {
                "type": "string",
                "examples": [
                  "*",
                  "read",
                  "write",
                  "delete",
                  "releases:read",
                  "releases:write",
                  "releases:delete",
                  "releases:*",
                  "deployments:read",
                  "deployments:write",
                  "deployments:delete",
                  "deployments:*",
                  "projects:read",
                  "projects:write",
                  "projects:delete",
                  "projects:*",
                  "components:read",
                  "components:write",
                  "components:delete",
                  "components:*",
                  "files:read",
                  "files:write",
                  "files:delete",
                  "files:*",
                  "uploads:read",
                  "uploads:write",
                  "uploads:delete",
                  "uploads:*",
                  "users:read",
                  "users:write",
                  "users:delete",
                  "users:*",
                  "pages:read",
                  "pages:write",
                  "pages:delete",
                  "pages:*",
                  "cache:read",
                  "cache:write",
                  "cache:delete",
                  "cache:*",
                  "runs:read",
                  "runs:write",
                  "runs:delete",
                  "runs:*",
                  "integrations:read",
                  "integrations:write",
                  "integrations:delete",
                  "integrations:*",
                  "conversations:read",
                  "conversations:write",
                  "conversations:delete",
                  "conversations:*",
                  "agents:read",
                  "agents:write",
                  "agents:delete",
                  "agents:*",
                  "runtime:read",
                  "runtime:write",
                  "runtime:delete",
                  "runtime:*",
                  "sandboxes:read",
                  "sandboxes:write",
                  "sandboxes:delete",
                  "sandboxes:*"
                ]
              },
              "description": "Requested permissions. Schema examples list all currently supported values. Omitted or empty scopes default to read-only (read). Project keys remain restricted by their project and creation permission."
            },
            "expires_at": {
              "type": "string"
            }
          },
          "required": [
            "name"
          ]
        }
      }
    }
  },
  "responses": {
    "201": {
      "description": "API key created successfully",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "format": "uuid"
              },
              "project_id": {
                "type": [
                  "string",
                  "null"
                ],
                "format": "uuid"
              },
              "user_id": {
                "type": "string",
                "format": "uuid"
              },
              "name": {
                "type": "string"
              },
              "key": {
                "type": "string"
              },
              "key_prefix": {
                "type": "string"
              },
              "expires_at": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "created_at": {
                "type": "string"
              },
              "scopes": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              },
              "scope": {
                "type": "string",
                "enum": [
                  "account",
                  "project"
                ],
                "description": "Whether the key is restricted to one project or applies to the account. An account-wide key acts with its owner’s project roles, limited by the key’s scopes. Unlike project-scoped keys, it can inherit the owner’s administrative authority: `write` can allow API key creation, and `delete` can allow project deletion."
              }
            },
            "required": [
              "id",
              "project_id",
              "user_id",
              "name",
              "key",
              "key_prefix",
              "expires_at",
              "created_at",
              "scopes",
              "scope"
            ]
          }
        }
      }
    },
    "400": {
      "description": "Bad request",
      "content": {
        "application/problem+json": {
          "schema": {
            "$ref": "#/components/schemas/Problem"
          }
        }
      }
    },
    "401": {
      "description": "Unauthorized",
      "content": {
        "application/problem+json": {
          "schema": {
            "$ref": "#/components/schemas/Problem"
          }
        }
      }
    },
    "403": {
      "description": "Forbidden",
      "content": {
        "application/problem+json": {
          "schema": {
            "$ref": "#/components/schemas/Problem"
          }
        }
      }
    },
    "404": {
      "description": "Not found",
      "content": {
        "application/problem+json": {
          "schema": {
            "$ref": "#/components/schemas/Problem"
          }
        }
      }
    },
    "500": {
      "description": "Server error",
      "content": {
        "application/problem+json": {
          "schema": {
            "$ref": "#/components/schemas/Problem"
          }
        }
      }
    },
    "503": {
      "description": "internal: authentication state is temporarily unavailable and the request was not processed; retry shortly.",
      "content": {
        "application/problem+json": {
          "schema": {
            "$ref": "#/components/schemas/Problem"
          }
        }
      }
    }
  },
  "x-documentation-source-tag": "API keys",
  "x-canonical-documentation": {
    "domain": "identity-access",
    "resource": "API keys",
    "subgroup": "API keys",
    "name": "Create API key",
    "description": "Create an API key and return its secret once.",
    "operationId": "createApiKey"
  },
  "x-mint": {
    "href": "/cloud/rest/api-reference/identity-access-api-keys-api-keys/create-api-key"
  }
}