POpoll-the-people
Agents

List all agents.

Changed on

Returns all agents in your account, sorted by creation date with the most recent first. Use this endpoint to get an overview of your agents or to retrieve agent IDs for other API calls. Results are paginated with a default page size of 10.

Notes: Use the page query parameter to fetch additional results.

get/api/v1/projects

Request

Query parameters

pageinteger
Example:1

Page number to retrieve. Page numbering starts at 1.

Increment until the response's last_page value is reached to paginate through all results. Default: 1.

durationinteger

The duration of the agents to list.

order'asc' | 'desc'
Example:desc

Sort direction for results.

orderBy'id' | 'created_at'
Example:id

Field to sort results by.

widthstring
Example:50rem

The width of the embed code. Defaults to 100%.

heightstring
Example:50rem

The height of the embed code. Defaults to 100%.

namestring
Example:Sample agent

Filter the results by agent name

Response

Successfully retrieved list of agents that belong to the user.

status'error' | 'success'

The status of the response

Example response

{
  "status": "success",
  "data": {
    "current_page": 1,
    "data": [
      {
        "id": 1,
        "project_name": "My Agent",
        "sitemap_path": "https://www.example.com/sitemap.xml",
        "is_chat_active": true,
        "user_id": 1,
        "team_id": 1,
        "created_at": "2021-01-01 00:00:00",
        "updated_at": "2021-01-01 00:00:00",
        "deleted_at": "2021-01-01 00:00:00",
        "type": "SITEMAP",
        "is_shared": true,
        "shareable_slug": "1234567890abcdef1234567890abcdef",
        "are_licenses_allowed": true
      }
    ],
    "first_page_url": "https://app.customgpt.ai/api/v1/users?page=1",
    "from": 1,
    "last_page": 1,
    "last_page_url": "https://app.customgpt.ai/api/v1/users?page=1",
    "next_page_url": "https://app.customgpt.ai/api/v1/users?page=1",
    "path": "https://app.customgpt.ai/api/v1/users?page=1",
    "per_page": 10,
    "prev_page_url": "https://app.customgpt.ai/api/v1/users?page=1",
    "to": 1,
    "total": 1
  }
}

Changes

  • 77aab4354382Revision changes
    • warning

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

    • warning

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

    • info

      added the non-success response with the status

    • info

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

  • b80e6dfcf78dRevision changes
    • info

      api tag Agents added

    • info

      api tag Projects removed

    • info

      added the new optional query request parameter name

    • info

      added the new optional query request parameter orderBy

    • info

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

    • info

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

    • info

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