Retrieval

Search indexed developer documentation

Searches indexed sources only; this operation never starts ingestion or contacts upstream sources. The current ready source is go:docs and it covers only the 18 selected verified pages documented by developer-sources. Search matches Unicode-aware lexical terms and punctuation-bearing identifiers such as context.Context; passages retain byte/line locators into the indexed document. types accepts doc, readme, issue, and pull_request, but the current source supports only doc; unsupported values return 400. The version filter is not supported by the current unversioned source and returns 400. Continuation bodies contain only cursor and optional limit; their pages come from the frozen snapshot and do not repeat the search.

post/developer/search

Request

  • Base URL: https://api.crawlora.net/api/v1
  • URL: https://api.crawlora.net/api/v1/developer/search
  • Auth: API key in header x-api-key

Headers

Authorizationstring

Dashboard JWT in the form Token <jwt> (use this or x-api-key)

x-api-keystring

API key (alternative to a dashboard JWT)

Request body

cursorstring
limitinteger
passages_per_resultinteger
qstring
sourcesstring[]
typesDeveloperretrievalArtifactType[]
versionstring

Response

Ranked developer results and source coverage

codeinteger
msgstring

Example response

{
  "code": 200,
  "msg": "Request successful"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.