Prometheus Entity Management API
    Preparing search index...

    Interface ListTasksRequest

    Parameters for listing tasks with optional filtering criteria.

    interface ListTasksRequest {
        contextId: string;
        historyLength?: number;
        includeArtifacts?: boolean;
        pageSize?: number;
        pageToken: string;
        status: TaskState;
        statusTimestampAfter: string | undefined;
        tenant: string;
    }
    Index
    contextId historyLength? includeArtifacts? pageSize? pageToken status statusTimestampAfter tenant
    contextId: string

    Filter tasks by context ID to get tasks from a specific conversation or session.

    historyLength?: number

    The maximum number of messages to include in each task's history.

    includeArtifacts?: boolean

    Whether to include artifacts in the returned tasks. Defaults to false to reduce payload size.

    pageSize?: number

    The maximum number of tasks to return. The service may return fewer than this value. If unspecified, at most 50 tasks will be returned. The minimum value is 1. The maximum value is 100.

    pageToken: string

    A page token, received from a previous ListTasks call. ListTasksResponse.next_page_token. Provide this to retrieve the subsequent page.

    status: TaskState

    Filter tasks by their current status state.

    statusTimestampAfter: string | undefined

    Filter tasks which have a status updated after the provided timestamp in ISO 8601 format (e.g., "2023-10-27T10:00:00Z"). Only tasks with a status timestamp time greater than or equal to this value will be returned.

    tenant: string

    Tenant ID, provided as a path parameter.

    Settings
    Member Visibility

    On This Page
    Properties