Web Search Agents (public)

List Runs

List runs for this instance.

status accepts a lowercase TaskRunStatusValue (e.g. "completed") or a comma-separated list of them (e.g. "queued,running").

get/v1/task-agents/{agent_id}/runs

Path parameters

agent_idstring uuid required

Query parameters

offsetinteger
limitinteger

Response

Successful Response

limitinteger required

Maximum number of items returned.

offsetinteger required

Number of items skipped before this page.

totalinteger required

Total number of items matching the query.

Changes

Changed in 5 of the 55 revisions of this API.4818

    • added the new 5x-high enum value to the items/items/effort response property for the response status 200

      response-property-enum-value-added

    This revision also has 104 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • d4e4f170f4f4168See the full diff
    • for the query request parameter limit, default value was changed from 20 to 100

      request-parameter-default-value-changed

    • for the query request parameter limit, the max was set to 200.00

      request-parameter-max-set

    • for the query request parameter limit, the min was set to 1.00

      request-parameter-min-set

    • for the query request parameter offset, the min was set to 0.00

      request-parameter-min-set

    • deleted the query request parameter q

      request-parameter-removed

    • deleted the query request parameter status

      request-parameter-removed

    • removed the optional property items/items/workspace_id from the response with the 200 status

      response-optional-property-removed

    • api operation id list_runs_api_v2_public_web_search_agents__agent_id__runs_get removed and replaced with list_runs_public_v1_api_v1_public_web_search_agents__agent_id__runs_get

      api-operation-id-removed

    • endpoint deprecated

      endpoint-deprecated

    • added TaskRunErrorPublicV1 to the items/items/error response property anyOf list for the response status 200

      response-property-any-of-added

    • removed TaskRunError from the items/items/error response property anyOf list for the response status 200

      response-property-any-of-removed

    • the response property limit became required for the status 200

      response-property-became-required

    • the response property offset became required for the status 200

      response-property-became-required

    • the limit response's property default value 20 was removed for the status 200

      response-property-default-value-removed

    • the offset response's property default value 0 was removed for the status 200

      response-property-default-value-removed

    This revision also has 36 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • e8a97dc9fce2219See the full diff
    • for the path request parameter agent_id, the type/format was changed from string/ to string/uuid

      request-parameter-type-changed

    • the response's body type/format changed from array/ to object/ for status 200

      response-body-type-changed

    • deleted the cookie request parameter token

      request-parameter-removed

    • api operation id list_runs_v2_web_search_agents__agent_id__runs_get removed and replaced with list_runs_api_v2_public_web_search_agents__agent_id__runs_get

      api-operation-id-removed

    • api tag Web Search Agents (public) added

      api-tag-added

    • api tag Web Search Agents removed

      api-tag-removed

    • added the new optional query request parameter q

      new-optional-request-parameter

    • added the new optional query request parameter status

      new-optional-request-parameter

    • added the optional property limit to the response with the 200 status

      response-optional-property-added

    • added the optional property offset to the response with the 200 status

      response-optional-property-added

    • added the required property items to the response with the 200 status

      response-required-property-added

    • added the required property total to the response with the 200 status

      response-required-property-added

    This revision also has 39 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • the items/web_search_agent_id/anyOf[subschema #1]/ response's property type/format changed from string/uuid to string/ for status 200

      response-property-type-changed

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • endpoint added

      endpoint-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog