Skip to content

Agent Invocation

Operations for the Agent Invocation service collection.

LanguageLast Update
Pythonv1.6.6
PowerShell
Gov0.22.0
TypeScriptv0.7.0
Rust
Rubyv1.4.0

OperationDescription
GetAgentInvocationV3
get_agent_invocation_v3
Get the messages that an invocation produced.
InvokeAgentVersionExternalV1
invoke_agent_version_external_v1
Invoke a specific agent version by agent ID and version ID with the specified input.
InvokePublishedAgentExternalV1
invoke_published_agent_external_v1
Invoke a published agent by ID with the specified input.
PatchAgentInvocationV3
update_agent_invocation
Modify an in-flight agent invocation.

Get the messages that an invocation produced.

Method GET
Route /agentic-studio/entities/agent-invocations/v3
Scope Charlotte AI Agent Definition: READ
PEP 8 get_agent_invocation_v3
id query · string
Invocation ID
parameters query · dictionary
Full query string parameters payload in JSON format. Not required when using other keywords.
from falconpy import AgentInvocation
falcon = AgentInvocation(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_invocation_v3(id=id_list)
print(response)
[
{
"ai_trace_id": "string",
"compaction": {},
"conversation": [],
"id": "string",
"status": "string",
"tool_approvals": []
}
]


Invoke a specific agent version by agent ID and version ID with the specified input.

Method POST
Route /agentic-studio/entities/agent-version-invocations/v1
Scope Charlotte AI Agent Definition: WRITE
PEP 8 invoke_agent_version_external_v1
body body · dictionary
Full body payload as JSON formatted dictionary.
credit_cents_limit body · integer
The credit_cents_limit value.
deadline_seconds body · integer
The deadline_seconds value.
id body · string
The id value.
messages body · array
The messages value.
version_id body · string
The version_id value.
from falconpy import AgentInvocation
falcon = AgentInvocation(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
messages = [
{
"content": "string",
"error": {
"code": "string",
"message": "string",
"param": "string",
"type": "string"
},
"reasoning": "string",
"role": "string",
"tool": {
"calls": [
{
"function": {
"arguments": "string",
"name": "string"
},
"id": "string",
"type": "string"
}
],
"tool_id": "string"
},
"tool_approval": {
"external_approval": {
"external_id": "string",
"provider": "string"
},
"id": "string",
"invocation_id": "string",
"parameters": "string",
"request_message": "string",
"requested_at": "string",
"responded_at": "string",
"responded_by": {
"customer_id": "string",
"service_id": "string",
"user_id": "string"
},
"response_message": "string",
"source_agent_id": "string",
"source_invocation_id": "string",
"status": "string",
"tool_call_id": "string",
"tool_id": "string",
"tool_name": "string"
}
}
]
response = falcon.invoke_agent_version_external_v1(credit_cents_limit=integer,
deadline_seconds=integer,
id="string",
messages=messages,
version_id="string")
print(response)
[
{
"ai_trace_id": "string",
"compaction": {},
"conversation": [],
"id": "string",
"status": "string",
"tool_approvals": []
}
]


Invoke a published agent by ID with the specified input.

Method POST
Route /agentic-studio/entities/agent-invocations/v1
Scope Charlotte AI Agent Definition: WRITE
PEP 8 invoke_published_agent_external_v1
body body · dictionary
Full body payload as JSON formatted dictionary.
credit_cents_limit body · integer
The credit_cents_limit value.
deadline_seconds body · integer
The deadline_seconds value.
id body · string
The id value.
messages body · array
The messages value.
from falconpy import AgentInvocation
falcon = AgentInvocation(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
messages = [
{
"content": "string",
"error": {
"code": "string",
"message": "string",
"param": "string",
"type": "string"
},
"reasoning": "string",
"role": "string",
"tool": {
"calls": [
{
"function": {
"arguments": "string",
"name": "string"
},
"id": "string",
"type": "string"
}
],
"tool_id": "string"
},
"tool_approval": {
"external_approval": {
"external_id": "string",
"provider": "string"
},
"id": "string",
"invocation_id": "string",
"parameters": "string",
"request_message": "string",
"requested_at": "string",
"responded_at": "string",
"responded_by": {
"customer_id": "string",
"service_id": "string",
"user_id": "string"
},
"response_message": "string",
"source_agent_id": "string",
"source_invocation_id": "string",
"status": "string",
"tool_call_id": "string",
"tool_id": "string",
"tool_name": "string"
}
}
]
response = falcon.invoke_published_agent_external_v1(credit_cents_limit=integer,
deadline_seconds=integer,
id="string",
messages=messages)
print(response)
[
{
"ai_trace_id": "string",
"compaction": {},
"conversation": [],
"id": "string",
"status": "string",
"tool_approvals": []
}
]


Modify an in-flight agent invocation.

Method PATCH
Route /agentic-studio/entities/agent-invocations/v3
Scope Charlotte AI Agent Definition: WRITE
PEP 8 update_agent_invocation
body body · dictionary
Full body payload as JSON formatted dictionary.
id body · string
The id value.
status body · string
The status value.
from falconpy import AgentInvocation
falcon = AgentInvocation(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.update_agent_invocation(id="string", status="string")
print(response)
{
"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
}
}
}