Skip to main content
GET
/
api
/
search
Search for code artifacts (Auth policies: ApiKeyOrJwt)
curl --request GET \
  --url https://app.codealive.ai/api/search \
  --header 'Authorization: Bearer <token>'
{
  "results": [
    {
      "kind": "<string>",
      "dataSource": {
        "type": "<string>",
        "id": "<string>",
        "name": "<string>"
      },
      "identifier": "<string>",
      "location": {
        "path": "<string>",
        "range": {
          "start": {
            "line": 123,
            "character": 123
          },
          "end": {
            "line": 123,
            "character": 123
          }
        }
      },
      "score": 123,
      "description": "<string>",
      "contentByteSize": 123,
      "snippet": "<string>",
      "content": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

API Key authentication using Bearer token. Example: "Authorization: Bearer {apiKey}"

Headers

​
CodeAlive-Version
string

Query Parameters

​
Query
string
​
DataSourceIds
string[]
​
Names
string[]
​
Mode
enum<string>
Available options:
Auto,
Fast,
FastComplex,
Deep
​
IncludeContent
boolean
​
DescriptionDetail
enum<string>
Available options:
Short,
Full
​
Limit
integer<int32>

Response

OK

​
results
object[] | null