Knowledge Base Files

Operations for the Knowledge Base Files service collection.

Language	Last Update
Python	v1.6.5
PowerShell
Go	v0.22.0
TypeScript	v0.6.0
Rust
Ruby	v1.4.0

---

---

Table of Contents

Operation	Description
EntitiesKnowledgeBaseFilesCreateV1 entities_knowledge_base_files_create_v1	Upload a file to a knowledge base.
EntitiesKnowledgeBaseFilesDeleteV1 entities_knowledge_base_files_delete_v1	Delete document from knowledge base.
EntitiesKnowledgeBaseFilesDownloadV1 entities_knowledge_base_files_download_v1	Download knowledge base file entities for the provided id.
EntitiesKnowledgeBaseFilesUpdateV1 entities_knowledge_base_files_update_v1	Update an existing file in a knowledge base.
EntitiesKnowledgeBaseFilesV1 entities_knowledge_base_files_v1	Retrieve knowledge base file entities for the provided id.
QueriesKnowledgeBaseFilesV1 queries_knowledge_base_files_v1	Query knowledge base files based on the provided filters.

---

EntitiesKnowledgeBaseFilesCreateV1

Upload a file to a knowledge base.

Method POST

Route /agentic-studio/entities/knowledge_base_files/v1

Scope Charlotte AI Agent Definition: WRITE

PEP 8 entities_knowledge_base_files_create_v1

Parameters

knowledge_base_id body · string

ID of the knowledge base

file body · file

File to be uploaded

file_description body · string

Description for the uploaded file

file_name body · string

Name to use for the uploaded file.

Code Examples

Python

PEP 8

from falconpy import KnowledgeBaseFiles

falcon = KnowledgeBaseFiles(client_id=CLIENT_ID,
                            client_secret=CLIENT_SECRET
                            )

response = falcon.entities_knowledge_base_files_create_v1(file_name="string",
                                                          knowledge_base_id="string",
                                                          file="string",
                                                          file_description="string")
print(response)

Operation ID

from falconpy import KnowledgeBaseFiles

falcon = KnowledgeBaseFiles(client_id=CLIENT_ID,
                            client_secret=CLIENT_SECRET
                            )

response = falcon.EntitiesKnowledgeBaseFilesCreateV1(file_name="string",
                                                     knowledge_base_id="string",
                                                     file="string",
                                                     file_description="string")
print(response)

Uber

from falconpy import APIHarnessV2

falcon = APIHarnessV2(client_id=CLIENT_ID,
                      client_secret=CLIENT_SECRET
                      )

response = falcon.command("EntitiesKnowledgeBaseFilesCreateV1",
                          knowledge_base_id="string",
                          file_data=open("filename", "rb").read(),
                          file_description="string")
print(response)

PowerShell

Examples coming soon.

Go

package main

import (
  "context"
  "fmt"
  "os"

  "github.com/crowdstrike/gofalcon/falcon"
  "github.com/crowdstrike/gofalcon/falcon/client/knowledge_base_files"
)

func main() {
  client, err := falcon.NewClient(&falcon.ApiConfig{
    ClientId:     os.Getenv("FALCON_CLIENT_ID"),
    ClientSecret: os.Getenv("FALCON_CLIENT_SECRET"),
    Context:      context.Background(),
  })
  if err != nil {
    panic(err)
  }

  fileDescription := "string"

  response, err := client.KnowledgeBaseFiles.EntitiesKnowledgeBaseFilesCreateV1(
    &knowledge_base_files.EntitiesKnowledgeBaseFilesCreateV1Params{
      KnowledgeBaseID: "string",
      FileDescription: &fileDescription,
      Context: context.Background(),
    },
  )
  if err != nil {
    panic(falcon.ErrorExplain(err))
  }

  fmt.Printf("%+v\n", response.Payload)
}

TypeScript

import { FalconClient } from "crowdstrike-falcon";

const client = new FalconClient({
  cloud: process.env.FALCON_CLOUD!,
  clientId: process.env.FALCON_CLIENT_ID!,
  clientSecret: process.env.FALCON_CLIENT_SECRET!,
});

const response = await client.knowledgeBaseFiles.entitiesKnowledgeBaseFilesCreateV1(
  "string",  // knowledgeBaseId
  "string",  // file
  "string"  // fileDescription
);

console.log(response);

Rust

Examples coming soon.

Ruby

require "crimson-falcon"

Falcon.configure do |config|
  config.client_id = ENV["FALCON_CLIENT_ID"]
  config.client_secret = ENV["FALCON_CLIENT_SECRET"]
  config.cloud = ENV["FALCON_CLOUD"]
end

api = Falcon::KnowledgeBaseFiles.new

response = api.entities_knowledge_base_files_create_v1('string', 'string')

puts response

Responses

202 Upload accepted and processing started

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  },
  "resources": [
    {
      "content_type": "string",
      "created_at": "string",
      "created_by": {},
      "id": "string",
      "is_deleted": false,
      "knowledge_base_id": "string",
      "metadata": {},
      "name": "string",
      "size": 0,
      "status": "string",
      "updated_at": "string",
      "updated_by": {}
    }
  ]
}

400 Bad Request

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

403 Forbidden

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

409 File with this name already exists in the knowledge base

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

429 Too Many Requests

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

500 Internal Server Error

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

---

---

EntitiesKnowledgeBaseFilesDeleteV1

Delete document from knowledge base.

Method DELETE

Route /agentic-studio/entities/knowledge_base_files/v1

Scope Charlotte AI Agent Definition: WRITE

PEP 8 entities_knowledge_base_files_delete_v1

Parameters

knowledge_base_id query · string

ID of the knowledge base

id query · string

ID of the document to delete

parameters query · dictionary

Full query string parameters payload in JSON format. Not required when using other keywords.

Code Examples

Python

PEP 8

from falconpy import KnowledgeBaseFiles

falcon = KnowledgeBaseFiles(client_id=CLIENT_ID,
                            client_secret=CLIENT_SECRET
                            )

response = falcon.entities_knowledge_base_files_delete_v1(knowledge_base_id="string",
                                                          id="string")
print(response)

Operation ID

from falconpy import KnowledgeBaseFiles

falcon = KnowledgeBaseFiles(client_id=CLIENT_ID,
                            client_secret=CLIENT_SECRET
                            )

response = falcon.EntitiesKnowledgeBaseFilesDeleteV1(knowledge_base_id="string",
                                                     id="string")
print(response)

Uber

from falconpy import APIHarnessV2

falcon = APIHarnessV2(client_id=CLIENT_ID,
                      client_secret=CLIENT_SECRET
                      )

response = falcon.command("EntitiesKnowledgeBaseFilesDeleteV1",
                          knowledge_base_id="string",
                          id="string")
print(response)

PowerShell

Examples coming soon.

Go

package main

import (
  "context"
  "fmt"
  "os"

  "github.com/crowdstrike/gofalcon/falcon"
  "github.com/crowdstrike/gofalcon/falcon/client/knowledge_base_files"
)

func main() {
  client, err := falcon.NewClient(&falcon.ApiConfig{
    ClientId:     os.Getenv("FALCON_CLIENT_ID"),
    ClientSecret: os.Getenv("FALCON_CLIENT_SECRET"),
    Context:      context.Background(),
  })
  if err != nil {
    panic(err)
  }

  response, err := client.KnowledgeBaseFiles.EntitiesKnowledgeBaseFilesDeleteV1(
    &knowledge_base_files.EntitiesKnowledgeBaseFilesDeleteV1Params{
      KnowledgeBaseID: "string",
      ID: "string",
      Context: context.Background(),
    },
  )
  if err != nil {
    panic(falcon.ErrorExplain(err))
  }

  fmt.Printf("%+v\n", response.Payload)
}

TypeScript

import { FalconClient } from "crowdstrike-falcon";

const client = new FalconClient({
  cloud: process.env.FALCON_CLOUD!,
  clientId: process.env.FALCON_CLIENT_ID!,
  clientSecret: process.env.FALCON_CLIENT_SECRET!,
});

const response = await client.knowledgeBaseFiles.entitiesKnowledgeBaseFilesDeleteV1(
  "string",  // knowledgeBaseId
  "string"  // id
);

console.log(response);

Rust

Examples coming soon.

Ruby

require "crimson-falcon"

Falcon.configure do |config|
  config.client_id = ENV["FALCON_CLIENT_ID"]
  config.client_secret = ENV["FALCON_CLIENT_SECRET"]
  config.cloud = ENV["FALCON_CLOUD"]
end

api = Falcon::KnowledgeBaseFiles.new

response = api.entities_knowledge_base_files_delete_v1('string', 'string')

puts response

Responses

200 Successfully deleted

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

403 Forbidden

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

404 Not Found

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

429 Too Many Requests

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

500 Internal Server Error

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

---

---

EntitiesKnowledgeBaseFilesDownloadV1

Download knowledge base file entities for the provided id.

Method GET

Route /agentic-studio/entities/knowledge_base_files/download/v1

Scope Charlotte AI Agent Definition: READ

PEP 8 entities_knowledge_base_files_download_v1

Parameters

knowledge_base_id query · string

ID of the knowledge base

id query · string

ID of entities to retrieve.

parameters query · dictionary

Full query string parameters payload in JSON format. Not required when using other keywords.

Code Examples

Python

PEP 8

from falconpy import KnowledgeBaseFiles

falcon = KnowledgeBaseFiles(client_id=CLIENT_ID,
                            client_secret=CLIENT_SECRET
                            )

with open("output_file", "wb") as save_file:
    response = falcon.entities_knowledge_base_files_download_v1(knowledge_base_id="string",
                                                                id="string",
                                                                stream=boolean)
    save_file.write(response)

Operation ID

from falconpy import KnowledgeBaseFiles

falcon = KnowledgeBaseFiles(client_id=CLIENT_ID,
                            client_secret=CLIENT_SECRET
                            )

with open("output_file", "wb") as save_file:
    response = falcon.EntitiesKnowledgeBaseFilesDownloadV1(knowledge_base_id="string",
                                                           id="string",
                                                           stream=boolean)
    save_file.write(response)

Uber

from falconpy import APIHarnessV2

falcon = APIHarnessV2(client_id=CLIENT_ID,
                      client_secret=CLIENT_SECRET
                      )

with open("output_file", "wb") as save_file:
    response = falcon.command("EntitiesKnowledgeBaseFilesDownloadV1",
                              knowledge_base_id="string",
                              id="string")
    save_file.write(response)

PowerShell

Examples coming soon.

Go

package main

import (
  "context"
  "fmt"
  "os"

  "github.com/crowdstrike/gofalcon/falcon"
  "github.com/crowdstrike/gofalcon/falcon/client/knowledge_base_files"
)

func main() {
  client, err := falcon.NewClient(&falcon.ApiConfig{
    ClientId:     os.Getenv("FALCON_CLIENT_ID"),
    ClientSecret: os.Getenv("FALCON_CLIENT_SECRET"),
    Context:      context.Background(),
  })
  if err != nil {
    panic(err)
  }

  response, err := client.KnowledgeBaseFiles.EntitiesKnowledgeBaseFilesDownloadV1(
    &knowledge_base_files.EntitiesKnowledgeBaseFilesDownloadV1Params{
      KnowledgeBaseID: "string",
      ID: "string",
      Context: context.Background(),
    },
  )
  if err != nil {
    panic(falcon.ErrorExplain(err))
  }

  fmt.Printf("%+v\n", response.Payload)
}

TypeScript

import { FalconClient } from "crowdstrike-falcon";

const client = new FalconClient({
  cloud: process.env.FALCON_CLOUD!,
  clientId: process.env.FALCON_CLIENT_ID!,
  clientSecret: process.env.FALCON_CLIENT_SECRET!,
});

const response = await client.knowledgeBaseFiles.entitiesKnowledgeBaseFilesDownloadV1(
  "string",  // knowledgeBaseId
  "string"  // id
);

console.log(response);

Rust

Examples coming soon.

Ruby

require "crimson-falcon"

Falcon.configure do |config|
  config.client_id = ENV["FALCON_CLIENT_ID"]
  config.client_secret = ENV["FALCON_CLIENT_SECRET"]
  config.cloud = ENV["FALCON_CLOUD"]
end

api = Falcon::KnowledgeBaseFiles.new

response = api.entities_knowledge_base_files_download_v1('string', 'string')

puts response

Responses

403 Forbidden

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

404 Not Found

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

429 Too Many Requests

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

500 Internal Server Error

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

---

---

EntitiesKnowledgeBaseFilesUpdateV1

Update an existing file in a knowledge base.

Method PUT

Route /agentic-studio/entities/knowledge_base_files/v1

Scope Charlotte AI Agent Definition: WRITE

PEP 8 entities_knowledge_base_files_update_v1

Parameters

id body · string

ID of the document to update

file body · file

New file content to replace the existing document

file_description body · string

New description for the document

file_name body · string

Name to use for the uploaded file.

Code Examples

Python

PEP 8

from falconpy import KnowledgeBaseFiles

falcon = KnowledgeBaseFiles(client_id=CLIENT_ID,
                            client_secret=CLIENT_SECRET
                            )

response = falcon.entities_knowledge_base_files_update_v1(file_name="string",
                                                          id="string",
                                                          file="string",
                                                          file_description="string")
print(response)

Operation ID

from falconpy import KnowledgeBaseFiles

falcon = KnowledgeBaseFiles(client_id=CLIENT_ID,
                            client_secret=CLIENT_SECRET
                            )

response = falcon.EntitiesKnowledgeBaseFilesUpdateV1(file_name="string",
                                                     id="string",
                                                     file="string",
                                                     file_description="string")
print(response)

Uber

from falconpy import APIHarnessV2

falcon = APIHarnessV2(client_id=CLIENT_ID,
                      client_secret=CLIENT_SECRET
                      )

response = falcon.command("EntitiesKnowledgeBaseFilesUpdateV1",
                          id="string",
                          file_data=open("filename", "rb").read(),
                          file_description="string")
print(response)

PowerShell

Examples coming soon.

Go

package main

import (
  "context"
  "fmt"
  "os"

  "github.com/crowdstrike/gofalcon/falcon"
  "github.com/crowdstrike/gofalcon/falcon/client/knowledge_base_files"
)

func main() {
  client, err := falcon.NewClient(&falcon.ApiConfig{
    ClientId:     os.Getenv("FALCON_CLIENT_ID"),
    ClientSecret: os.Getenv("FALCON_CLIENT_SECRET"),
    Context:      context.Background(),
  })
  if err != nil {
    panic(err)
  }

  fileDescription := "string"

  response, err := client.KnowledgeBaseFiles.EntitiesKnowledgeBaseFilesUpdateV1(
    &knowledge_base_files.EntitiesKnowledgeBaseFilesUpdateV1Params{
      ID: "string",
      FileDescription: &fileDescription,
      Context: context.Background(),
    },
  )
  if err != nil {
    panic(falcon.ErrorExplain(err))
  }

  fmt.Printf("%+v\n", response.Payload)
}

TypeScript

import { FalconClient } from "crowdstrike-falcon";

const client = new FalconClient({
  cloud: process.env.FALCON_CLOUD!,
  clientId: process.env.FALCON_CLIENT_ID!,
  clientSecret: process.env.FALCON_CLIENT_SECRET!,
});

const response = await client.knowledgeBaseFiles.entitiesKnowledgeBaseFilesUpdateV1(
  "string",  // id
  "string",  // file
  "string"  // fileDescription
);

console.log(response);

Rust

Examples coming soon.

Ruby

require "crimson-falcon"

Falcon.configure do |config|
  config.client_id = ENV["FALCON_CLIENT_ID"]
  config.client_secret = ENV["FALCON_CLIENT_SECRET"]
  config.cloud = ENV["FALCON_CLOUD"]
end

api = Falcon::KnowledgeBaseFiles.new

response = api.entities_knowledge_base_files_update_v1('string', 'string')

puts response

Responses

202 Update accepted, processing started

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  },
  "resources": [
    {
      "content_type": "string",
      "created_at": "string",
      "created_by": {},
      "id": "string",
      "is_deleted": false,
      "knowledge_base_id": "string",
      "metadata": {},
      "name": "string",
      "size": 0,
      "status": "string",
      "updated_at": "string",
      "updated_by": {}
    }
  ]
}

400 Bad Request

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

403 Forbidden

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

404 Not Found

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

409 File with this name already exists in the knowledge base

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

429 Too Many Requests

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

500 Internal Server Error

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

---

---

EntitiesKnowledgeBaseFilesV1

Retrieve knowledge base file entities for the provided id.

Method GET

Route /agentic-studio/entities/knowledge_base_files/v1

Scope Charlotte AI Agent Definition: READ

PEP 8 entities_knowledge_base_files_v1

Parameters

knowledge_base_id query · string

ID of the knowledge base

