The fields a developer search can use

Responses

• 200 The fields
  • ok boolean required
    true
  • fields array of DevsField required
    • name string required
    • type string | null required

      The kind of value the field holds, e.g. uint, float, string, []string, datetime.

    • ops array of string required

      The filter operators this field takes.

    • keyword boolean required

      Searchable as text: BM25 ranking and the token operators.

    • filterable boolean required

      May be used in `filters`.

    • sortable boolean required

      May be used to order results.

    • boostable boolean required

      May be used to boost a ranking.

    • displayable boolean required

      May be returned on a result with `include`.

    • rows string | null required

      What the field describes: profile, repo, role.

    • description string | null required
    • examples array of any required
• 400 The query does not compile; `hint` says what to change
  • ok boolean required
    false
  • error string required
  • hint string required
  • code string

    Why the index failed: index_busy, too_many_in_flight, engine_timeout, upstream_failed, ...

    bad_requestnot_foundindex_busytoo_many_in_flightengine_timeoutupstream_failednot_enabled
  • requestId string

    Quote it when reporting a failure

  • retryAfterMs integer

    Wait this long before retrying (also Retry-After, in seconds)

• 401 Missing or invalid API key
  • 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_errorbuild_failedself_serve_checkout_disabledwork_email_requiredtrial_unavailablecheckout_pendingchange_email_not_allowed
  • 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 how to restore access).

    • 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_mailboxbook_callcheckout
    • url string required

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

• 402 Your plan does not include this capability
  • 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_errorbuild_failedself_serve_checkout_disabledwork_email_requiredtrial_unavailablecheckout_pendingchange_email_not_allowed
  • 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 how to restore access).

    • 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_mailboxbook_callcheckout
    • url string required

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

• 403 The key lacks 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_errorbuild_failedself_serve_checkout_disabledwork_email_requiredtrial_unavailablecheckout_pendingchange_email_not_allowed
  • 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 how to restore access).

    • 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_mailboxbook_callcheckout
    • url string required

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

• 404 The seed is not in the index
  • ok boolean required
    false
  • error string required
  • hint string required
  • code string

    Why the index failed: index_busy, too_many_in_flight, engine_timeout, upstream_failed, ...

    bad_requestnot_foundindex_busytoo_many_in_flightengine_timeoutupstream_failednot_enabled
  • requestId string

    Quote it when reporting a failure

  • retryAfterMs integer

    Wait this long before retrying (also Retry-After, in seconds)

• 429 Rate limit (10 requests per second per key), or the index is busy; see Retry-After
  • ok boolean required
    false
  • error string required
  • hint string required
  • code string

    Why the index failed: index_busy, too_many_in_flight, engine_timeout, upstream_failed, ...

    bad_requestnot_foundindex_busytoo_many_in_flightengine_timeoutupstream_failednot_enabled
  • requestId string

    Quote it when reporting a failure

  • retryAfterMs integer

    Wait this long before retrying (also Retry-After, in seconds)

• 503 Search is not enabled in this environment, or the index is unavailable; see Retry-After
  • ok boolean required
    false
  • error string required
  • hint string required
  • code string

    Why the index failed: index_busy, too_many_in_flight, engine_timeout, upstream_failed, ...

    bad_requestnot_foundindex_busytoo_many_in_flightengine_timeoutupstream_failednot_enabled
  • requestId string

    Quote it when reporting a failure

  • retryAfterMs integer

    Wait this long before retrying (also Retry-After, in seconds)

• 504 The index did not answer in time; retry, and see Retry-After
  • ok boolean required
    false
  • error string required
  • hint string required
  • code string

    Why the index failed: index_busy, too_many_in_flight, engine_timeout, upstream_failed, ...

    bad_requestnot_foundindex_busytoo_many_in_flightengine_timeoutupstream_failednot_enabled
  • requestId string

    Quote it when reporting a failure

  • retryAfterMs integer

    Wait this long before retrying (also Retry-After, in seconds)