Plan a search from natural language

Request body PlanSearchRequest

Responses

• 200 The plan, and what it cannot promise
  • plan object required

    The plan to run. Edit it and POST it to /v1/searches/run.

    • intent string required
      max 300 chars
    • lanes array of one of required
      min 1 items, max 4 items
      Option 1

      • kind string required
        users.bm25
      • text string required
        min 1 chars, max 200 chars

      Option 2

      • kind string required
        users.rank
      • attribute string required
        createdAt
      • direction string required
        ascdesc

      Option 3

      • kind string required
        repos.ann
      • text string required
        min 1 chars, max 500 chars
      • repoFilters array of array
        max 6 items

      Option 4

      • kind string required
        repos.bm25
      • text string required
        min 1 chars, max 200 chars
      • repoFilters array of array
        max 6 items

      Option 5

      • kind string required
        linkedin.ann
      • text string required
        min 1 chars, max 500 chars
      • liFilters array of array
        max 6 items

      Option 6

      • kind string required
        users.ann
      • text string required
        min 1 chars, max 500 chars
    • userFilters array of array default: []
      max 8 items
    • post object
      • minDevrankTier string
        EliteRareSolid
    • fuse object default: {"method":"rrf","k":60}
      • method string required
        rrf
      • k integer default: 60
        min 1, max 200
  • warnings array of string required

    What this plan cannot honestly promise: coverage gaps it relies on, preferences that are ranked rather than filtered, and any part of the ask this corpus cannot answer.

    max 100 items
• 401 No or invalid credential
  • code string required

    Stable machine-readable error code. Branch on this, never on the numeric status.

    bad_requestunauthorizedsignature_requiredpayment_requiredforbiddennot_foundconflictgonepayload_too_largeunprocessable_entitytoo_many_requestsinternal_errornot_implementedbilling_unavailablenot_contactablemailbox_link_unavailablemailbox_requiredmail_engine_unavailablewebhook_publisher_unavailabledatabase_unavailableclient_error
  • message string required

    Human-readable explanation of the refusal.

  • status integer required

    The HTTP status code, repeated in the body.

  • remedy object

    A self-serve path forward, when one exists (a 402 points at the credit top-up).

    • kind string required

      What kind of remedy this is, so a client can route it: whether the caller can clear the condition through the API, or a person must act in the web app.

      topupconnect_mailbox
    • url string required

      Where to go to clear the condition: an API path, or a web app page when only a person can.

• 403 Missing search:read
  • code string required

    Stable machine-readable error code. Branch on this, never on the numeric status.

    bad_requestunauthorizedsignature_requiredpayment_requiredforbiddennot_foundconflictgonepayload_too_largeunprocessable_entitytoo_many_requestsinternal_errornot_implementedbilling_unavailablenot_contactablemailbox_link_unavailablemailbox_requiredmail_engine_unavailablewebhook_publisher_unavailabledatabase_unavailableclient_error
  • message string required

    Human-readable explanation of the refusal.

  • status integer required

    The HTTP status code, repeated in the body.

  • remedy object

    A self-serve path forward, when one exists (a 402 points at the credit top-up).

    • kind string required

      What kind of remedy this is, so a client can route it: whether the caller can clear the condition through the API, or a person must act in the web app.

      topupconnect_mailbox
    • url string required

      Where to go to clear the condition: an API path, or a web app page when only a person can.

• 422 The request could not be turned into a plan (UNPLANNABLE)
  • code string required

    Stable machine-readable error code. Branch on this, never on the numeric status.

    bad_requestunauthorizedsignature_requiredpayment_requiredforbiddennot_foundconflictgonepayload_too_largeunprocessable_entitytoo_many_requestsinternal_errornot_implementedbilling_unavailablenot_contactablemailbox_link_unavailablemailbox_requiredmail_engine_unavailablewebhook_publisher_unavailabledatabase_unavailableclient_error
  • message string required

    Human-readable explanation of the refusal.

  • status integer required

    The HTTP status code, repeated in the body.

  • remedy object

    A self-serve path forward, when one exists (a 402 points at the credit top-up).

    • kind string required

      What kind of remedy this is, so a client can route it: whether the caller can clear the condition through the API, or a person must act in the web app.

      topupconnect_mailbox
    • url string required

      Where to go to clear the condition: an API path, or a web app page when only a person can.

• 502 The planner is unavailable
  • code string required

    Stable machine-readable error code. Branch on this, never on the numeric status.

    bad_requestunauthorizedsignature_requiredpayment_requiredforbiddennot_foundconflictgonepayload_too_largeunprocessable_entitytoo_many_requestsinternal_errornot_implementedbilling_unavailablenot_contactablemailbox_link_unavailablemailbox_requiredmail_engine_unavailablewebhook_publisher_unavailabledatabase_unavailableclient_error
  • message string required

    Human-readable explanation of the refusal.

  • status integer required

    The HTTP status code, repeated in the body.

  • remedy object

    A self-serve path forward, when one exists (a 402 points at the credit top-up).

    • kind string required

      What kind of remedy this is, so a client can route it: whether the caller can clear the condition through the API, or a person must act in the web app.

      topupconnect_mailbox
    • url string required

      Where to go to clear the condition: an API path, or a web app page when only a person can.