> ## Documentation Index
> Fetch the complete documentation index at: https://dev-docs.persona.hasanraiyan.me/llms.txt
> Use this file to discover all available pages before exploring further.

# Versioned schema for the custom AG-UI events this backend emits

> Documents every non-base-protocol `CUSTOM` AG-UI event this backend streams (clarification_request, hitl_request, mcp_app, subagent_activity) with a resolvable JSON Schema per payload. The base `@ag-ui/core` protocol version is fixed and unaffected by this document's own schemaVersion. Every POST /api/v1/developer/agui stream response also carries the active schemaVersion on the X-AGUI-Schema-Version response header.




## OpenAPI

````yaml /openapi.json get /api/v1/developer/agui/schema
openapi: 3.0.0
info:
  title: persona.hasanraiyan.me Developer Platform API
  version: 1.0.0
  description: >-
    REST + AG-UI API for integrating your product with Persona's agent
    infrastructure.


    Every endpoint here is a server-to-server call — see the Integration Guide
    for where in your own stack to call each one from, and how the same endpoint
    serves both Project-level and per-end-user requests via the
    `x-persona-external-user-id` header.
servers:
  - url: https://api.persona.hasanraiyan.me
    description: Production
security: []
tags: []
paths:
  /api/v1/developer/agui/schema:
    get:
      tags:
        - Developer
      summary: Versioned schema for the custom AG-UI events this backend emits
      description: >
        Documents every non-base-protocol `CUSTOM` AG-UI event this backend
        streams (clarification_request, hitl_request, mcp_app,
        subagent_activity) with a resolvable JSON Schema per payload. The base
        `@ag-ui/core` protocol version is fixed and unaffected by this
        document's own schemaVersion. Every POST /api/v1/developer/agui stream
        response also carries the active schemaVersion on the
        X-AGUI-Schema-Version response header.
      parameters:
        - name: version
          in: query
          required: false
          schema:
            type: string
          description: >-
            Echoed back as-is; only "latest" (the current version) is served
            today.
      responses:
        '200':
          description: The event schema document.
      security:
        - projectCredential: []
components:
  securitySchemes:
    projectCredential:
      type: http
      scheme: bearer
      bearerFormat: <keyId>.<secret>
      description: >-
        Developer Platform Project credential, minted via POST
        /api/v1/projects/{projectId}/credentials. Send as `Authorization: Bearer
        <keyId>.<secret>`. Optionally pair with the `x-persona-external-user-id`
        header to act on behalf of one of the Project's own external users. This
        credential is a server-side secret — see the Integration Guide.

````