sealgate-ai Agents API

openapi: 3.2.0
info:
  title: Sealgate Ai Agents API
  x-refined-note:
  - x-source-of-truth differs across the merged source definitions and was not carried
  version: '1.0'
  description: 'Operations tagged Agents across 3 of this provider''s published API definitions: sealgate-ai-openapi.json, sealgate-ai-dashboard-openapi.json, sealgate-ai-management-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://dashboard.sealgate.ai
  description: SealGate management API - release
- url: https://demo-dashboard.sealgate.ai
  description: SealGate management API - demo
tags:
- name: Agents
  description: Register and manage AI agents.
paths:
  /api/v1/agents:
    get:
      tags:
      - Agents
      summary: List agents
      description: List registered agents. ADMIN sees domain agents; OWNER sees all. Requires the admin role.
      operationId: listAgents
      parameters:
      - $ref: '#/components/parameters/PageParam'
      - $ref: '#/components/parameters/PerPageParam'
      - name: q
        in: query
        required: false
        description: Search by agent name
        schema:
          type: string
          maxLength: 200
      - name: agent_type
        in: query
        required: false
        description: Filter by agent type
        schema:
          type: string
      - name: include_archived
        in: query
        required: false
        description: Include archived agents (owner only)
        schema:
          type: boolean
          default: false
      responses:
        '200':
          description: A page of agent summaries
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgentSummaryPage'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '422':
          $ref: '#/components/responses/ValidationError'
      security:
      - bearerAuth: []
    post:
      tags:
      - Agents
      summary: Register an agent
      description: Register a new agent. OWNER may target a specific domain. Requires the admin role.
      operationId: createAgent
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateAgentRequest'
      responses:
        '201':
          description: The registered agent
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgentDetail'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '409':
          $ref: '#/components/responses/Conflict'
        '422':
          $ref: '#/components/responses/ValidationError'
      security:
      - bearerAuth: []
    servers:
    - url: https://dashboard.sealgate.ai
      description: SealGate management API - release
    - url: https://demo-dashboard.sealgate.ai
      description: SealGate management API - demo
  /api/v1/agents/{agent_name}:
    patch:
      summary: Update Agent
      description: Update (archive/restore) an agent. ADMIN can only modify domain agents.
      operationId: update_agent_api_v1_agents__agent_name__patch
      security:
      - HTTPBearer: []
      parameters:
      - name: agent_name
        in: path
        required: true
        schema:
          type: string
          title: Agent Name
      - name: domain
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Org to view (Super-Owner only, read-only)
          title: Domain
        description: Org to view (Super-Owner only, read-only)
      - name: Idempotency-Key
        in: header
        required: false
        description: Optional client-generated key that makes this write operation safe to retry. Reusing the same key returns the original response instead of performing the operation a second time. Keys are scoped to the caller and expire after 24 hours.
        schema:
          type: string
          maxLength: 255
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateAgentRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgentDetail_2'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError_2'
      tags:
      - Agents
    delete:
      summary: Delete Agent
      description: Delete an agent by name. ADMIN can only delete domain agents.
      operationId: delete_agent_api_v1_agents__agent_name__delete
      security:
      - HTTPBearer: []
      parameters:
      - name: agent_name
        in: path
        required: true
        schema:
          type: string
          title: Agent Name
      - name: domain
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Org to view (Super-Owner only, read-only)
          title: Domain
        description: Org to view (Super-Owner only, read-only)
      responses:
        '204':
          description: Successful Response
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError_2'
      tags:
      - Agents
