Knowledge Base Files

Operations for the Knowledge Base Files service collection.

Language	Last Update
Python	v1.6.1
PowerShell	v2.2.9
Go	v0.20.0
TypeScript	v0.6.0
Rust	v0.7.0
Ruby	v1.2.0

Table of Contents

Operation	Description
entities_knowledge_base_files_download_v1	Download knowledge base file entities for the provided id.
entities_knowledge_base_files_v1	Retrieve knowledge base file entities for the provided id.
entities_knowledge_base_files_update_v1	Update an existing file in a knowledge base. Supports updating file content and optionally its description.
entities_knowledge_base_files_create_v1	Upload a file to a knowledge base.
entities_knowledge_base_files_delete_v1	Delete document from knowledge base.
queries_knowledge_base_files_v1	Query knowledge base files based on the provided filters.

---

entities_knowledge_base_files_download_v1

Download knowledge base file entities for the provided id.

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

Scope Charlotte Ai Agent Definition: READ Consumes · Produces application/json

Parameters

Name	Type	Data type	Description
knowledge_base_id	query	string	ID of the knowledge base
id	query	string	ID of entities to retrieve.

Code Examples

Python

Examples coming soon.

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

---

entities_knowledge_base_files_v1

Retrieve knowledge base file entities for the provided id.

GET /agentic-studio/entities/knowledge_base_files/v1

Scope Charlotte Ai Agent Definition: READ Consumes · Produces application/json

Parameters

Name	Type	Data type	Description
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.

Code Examples

Python

Examples coming soon.

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

---

entities_knowledge_base_files_update_v1

Update an existing file in a knowledge base. Supports updating file content and optionally its description.

PUT /agentic-studio/entities/knowledge_base_files/v1

Scope Charlotte Ai Agent Definition: WRITE Consumes · Produces application/json

Code Examples

Python

Examples coming soon.

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

---

entities_knowledge_base_files_create_v1

Upload a file to a knowledge base.

POST /agentic-studio/entities/knowledge_base_files/v1

Scope Charlotte Ai Agent Definition: WRITE Consumes · Produces application/json

Code Examples

Python

Examples coming soon.

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

---

entities_knowledge_base_files_delete_v1

Delete document from knowledge base.

DELETE /agentic-studio/entities/knowledge_base_files/v1

Scope Charlotte Ai Agent Definition: WRITE Consumes · Produces application/json

Parameters

Name	Type	Data type	Description
knowledge_base_id	query	string	ID of the knowledge base
id	query	string	ID of the document to delete

Code Examples

Python

Examples coming soon.

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

---

queries_knowledge_base_files_v1

Query knowledge base files based on the provided filters.

GET /agentic-studio/queries/knowledge_base_files/v1

Scope Charlotte Ai Agent Definition: READ Consumes · Produces application/json

Parameters

Name	Type	Data type	Description
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.

Code Examples

Python

Examples coming soon.

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