Skip to content
CrowdStrike Developer Center

Agents

Operations for the Agents service collection.

LanguageLast Update
Pythonv1.6.6
PowerShell
Go
TypeScript
Rust
Ruby

Table of Contents

Section titled “Table of Contents”
OperationDescription
CreateOrEditAgentExternalV3
create_or_update_agent		Create or update an agent.
DeleteAgentV1
delete_agent		Delete an agent and all of its versions.
GetAgentsV2
get_studio_agents		Retrieve agents entities for the provided ids.
PatchAgentExternalV3
update_agent		Modifies existing agents
QueryAgentsV2
query_studio_agents		Query agents based on the provided filters.

CreateOrEditAgentExternalV3

Section titled “CreateOrEditAgentExternalV3”

Create or update an agent.

Method POST
Route /agentic-studio/entities/agents/v3
Scope Charlotte AI Agent Definition: WRITE
PEP 8 create_or_update_agent

Parameters

Section titled “Parameters”
body body · dictionary
Full body payload as JSON formatted dictionary.
duplicate_from_agent_id body · string
The duplicate_from_agent_id value.
id body · string
The id value.
template_id body · string
The template_id value.
version_definition body · object
The version_definition value.
Code Examples
from falconpy import Agents


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


version_definition = {
    "compaction_config": {
        "enabled": True,
        "threshold": 0.0
    },
    "description": "string",
    "input_format": {
        "format": "string",
        "json_schema": "string",
        "usage_instructions": "string"
    },
    "knowledge_base_ids": [
        "string"
    ],
    "model": "string",
    "model_config": {
        "enable_reasoning": True,
        "frequency_penalty": 0.0,
        "max_tokens": 0,
        "reasoning_effort": "string",
        "temperature": 0.0,
        "top_k": 0,
        "top_p": 0.0
    },
    "name": "string",
    "output_format": {
        "format": "string",
        "json_schema": "string",
        "usage_instructions": "string"
    },
    "parent_version_ids": [
        "string"
    ],
    "skill_ids": [
        "string"
    ],
    "system_prompt": "string",
    "targeting_config": {
        "agent_to_agent": True,
        "apigw": True,
        "charlotte_ai": True,
        "fusion_workflows": True
    },
    "tools": [
        {
            "description_override": "string",
            "id": "string",
            "meta": "string",
            "name": "string",
            "name_override": "string",
            "parameter_overrides": "string",
            "type": "string"
        }
    ]
}


response = falcon.create_or_update_agent(duplicate_from_agent_id="string",
                                         id="string",
                                         template_id="string",
                                         version_definition=version_definition)
print(response)
Responses
[
  {
    "agent": {},
    "agent_version": {}
  }
]

DeleteAgentV1

Section titled “DeleteAgentV1”

Delete an agent and all of its versions.

Method DELETE
Route /agentic-studio/entities/agents/v1
Scope Charlotte AI Agent Definition: WRITE
PEP 8 delete_agent

Parameters

Section titled “Parameters”
id query · string
Agent ID
parameters query · dictionary
Full query string parameters payload in JSON format. Not required when using other keywords.
Code Examples
from falconpy import Agents


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


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


response = falcon.delete_agent(id=id_list)
print(response)
Responses
[
  {
    "active_version": {},
    "attribution": {},
    "cid": "string",
    "duplicate_from_agent_id": "string",
    "id": "string",
    "is_deleted": false,
    "is_in_sync": false,
    "published_version_ids": [],
    "tags": [],
    "template_id": "string"
  }
]

GetAgentsV2

Section titled “GetAgentsV2”

Retrieve agents entities for the provided ids.

Method GET
Route /agentic-studio/entities/agents/v2
Scope Charlotte AI Agent Definition: READ
PEP 8 get_studio_agents

Parameters

Section titled “Parameters”
ids query · string or list of strings
IDs of entities to retrieve.
parameters query · dictionary
Full query string parameters payload in JSON format. Not required when using other keywords.
Code Examples
from falconpy import Agents


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


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


response = falcon.get_studio_agents(ids=id_list)
print(response)
Responses
[
  {
    "active_version": {},
    "attribution": {},
    "cid": "string",
    "duplicate_from_agent_id": "string",
    "id": "string",
    "is_deleted": false,
    "is_in_sync": false,
    "published_version_ids": [],
    "tags": [],
    "template_id": "string"
  }
]

PatchAgentExternalV3

Section titled “PatchAgentExternalV3”

Modifies existing agents

Method PATCH
Route /agentic-studio/entities/agents/v3
Scope Charlotte AI Agent Definition: WRITE
PEP 8 update_agent

Parameters

Section titled “Parameters”
body body · dictionary
Full body payload as JSON formatted dictionary.
is_enabled body · boolean
The is_enabled value.
is_published body · boolean
The is_published value.
version_id body · string
The version_id value.
id query · string
Agent ID
dry_run query · boolean
Validate publishing without publishing the agent.
parameters query · dictionary
Full query string parameters payload in JSON format. Not required when using other keywords.
Code Examples
from falconpy import Agents


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


response = falcon.update_agent(id="string",
                               dry_run=boolean,
                               is_enabled=boolean,
                               is_published=boolean,
                               version_id="string")
print(response)
Responses
[
  {
    "active_version": {},
    "attribution": {},
    "cid": "string",
    "duplicate_from_agent_id": "string",
    "id": "string",
    "is_deleted": false,
    "is_in_sync": false,
    "published_version_ids": [],
    "tags": [],
    "template_id": "string"
  }
]

QueryAgentsV2

Section titled “QueryAgentsV2”

Query agents based on the provided filters.

Method GET
Route /agentic-studio/queries/agents/v2
Scope Charlotte AI Agent Definition: READ
PEP 8 query_studio_agents

Parameters

Section titled “Parameters”
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.
sort query · string
Possible order by fields: created_date. Ex: ‘created_date|desc’.
filter query · string
FQL query specifying the filter parameters.
parameters query · dictionary
Full query string parameters payload in JSON format. Not required when using other keywords.
Code Examples
from falconpy import Agents


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


response = falcon.query_studio_agents(offset=integer,
                                      limit=integer,
                                      sort="string",
                                      filter="string")
print(response)
Responses
[
  "string"
]
© 2026 CrowdStrike, Inc. All rights reserved. Privacy Notice Cookie Notice Terms of Use