ASasksyllable
agents

Agent List

Changed on

List the existing agents

get/api/v1/agents/

Request

  • Base URL
    https://api.syllable.cloud
  • URL
    https://api.syllable.cloud/api/v1/agents/
  • Auth
    API key in header Syllable-API-Key

Query parameters

pageinteger nullable

The page number from which to start (0-based)

limitinteger

The maximum number of items to return

Example:25
search_fieldsAgentProperties[]

String names of fields to search. Correspond by index to search field values

search_field_valuesstring[]

Values of fields to search. Correspond by index to search fields. Unless field name contains "list", an individual search field value cannot be a list

order_by'id' | 'name' | 'name_exact' | 'description' | 'label' | 'labels' | 'name_description' | 'type' | 'timezone' | 'prompt_id' | 'prompt_id_list' | 'custom_message_id' | 'languages' | 'variables' | 'prompt_tool_defaults' | 'tool_headers' | 'updated_at' | 'last_updated_by' | 'lifecycle_status'

Names of agent fields supported for filtering/sorting on list endpoint.

The field whose value should be used to order the results

order_by_direction'asc' | 'desc'

The direction in which to order list results, either ascending or descending.

The direction in which to order the results

fieldsAgentProperties[] nullable

The fields to include in the response

start_datetimestring nullable

The start datetime for filtering results

Example:2023-01-01T00:00:00Z
end_datetimestring nullable

The end datetime for filtering results

Example:2024-01-01T00:00:00Z

Response

Successful Response

pageinteger required

The page number of the results (0-based)

page_sizeinteger required

The number of items returned per page

total_pagesinteger nullable

The total number of pages of results given the indicated page size

total_countinteger nullable

The total number of items returned from the query

Changes

  • 1484d8a755f7Revision changes
    • info

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

  • b9ac2e8b5b7bRevision changes
    • info

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