/v2/developers/fieldsThe fields a developer search can use
search:readEvery index field with its type, operators, what it may be used for (filter, sort, boost, include), its readiness status and coverage. A disabled field is refused with a 400; any other non-live field runs and is listed in a response's not_live. Cached 30 seconds. Free.
Responses
200The registryokboolean requiredtrueregistrystring requiredliveunavailablefieldsarray of DevsField requirednamestring requiredtypestring | null requiredTurbopuffer type, e.g. uint, float, string, []string, datetime.
opsarray of string requiredThe filter operators this field takes.
keywordboolean requiredFull-text indexed: BM25 and the token operators.
filterableboolean requiredsortableboolean requiredboostableboolean requireddisplayableboolean requiredstatusstring requiredlivevalidatedbackfilledcollectingplanneddisabledcoverage_pctnumber | null requiredrowsstring | null requiredRow kinds that carry it: profile, repo, role.
descriptionstring | null requiredexamplesarray of any required
400The query does not compile; `hint` says what to changeokboolean requiredfalseerrorstring requiredhintstring required
401Missing or invalid API keycodestring requiredStable 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_failedmessagestring requiredHuman-readable explanation of the refusal.
statusinteger requiredThe HTTP status code, repeated in the body.
remedyobjectA self-serve path forward, when one exists (a 402 points at how to restore access).
kindstring requiredWhat 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_mailboxurlstring requiredWhere to go to clear the condition: an API path, or a web app page when only a person can.
402Your plan does not include this capabilitycodestring requiredStable 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_failedmessagestring requiredHuman-readable explanation of the refusal.
statusinteger requiredThe HTTP status code, repeated in the body.
remedyobjectA self-serve path forward, when one exists (a 402 points at how to restore access).
kindstring requiredWhat 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_mailboxurlstring requiredWhere to go to clear the condition: an API path, or a web app page when only a person can.
403The key lacks search:readcodestring requiredStable 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_failedmessagestring requiredHuman-readable explanation of the refusal.
statusinteger requiredThe HTTP status code, repeated in the body.
remedyobjectA self-serve path forward, when one exists (a 402 points at how to restore access).
kindstring requiredWhat 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_mailboxurlstring requiredWhere to go to clear the condition: an API path, or a web app page when only a person can.
404The seed is not in the indexokboolean requiredfalseerrorstring requiredhintstring required
429Rate limit (10 requests per second per key), or the index is busy; see Retry-Afterokboolean requiredfalseerrorstring requiredhintstring required
503Search is not enabled in this environment, or the index is unavailable; see Retry-Afterokboolean requiredfalseerrorstring requiredhintstring required