Agent Versions

Operations for the Agent Versions service collection.

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

Operation	Description
GetAgentVersionsV1 `get_agent_versions_v1`	Retrieve agent version entities for the provided ids.
QueryAgentVersionsV1 `query_agent_versions_v1`	Query agent versions based on the provided filters.

GetAgentVersionsV1

Retrieve agent version entities for the provided ids.

Method GET

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

Scope Charlotte AI Agent Definition: READ

PEP 8 get_agent_versions_v1

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 AgentVersions

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

from falconpy import AgentVersions

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

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

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

Responses

[
  {
    "agent_id": "string",
    "cid": "string",
    "compaction_config": {},
    "created_at": "string",
    "created_by": {},
    "description": "string",
    "flight_control_config": {},
    "id": "string",
    "input_format": {},
    "is_enabled": false,
    "is_published": false,
    "knowledge_base_ids": [],
    "metadata": {},
    "metadata_updated_at": "string",
    "model": "string",
    "model_config": {},
    "name": "string",
    "output_format": {},
    "parent_version_ids": [],
    "skill_ids": [],
    "system_prompt": "string",
    "targeting_config": {},
    "tools": [],
    "updated_at": "string",
    "updated_by": {}
  }
]

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

QueryAgentVersionsV1

Query agent versions based on the provided filters.

Method GET

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

Scope Charlotte AI Agent Definition: READ

PEP 8 query_agent_versions_v1

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_at. Ex: ‘created_at|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 AgentVersions

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

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

from falconpy import AgentVersions

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

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

from falconpy import APIHarnessV2

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

response = falcon.command("QueryAgentVersionsV1",
                          offset=integer,
                          limit=integer,
                          sort="string",
                          filter="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 Versions

Table of Contents

GetAgentVersionsV1

Parameters

QueryAgentVersionsV1

Parameters