v1

latestOpenAPI 3.1.02026-07-265094114.0 KB

Tasks

List all agent tasks

Retrieve all agent tasks available in your workspace including public agent tasks and custom workspace agent tasks

get/v1/tasks

Query parameters

sizenumber

Example:100

Number of agent tasks to return per page

pagenumber

Example:1

Page number (1-indexed)

scope'USER' | 'WORKSPACE' | 'PUBLIC'

Example:PUBLIC

Filter by agent task scope: PUBLIC or WORKSPACE

includeContextItemsboolean

Include context items (input fields) in the response for the task to be executed by the agent. Default is false.

includeCategoriesboolean

Include categories for the agent tasks in the response. Default is false.

searchTermstring

Example:blog

Search term to filter agent tasks by name, description, categories, or tags. Performs partial case-insensitive matching.

Response

Successfully retrieved list of agent tasks

requestIdstring

resourcestring

paginationobject

Example response

{
  "requestId": "07008c5a-f916-4bdc-bfda-e8f6c328f7c5",
  "resource": "tasks",
  "data": [
    {
      "id": "agt_0190f3a1b2c34d5e6f7a8b9c0d1e2f3a",
      "name": "Grammar Checker",
      "description": "Ensure your text is free from grammar errors to enhance clarity and professionalism",
      "contextItems": [
        {
          "id": "5e9f3d7b-9ec6-44e7-b752-3977fef34c18",
          "name": "Original text",
          "type": "TEXTAREA",
          "question": "What text do you want to check?",
          "options": [
            "grammar",
            "writing"
          ]
        }
      ],
      "version": 1,
      "scope": "PUBLIC",
      "updatedAt": "2024-10-29T03:47:44.468Z",
      "createdAt": "2024-10-02T03:51:26.020Z",
      "longDescription": "#### Overview\nElevate the quality of your content by running it through a comprehensive grammar checker...",
      "publishedAt": "2024-10-14T04:12:20.369Z",
      "categories": []
    }
  ],
  "pagination": {
    "totalRecords": 100,
    "page": 1,
    "pageSize": 25,
    "next": "2",
    "prev": null
  }
}