ids query · string or list of strings

IDs of entities to retrieve.

include_deleted query · boolean

Include deleted knowledge base files in the result. Defaults to false.

parameters query · dictionary

Full query string parameters payload in JSON format. Not required when using other keywords.

Code Examples

Python

PEP 8

from falconpy import KnowledgeBaseFiles

falcon = KnowledgeBaseFiles(client_id=CLIENT_ID,
                            client_secret=CLIENT_SECRET
                            )

id_list = 'ID1,ID2,ID3'  # Can also pass a list here: ['ID1', 'ID2', 'ID3']

response = falcon.entities_knowledge_base_files_v1(knowledge_base_id="string",
                                                   ids=id_list,
                                                   include_deleted=boolean)
print(response)

Operation ID

from falconpy import KnowledgeBaseFiles

falcon = KnowledgeBaseFiles(client_id=CLIENT_ID,
                            client_secret=CLIENT_SECRET
                            )

id_list = 'ID1,ID2,ID3'  # Can also pass a list here: ['ID1', 'ID2', 'ID3']

response = falcon.EntitiesKnowledgeBaseFilesV1(knowledge_base_id="string",
                                               ids=id_list,
                                               include_deleted=boolean)
print(response)

Uber

from falconpy import APIHarnessV2

falcon = APIHarnessV2(client_id=CLIENT_ID,
                      client_secret=CLIENT_SECRET
                      )

id_list = 'ID1,ID2,ID3'  # Can also pass a list here: ['ID1', 'ID2', 'ID3']

response = falcon.command("EntitiesKnowledgeBaseFilesV1",
                          knowledge_base_id="string",
                          ids=id_list,
                          include_deleted=boolean)
print(response)

PowerShell

Examples coming soon.

Go

package main

import (
  "context"
  "fmt"
  "os"

  "github.com/crowdstrike/gofalcon/falcon"
  "github.com/crowdstrike/gofalcon/falcon/client/knowledge_base_files"
)

func main() {
  client, err := falcon.NewClient(&falcon.ApiConfig{
    ClientId:     os.Getenv("FALCON_CLIENT_ID"),
    ClientSecret: os.Getenv("FALCON_CLIENT_SECRET"),
    Context:      context.Background(),
  })
  if err != nil {
    panic(err)
  }

  includeDeleted := boolean

  response, err := client.KnowledgeBaseFiles.EntitiesKnowledgeBaseFilesV1(
    &knowledge_base_files.EntitiesKnowledgeBaseFilesV1Params{
      KnowledgeBaseID: "string",
      Ids: []string{"ID1", "ID2", "ID3"},
      IncludeDeleted: &includeDeleted,
      Context: context.Background(),
    },
  )
  if err != nil {
    panic(falcon.ErrorExplain(err))
  }

  fmt.Printf("%+v\n", response.Payload)
}

TypeScript

import { FalconClient } from "crowdstrike-falcon";

const client = new FalconClient({
  cloud: process.env.FALCON_CLOUD!,
  clientId: process.env.FALCON_CLIENT_ID!,
  clientSecret: process.env.FALCON_CLIENT_SECRET!,
});

const response = await client.knowledgeBaseFiles.entitiesKnowledgeBaseFilesV1(
  "string",  // knowledgeBaseId
  ["ID1", "ID2", "ID3"],  // ids
  boolean  // includeDeleted
);

console.log(response);

Rust

Examples coming soon.

Ruby

require "crimson-falcon"

Falcon.configure do |config|
  config.client_id = ENV["FALCON_CLIENT_ID"]
  config.client_secret = ENV["FALCON_CLIENT_SECRET"]
  config.cloud = ENV["FALCON_CLOUD"]
end

api = Falcon::KnowledgeBaseFiles.new

response = api.entities_knowledge_base_files_v1('string', ['ID1', 'ID2', 'ID3'])

puts response

Responses

200 Successfully retrieved

[
  {
    "content_type": "string",
    "created_at": "string",
    "created_by": {},
    "id": "string",
    "is_deleted": false,
    "knowledge_base_id": "string",
    "metadata": {},
    "name": "string",
    "size": 0,
    "status": "string",
    "updated_at": "string",
    "updated_by": {}
  }
]

403 Forbidden

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

404 Not Found

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

429 Too Many Requests

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

500 Internal Server Error

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

