ONonyx-dot-app
public

Get Agents Paginated

Changed on

Paginated endpoint for listing agents available to the user.

Returns items for the requested page plus total count. Personas are ordered by display_priority (ASC, nulls last) then by ID (ASC).

NOTE: persona_ids filter is not supported with pagination. Use the non-paginated endpoint if filtering by specific IDs is needed.

get/agents

Request

  • Base URL
    https://cloud.onyx.app/api
  • URL
    https://cloud.onyx.app/api/agents
  • Auth
    HTTP bearer

Query parameters

page_numinteger

Page number (0-indexed).

page_sizeinteger

Items per page.

include_deletedboolean

If true, includes deleted personas.

get_editableboolean

If true, only returns editable personas.

include_defaultboolean

If true, includes builtin/default personas.

Response

Successful Response

total_itemsinteger required

Changes

  • fcb09658bc37Revision changes
    • warning

      added the new box enum value to the ////// response property for the response status

    • warning

      added the new braintrust enum value to the ////// response property for the response status

    • warning

      added the new canvas enum value to the ////// response property for the response status

    • warning

      added the new craft_file enum value to the ////// response property for the response status

    • warning

      added the new lumapps enum value to the ////// response property for the response status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      removed the requesttracker enum value from the ////// response property for the response status

  • 2d941ea53eb3Revision changes
    • info

      endpoint added