LangChain Reference home pageLangChain ReferenceLangChain Reference
  • GitHub
  • Main Docs
Deep Agents
LangChain
LangGraph
Integrations
LangSmith
  • Overview
  • LangGraph Checkpoint
    LangGraph Store
    Checkpoint Postgres
    Store Postgres
    Checkpoint SQLite
    LangGraph Prebuilt
    LangGraph CLI
    LangGraph SDK
    LangGraph Supervisor
    LangGraph Swarm
    ⌘I

    LangChain Assistant

    Ask a question to get started

    Enter to send•Shift+Enter new line

    Menu

    LangGraph Checkpoint
    LangGraph Store
    Checkpoint Postgres
    Store Postgres
    Checkpoint SQLite
    LangGraph Prebuilt
    LangGraph CLI
    LangGraph SDK
    LangGraph Supervisor
    LangGraph Swarm
    Language
    Theme
    Pythonlanggraph-sdk_synccronSyncCronClientsearch
    Method●Since v0.3

    search

    Copy
    search(
      self,
      *,
      assistant_id: str | None = None,
      thread_id: str
    View source on GitHub
    |
    None
    =
    None
    ,
    enabled
    :
    bool
    |
    None
    =
    None
    ,
    metadata
    :
    Json
    =
    None
    ,
    limit
    :
    int
    =
    10
    ,
    offset
    :
    int
    =
    0
    ,
    sort_by
    :
    CronSortBy
    |
    None
    =
    None
    ,
    sort_order
    :
    SortOrder
    |
    None
    =
    None
    ,
    select
    :
    list
    [
    CronSelectField
    ]
    |
    None
    =
    None
    ,
    headers
    :
    Mapping
    [
    str
    ,
    str
    ]
    |
    None
    =
    None
    ,
    params
    :
    QueryParamTypes
    |
    None
    =
    None
    )
    ->
    list
    [
    Cron
    ]

    Parameters

    NameTypeDescription
    assistant_idstr | None
    Default:None

    The assistant ID or graph name to search for.

    thread_idstr | None
    Default:None

    the thread ID to search for.

    enabledbool | None
    Default:None
    metadataJson
    Default:None
    limitint
    Default:10
    offsetint
    Default:0
    headersMapping[str, str] | None
    Default:None

    Get a list of cron jobs.

    client = get_sync_client(url="http://localhost:8123")
    cron_jobs = client.crons.search(
        assistant_id="my_assistant_id",
        thread_id="my_thread_id",
        enabled=True,
        limit=5,
        offset=5,
    )
    print(cron_jobs)
    ----------------------------------------------------------
    
    [
        {
            'cron_id': '1ef3cefa-4c09-6926-96d0-3dc97fd5e39b',
            'assistant_id': 'my_assistant_id',
            'thread_id': 'my_thread_id',
            'user_id': None,
            'payload':
                {
                    'input': {'start_time': ''},
                    'schedule': '4 * * * *',
                    'assistant_id': 'my_assistant_id'
                },
            'schedule': '4 * * * *',
            'next_run_date': '2024-07-25T17:04:00+00:00',
            'end_time': None,
            'created_at': '2024-07-08T06:02:23.073257+00:00',
            'updated_at': '2024-07-08T06:02:23.073257+00:00'
        }
    ]

    Whether the cron job is enabled.

    Metadata to filter by. Exact match filter for each KV pair.

    The maximum number of results to return.

    The number of results to skip.

    Optional custom headers to include with the request.