---
title: "PaginatedAgents"
url: "https://developers.bynder.com/apis/agents/versions/f5aecf98-613e-4ae8-b26a-ec2cdf804b2c/schemas/PaginatedAgents"
---

> Full API specification: https://developers.bynder.com/apis/agents/versions/f5aecf98-613e-4ae8-b26a-ec2cdf804b2c.md

# PaginatedAgents

A page of agents.

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: AI Agents
  version: "1.0"
servers:
  - url: https://{your-bynder-domain}/
components:
  schemas:
    Agent:
      type: object
      description: An agent.
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        name:
          type: string
        description:
          type: string
        prompt:
          $ref: "#/components/schemas/Prompt"
        createdAt:
          type: string
          format: date-time
        modifiedAt:
          type: string
          format: date-time
        accountId:
          type: string
          format: uuid
        status:
          type: string
          enum:
            - ACTIVE
            - INACTIVE
            - DRAFT
        autoApply:
          type: boolean
        autoApplyUserId:
          type: string
          format: uuid
          nullable: true
        agents:
          type: array
          description: The capabilities of the agent.
          items:
            type: string
            enum:
              - ENRICHMENT_AGENT
              - TRANSFORMATION_AGENT
              - BRAND_COMPLIANCE_AGENT
              - GOVERNANCE_AGENT
              - PATH_GENERATOR_AGENT
        agentProperties:
          type: object
          additionalProperties: true
        createdBy:
          type: string
          format: uuid
    Prompt:
      type: object
      description: An agent prompt.
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        text:
          type: string
        version:
          type: integer
          format: int32
          readOnly: true
        isActive:
          type: boolean
          readOnly: true
        createdAt:
          type: string
          format: date-time
        modifiedAt:
          type: string
          format: date-time
    PaginatedAgents:
      type: object
      description: A page of agents.
      properties:
        items:
          type: array
          items:
            $ref: "#/components/schemas/Agent"
        metadata:
          type: object
          properties:
            totalElements:
              type: integer
              format: int64
            totalPages:
              type: integer
              format: int32
            prevPage:
              type: string
              nullable: true
            nextPage:
              type: string
              nullable: true
```