components:
  schemas:
    AgentDetail:
      allOf:
      - $ref: '#/components/schemas/AgentSummary'
      - type: object
        properties:
          user_id:
            type: string
            description: User ID of the agent creator
          updated_at:
            type: string
            format: date-time
            description: When the agent was last updated
        required:
        - user_id
        - updated_at
    AgentSummary:
      type: object
      properties:
        id:
          type: integer
          description: Agent primary key
        name:
          type: string
          description: Unique agent name
        agent_id:
          type: string
          description: Unique agent identifier in agent:HEX format
        agent_type:
          type:
          - string
          - 'null'
          description: Agent type or category
        domain:
          type: string
          description: Email domain the agent belongs to
        archived:
          type: boolean
          description: Whether the agent is archived
        created_at:
          type: string
          format: date-time
      required:
      - id
      - name
      - agent_id
      - domain
      - archived
      - created_at
    AgentSummaryPage:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/AgentSummary'
        total:
          type: integer
        page:
          type: integer
        per_page:
          type: integer
        total_pages:
          type: integer
      required:
      - items
      - total
      - page
      - per_page
      - total_pages
    ErrorDetail:
      type: object
      description: Application error body carried under `detail`.
      properties:
        error:
          type: string
          description: Human-readable error message
        code:
          type: string
          description: Machine-readable error code
        details:
          type:
          - object
          - 'null'
          description: Additional error details
          additionalProperties: true
      required:
      - error
      - code
    ValidationError:
      type: object
      description: A single request-validation error.
      properties:
        loc:
          type: array
          items:
            type:
            - string
            - integer
          description: Location of the invalid field
        msg:
          type: string
          description: Validation error message
        type:
          type: string
          description: Validation error type
      required:
      - loc
      - msg
      - type
    CreateAgentRequest:
      type: object
      properties:
        name:
          type: string
          description: Agent name (must be unique per domain)
        agent_type:
          type:
          - string
          - 'null'
          description: Optional agent type/category
        domain:
          type:
          - string
          - 'null'
          description: Target domain (owner only; must be in owner domain list)
      required:
      - name
    HTTPValidationError:
      type: object
      description: Body returned for a 422 request-validation failure.
      properties:
        detail:
          type: array
          items:
            $ref: '#/components/schemas/ValidationError'
    ErrorResponse:
      type: object
      description: Standard error envelope returned on 4xx and 5xx responses.
      properties:
        detail:
          $ref: '#/components/schemas/ErrorDetail'
      required:
      - detail
    AgentDetail_2:
      properties:
        id:
          type: integer
          title: Id
          description: Agent primary key
        name:
          type: string
          title: Name
          description: Unique agent name
        agent_id:
          type: string
          title: Agent Id
          description: Unique agent identifier in agent:HEX format
        agent_type:
          anyOf:
          - type: string
          - type: 'null'
          title: Agent Type
          description: Agent type or category
        domain:
          type: string
          title: Domain
          description: Email domain the agent belongs to
        archived:
          type: boolean
          title: Archived
          description: Whether the agent is archived
        created_at:
          type: string
          format: date-time
          title: Created At
          description: When the agent was created
        user_id:
          type: string
          title: User Id
          description: User ID of the agent creator
        updated_at:
          type: string
          format: date-time
          title: Updated At
          description: When the agent was last updated
      type: object
      required:
      - id
      - name
      - agent_id
      - domain
      - archived
      - created_at
      - user_id
      - updated_at
      title: AgentDetail
    AgentSummary_2:
      properties:
        id:
          type: integer
          title: Id
          description: Agent primary key
        name:
          type: string
          title: Name
          description: Unique agent name
        agent_id:
          type: string
          title: Agent Id
          description: Unique agent identifier in agent:HEX format
        agent_type:
          anyOf:
          - type: string
          - type: 'null'
          title: Agent Type
          description: Agent type or category
        domain:
          type: string
          title: Domain
          description: Email domain the agent belongs to
        archived:
          type: boolean
          title: Archived
          description: Whether the agent is archived
        created_at:
          type: string
          format: date-time
          title: Created At
          description: When the agent was created
      type: object
      required:
      - id
      - name
      - agent_id
      - domain
      - archived
      - created_at
      title: AgentSummary
    UpdateAgentRequest:
      properties:
        archived:
          type: boolean
          title: Archived
          description: True to archive, False to restore
      type: object
      required:
      - archived
      title: UpdateAgentRequest
    ValidationError_2:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    CreateAgentRequest_2:
      properties:
        name:
          type: string
          title: Name
          description: Agent name (must be unique per domain)
        agent_type:
          anyOf:
          - type: string
          - type: 'null'
          title: Agent Type
          description: Optional agent type/category
      type: object
      required:
      - name
      title: CreateAgentRequest
    HTTPValidationError_2:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError_2'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    PaginatedResponse_AgentSummary_:
      properties:
        items:
          items:
            $ref: '#/components/schemas/AgentSummary_2'
          type: array
          title: Items
          description: Page of results
        total:
          type: integer
          title: Total
          description: Total number of items across all pages
        page:
          type: integer
          title: Page
          description: Current page number (1-indexed)
        per_page:
          type: integer
          title: Per Page
          description: Number of items per page
        total_pages:
          type: integer
          title: Total Pages
          description: Total number of pages
      type: object
      required:
      - items
      - total
      - page
      - per_page
      - total_pages
      title: PaginatedResponse[AgentSummary]
  responses:
    Conflict:
      description: The resource already exists or conflicts with current state
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Forbidden:
      description: The caller's role is not permitted to perform this action
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    ValidationError:
      description: Request validation failed
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/HTTPValidationError'
    Unauthorized:
      description: Missing or invalid API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    BadRequest:
      description: The request was invalid
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  parameters:
    PerPageParam:
      name: per_page
      in: query
      required: false
      description: Items per page
      schema:
        type: integer
        minimum: 1
        maximum: 100
        default: 50
    PageParam:
      name: page
      in: query
      required: false
      description: Page number (1-indexed)
      schema:
        type: integer
        minimum: 1
        default: 1
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: SealGate API key
      description: 'SealGate API key sent as `Authorization: Bearer <your-sealgate-api-key>`.'
    HTTPBearer:
      type: http
      scheme: bearer
    ClientBearer:
      type: http
      description: Opaque ewc_ client installation credential
      scheme: bearer
    ServiceToken:
      type: http
      description: 'A SealGate service token: `sgt_acct_...` (account token) or `sgt_org_...` (org token). Mint an account token in the dashboard.'
      scheme: bearer
    MCPGatewayOAuth:
      type: oauth2
      description: OAuth 2.1 authorization-code flow (PKCE required) against the SealGate MCP gateway's authorization server. Request only the scopes an agent needs; unrequested scopes are not granted.
      flows:
        authorizationCode:
          authorizationUrl: /oauth/authorize
          tokenUrl: /oauth/token
          refreshUrl: /oauth/token
          scopes:
            mcp: Connect to the MCP gateway and call the tools exposed by your enabled servers. Every call is still evaluated by the policy engine.
            offline_access: Issue a refresh token so the client can renew access without a new browser sign-in.
externalDocs:
  description: SealGate product documentation
  url: https://docs.sealgate.ai
x-refined-from:
- sealgate-ai-openapi.json
- sealgate-ai-dashboard-openapi.json
- sealgate-ai-management-openapi.json