---

---

QueriesKnowledgeBaseFilesV1

Query knowledge base files based on the provided filters.

Method GET

Route /agentic-studio/queries/knowledge_base_files/v1

Scope Charlotte AI Agent Definition: READ

PEP 8 queries_knowledge_base_files_v1

Parameters

knowledge_base_id query · string

ID of the knowledge base

offset query · integer

Starting index of overall result set from which to return ids.

limit query · integer

Number of IDs to return. Offset + limit should NOT be above 10K.

filter query · string

FQL query specifying the filter parameters.

include_deleted query · boolean

Include deleted knowledge base files in the result. Defaults to false.

parameters query · dictionary

Full query string parameters payload in JSON format. Not required when using other keywords.

Code Examples

Python

PEP 8

from falconpy import KnowledgeBaseFiles

falcon = KnowledgeBaseFiles(client_id=CLIENT_ID,
                            client_secret=CLIENT_SECRET
                            )

response = falcon.queries_knowledge_base_files_v1(knowledge_base_id="string",
                                                  offset=integer,
                                                  limit=integer,
                                                  filter="string",
                                                  include_deleted=boolean)
print(response)

Operation ID

from falconpy import KnowledgeBaseFiles

falcon = KnowledgeBaseFiles(client_id=CLIENT_ID,
                            client_secret=CLIENT_SECRET
                            )

response = falcon.QueriesKnowledgeBaseFilesV1(knowledge_base_id="string",
                                              offset=integer,
                                              limit=integer,
                                              filter="string",
                                              include_deleted=boolean)
print(response)

Uber

from falconpy import APIHarnessV2

falcon = APIHarnessV2(client_id=CLIENT_ID,
                      client_secret=CLIENT_SECRET
                      )

response = falcon.command("QueriesKnowledgeBaseFilesV1",
                          knowledge_base_id="string",
                          offset=integer,
                          limit=integer,
                          filter="string",
                          include_deleted=boolean)
print(response)

PowerShell

Examples coming soon.

Go

package main

import (
  "context"
  "fmt"
  "os"

  "github.com/crowdstrike/gofalcon/falcon"
  "github.com/crowdstrike/gofalcon/falcon/client/knowledge_base_files"
)

func main() {
  client, err := falcon.NewClient(&falcon.ApiConfig{
    ClientId:     os.Getenv("FALCON_CLIENT_ID"),
    ClientSecret: os.Getenv("FALCON_CLIENT_SECRET"),
    Context:      context.Background(),
  })
  if err != nil {
    panic(err)
  }

  offset := int64(0)
  limit := int64(0)
  filter := "string"
  includeDeleted := boolean

  response, err := client.KnowledgeBaseFiles.QueriesKnowledgeBaseFilesV1(
    &knowledge_base_files.QueriesKnowledgeBaseFilesV1Params{
      KnowledgeBaseID: "string",
      Offset: &offset,
      Limit: &limit,
      Filter: &filter,
      IncludeDeleted: &includeDeleted,
      Context: context.Background(),
    },
  )
  if err != nil {
    panic(falcon.ErrorExplain(err))
  }

  fmt.Printf("%+v\n", response.Payload)
}

TypeScript

import { FalconClient } from "crowdstrike-falcon";

const client = new FalconClient({
  cloud: process.env.FALCON_CLOUD!,
  clientId: process.env.FALCON_CLIENT_ID!,
  clientSecret: process.env.FALCON_CLIENT_SECRET!,
});

const response = await client.knowledgeBaseFiles.queriesKnowledgeBaseFilesV1(
  "string",  // knowledgeBaseId
  integer,  // offset
  integer,  // limit
  "string",  // filter
  boolean  // includeDeleted
);

console.log(response);

Rust

Examples coming soon.

Ruby

require "crimson-falcon"

Falcon.configure do |config|
  config.client_id = ENV["FALCON_CLIENT_ID"]
  config.client_secret = ENV["FALCON_CLIENT_SECRET"]
  config.cloud = ENV["FALCON_CLOUD"]
end

api = Falcon::KnowledgeBaseFiles.new

response = api.queries_knowledge_base_files_v1('string')

puts response

Responses

200 Successfully retrieved

[
  "string"
]

403 Forbidden

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

404 Not Found

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

429 Too Many Requests

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

500 Internal Server Error

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}