Agent Templates

Operations for the Agent Templates service collection.

Language	Last Update
Python	v1.6.5
PowerShell
Go
TypeScript
Rust
Ruby

Operation	Description
EntitiesAgentTemplatesV1 `entities_agent_templates_v1`	Retrieve agent template entities for the provided IDs
QueriesAgentTemplatesV1 `queries_agent_templates_v1`	Query agent template IDs with pagination

EntitiesAgentTemplatesV1

Retrieve agent template entities for the provided IDs

Method GET

Route /agentic-studio/entities/agent-templates/v1

Scope Charlotte AI Agent Definition: READ

PEP 8 entities_agent_templates_v1

Parameters

ids query · string or list of strings

IDs of agent templates to retrieve.

parameters query · dictionary

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

Code Examples

from falconpy import AgentTemplates

falcon = AgentTemplates(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_agent_templates_v1(ids=id_list)
print(response)

from falconpy import AgentTemplates

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

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

response = falcon.EntitiesAgentTemplatesV1(ids=id_list)
print(response)

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("EntitiesAgentTemplatesV1",
                          ids=id_list)
print(response)

Responses

[
  {
    "author": "string",
    "created_at": "string",
    "description": "string",
    "documentation": "string",
    "id": "string",
    "model": "string",
    "name": "string",
    "products": [],
    "targeting": [],
    "tools": [],
    "updated_at": "string",
    "use_cases": [],
    "vendors": [],
    "version": "string",
    "version_definition": {}
  }
]

{
  "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
    }
  }
}

{
  "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
    }
  }
}

{
  "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
    }
  }
}

{
  "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
    }
  }
}

QueriesAgentTemplatesV1

Query agent template IDs with pagination

Method GET

Route /agentic-studio/queries/agent-templates/v1

Scope Charlotte AI Agent Definition: READ

PEP 8 queries_agent_templates_v1

Parameters

offset query · integer

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

limit query · integer

Number of IDs to return.

filter query · string

FQL query specifying the filter parameters.

sort query · string

Possible order by fields:

Available values (6)

`name`	`id`	`author`
`model`	`created_at`	`updated_at`

parameters query · dictionary

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

Code Examples

from falconpy import AgentTemplates

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

response = falcon.queries_agent_templates_v1(offset=integer,
                                             limit=integer,
                                             filter="string",
                                             sort="string")
print(response)

from falconpy import AgentTemplates

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

response = falcon.QueriesAgentTemplatesV1(offset=integer,
                                          limit=integer,
                                          filter="string",
                                          sort="string")
print(response)

from falconpy import APIHarnessV2

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

response = falcon.command("QueriesAgentTemplatesV1",
                          offset=integer,
                          limit=integer,
                          filter="string",
                          sort="string")
print(response)

Responses

[
  "string"
]

{
  "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
    }
  }
}

{
  "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
    }
  }
}

{
  "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
    }
  }
}

{
  "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
    }
  }
}

Agent Templates

Table of Contents

EntitiesAgentTemplatesV1

Parameters

QueriesAgentTemplatesV1

Parameters