List tasks

GET

https://api.getzep.com/api/v4/tasks

GET

/api/v4/tasks

from zep_cloud import Zep
client = Zep(
    api_key="YOUR_API_KEY_HERE",
)
client.task.list()

{
  "items": [
    {
      "completed_at": "string",
      "created_at": "string",
      "error": {
        "code": "string",
        "details": {},
        "message": "string",
        "param": "string",
        "request_id": "string"
      },
      "progress": {
        "stage": "string"
      },
      "result": {
        "content_policy": {
          "category_keys": [
            "health"
          ],
          "dropped_count": 0,
          "failed_count": 1,
          "retained_count": 7,
          "revision": 3,
          "status": "complete",
          "violated": false,
          "violated_count": 2
        },
        "edge_uuid": "7a1f3c2e-4b5d-4e6f-8a9b-0c1d2e3f4a5b",
        "edges": [
          {
            "edge_uuid": "7a1f3c2e-4b5d-4e6f-8a9b-0c1d2e3f4a5b",
            "source_node_uuid": "b2c3d4e5-f6a7-4b8c-9d0e-1f2a3b4c5d6e",
            "target_node_uuid": "c3d4e5f6-a7b8-4c9d-8e1f-2a3b4c5d6e7f"
          }
        ],
        "episode_uuid": "f6a7b8c9-d0e1-4f2a-9b4c-5d6e7f8091a2",
        "episodes": [
          {
            "content_policy": {
              "category_keys": [
                "health"
              ],
              "dropped_count": 0,
              "failed_count": 1,
              "retained_count": 7,
              "revision": 3,
              "status": "complete",
              "violated": false,
              "violated_count": 2
            },
            "episode_uuid": "f6a7b8c9-d0e1-4f2a-9b4c-5d6e7f8091a2"
          }
        ],
        "hyperedge_uuid": "d4e5f6a7-b8c9-4d0e-9f2a-3b4c5d6e7f80",
        "skill_uuid": "e5f6a7b8-c9d0-4e1f-8a3b-4c5d6e7f8091",
        "source_node_uuid": "b2c3d4e5-f6a7-4b8c-9d0e-1f2a3b4c5d6e",
        "target_node_uuid": "c3d4e5f6-a7b8-4c9d-8e1f-2a3b4c5d6e7f"
      },
      "started_at": "string",
      "status": "pending",
      "type": "string",
      "updated_at": "string",
      "uuid": "string"
    }
  ],
  "next_cursor": "string",
  "total_size": 1
}

Authentication

AuthorizationApi-Key

Type “Api-Key” followed by a space and the project API key.

Query parameters

page_sizeintegerOptional1-200Defaults to 50

The maximum number of items in one page. The SDK method returns a pager. In Python, .items holds only the first page. In TypeScript, .data holds only the first page. To read every page, iterate the pager: use for or list(...) in Python, or for await in TypeScript. In Go, the method returns one page, and Iterator() reads all pages.

cursorstringOptional

Opaque page cursor

Response

itemslist of objectsOptional

The tasks on this page.

next_cursorstringOptional

The cursor to pass as the next request’s cursor to fetch the following page; absent when no further pages remain.

total_sizeintegerOptional

The total number of matching tasks, counted at the time of this response. It does not indicate whether more pages remain.

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error