codegen_api_client.AgentsApi

All URIs are relative to http://localhost

Method	HTTP request	Description
create_agent_run_v1_organizations_org_id_agent_run_post	POST /v1/organizations/{org_id}/agent/run	Create Agent Run
create_agent_run_v1_organizations_org_id_agent_run_post_0	POST /v1/organizations/{org_id}/agent/run	Create Agent Run
create_agent_run_v1_organizations_org_id_agent_run_post_1	POST /v1/organizations/{org_id}/agent/run	Create Agent Run
get_agent_run_v1_organizations_org_id_agent_run_agent_run_id_get	GET /v1/organizations/{org_id}/agent/run/{agent_run_id}	Get Agent Run
get_agent_run_v1_organizations_org_id_agent_run_agent_run_id_get_0	GET /v1/organizations/{org_id}/agent/run/{agent_run_id}	Get Agent Run
get_agent_run_v1_organizations_org_id_agent_run_agent_run_id_get_1	GET /v1/organizations/{org_id}/agent/run/{agent_run_id}	Get Agent Run

create_agent_run_v1_organizations_org_id_agent_run_post

AgentRunResponse create_agent_run_v1_organizations_org_id_agent_run_post(org_id, create_agent_run_input, authorization=authorization)

Create Agent Run

Create a new agent run.

Creates and initiates a long-running agent process based on the provided prompt. The process will complete asynchronously, and the response contains the agent run ID which can be used to check the status later. The requesting user must be a member of the specified organization.

Example

import codegen_api_client
from codegen_api_client.models.agent_run_response import AgentRunResponse
from codegen_api_client.models.create_agent_run_input import CreateAgentRunInput
from codegen_api_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = codegen_api_client.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with codegen_api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = codegen_api_client.AgentsApi(api_client)
    org_id = 56 # int | 
    create_agent_run_input = codegen_api_client.CreateAgentRunInput() # CreateAgentRunInput | 
    authorization = None # object |  (optional)

    try:
        # Create Agent Run
        api_response = api_instance.create_agent_run_v1_organizations_org_id_agent_run_post(org_id, create_agent_run_input, authorization=authorization)
        print("The response of AgentsApi->create_agent_run_v1_organizations_org_id_agent_run_post:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AgentsApi->create_agent_run_v1_organizations_org_id_agent_run_post: %s\n" % e)

Parameters

Name	Type	Notes
org_id	int
create_agent_run_input	CreateAgentRunInput
authorization	object	[optional]

Return type

AgentRunResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-
429	Too Many Requests	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_agent_run_v1_organizations_org_id_agent_run_post_0

AgentRunResponse create_agent_run_v1_organizations_org_id_agent_run_post_0(org_id, create_agent_run_input, authorization=authorization)

Create Agent Run

Create a new agent run.

Example

import codegen_api_client
from codegen_api_client.models.agent_run_response import AgentRunResponse
from codegen_api_client.models.create_agent_run_input import CreateAgentRunInput
from codegen_api_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = codegen_api_client.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with codegen_api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = codegen_api_client.AgentsApi(api_client)
    org_id = 56 # int | 
    create_agent_run_input = codegen_api_client.CreateAgentRunInput() # CreateAgentRunInput | 
    authorization = None # object |  (optional)

    try:
        # Create Agent Run
        api_response = api_instance.create_agent_run_v1_organizations_org_id_agent_run_post_0(org_id, create_agent_run_input, authorization=authorization)
        print("The response of AgentsApi->create_agent_run_v1_organizations_org_id_agent_run_post_0:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AgentsApi->create_agent_run_v1_organizations_org_id_agent_run_post_0: %s\n" % e)

Parameters

Name	Type	Notes
org_id	int
create_agent_run_input	CreateAgentRunInput
authorization	object	[optional]

Return type

AgentRunResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-
429	Too Many Requests	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_agent_run_v1_organizations_org_id_agent_run_post_1

AgentRunResponse create_agent_run_v1_organizations_org_id_agent_run_post_1(org_id, create_agent_run_input, authorization=authorization)

Create Agent Run

Create a new agent run.

Example

import codegen_api_client
from codegen_api_client.models.agent_run_response import AgentRunResponse
from codegen_api_client.models.create_agent_run_input import CreateAgentRunInput
from codegen_api_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = codegen_api_client.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with codegen_api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = codegen_api_client.AgentsApi(api_client)
    org_id = 56 # int | 
    create_agent_run_input = codegen_api_client.CreateAgentRunInput() # CreateAgentRunInput | 
    authorization = None # object |  (optional)

    try:
        # Create Agent Run
        api_response = api_instance.create_agent_run_v1_organizations_org_id_agent_run_post_1(org_id, create_agent_run_input, authorization=authorization)
        print("The response of AgentsApi->create_agent_run_v1_organizations_org_id_agent_run_post_1:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AgentsApi->create_agent_run_v1_organizations_org_id_agent_run_post_1: %s\n" % e)

Parameters

Name	Type	Notes
org_id	int
create_agent_run_input	CreateAgentRunInput
authorization	object	[optional]

Return type

AgentRunResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-
429	Too Many Requests	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_agent_run_v1_organizations_org_id_agent_run_agent_run_id_get

AgentRunResponse get_agent_run_v1_organizations_org_id_agent_run_agent_run_id_get(agent_run_id, org_id, authorization=authorization)

Get Agent Run

Retrieve the status and result of an agent run.

Returns the current status, progress, and any available results for the specified agent run. The agent run must belong to the specified organization. If the agent run is still in progress, this endpoint can be polled to check for completion.

Example

import codegen_api_client
from codegen_api_client.models.agent_run_response import AgentRunResponse
from codegen_api_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = codegen_api_client.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with codegen_api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = codegen_api_client.AgentsApi(api_client)
    agent_run_id = 56 # int | 
    org_id = 56 # int | 
    authorization = None # object |  (optional)

    try:
        # Get Agent Run
        api_response = api_instance.get_agent_run_v1_organizations_org_id_agent_run_agent_run_id_get(agent_run_id, org_id, authorization=authorization)
        print("The response of AgentsApi->get_agent_run_v1_organizations_org_id_agent_run_agent_run_id_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AgentsApi->get_agent_run_v1_organizations_org_id_agent_run_agent_run_id_get: %s\n" % e)

Parameters

Name	Type	Notes
agent_run_id	int
org_id	int
authorization	object	[optional]

Return type

AgentRunResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-
429	Too Many Requests	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_agent_run_v1_organizations_org_id_agent_run_agent_run_id_get_0

AgentRunResponse get_agent_run_v1_organizations_org_id_agent_run_agent_run_id_get_0(agent_run_id, org_id, authorization=authorization)

Get Agent Run

Retrieve the status and result of an agent run.

Example

import codegen_api_client
from codegen_api_client.models.agent_run_response import AgentRunResponse
from codegen_api_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = codegen_api_client.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with codegen_api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = codegen_api_client.AgentsApi(api_client)
    agent_run_id = 56 # int | 
    org_id = 56 # int | 
    authorization = None # object |  (optional)

    try:
        # Get Agent Run
        api_response = api_instance.get_agent_run_v1_organizations_org_id_agent_run_agent_run_id_get_0(agent_run_id, org_id, authorization=authorization)
        print("The response of AgentsApi->get_agent_run_v1_organizations_org_id_agent_run_agent_run_id_get_0:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AgentsApi->get_agent_run_v1_organizations_org_id_agent_run_agent_run_id_get_0: %s\n" % e)

Parameters

Name	Type	Notes
agent_run_id	int
org_id	int
authorization	object	[optional]

Return type

AgentRunResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-
429	Too Many Requests	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_agent_run_v1_organizations_org_id_agent_run_agent_run_id_get_1

AgentRunResponse get_agent_run_v1_organizations_org_id_agent_run_agent_run_id_get_1(agent_run_id, org_id, authorization=authorization)

Get Agent Run

Retrieve the status and result of an agent run.

Example

import codegen_api_client
from codegen_api_client.models.agent_run_response import AgentRunResponse
from codegen_api_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = codegen_api_client.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with codegen_api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = codegen_api_client.AgentsApi(api_client)
    agent_run_id = 56 # int | 
    org_id = 56 # int | 
    authorization = None # object |  (optional)

    try:
        # Get Agent Run
        api_response = api_instance.get_agent_run_v1_organizations_org_id_agent_run_agent_run_id_get_1(agent_run_id, org_id, authorization=authorization)
        print("The response of AgentsApi->get_agent_run_v1_organizations_org_id_agent_run_agent_run_id_get_1:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AgentsApi->get_agent_run_v1_organizations_org_id_agent_run_agent_run_id_get_1: %s\n" % e)

Parameters

Name	Type	Notes
agent_run_id	int
org_id	int
authorization	object	[optional]

Return type

AgentRunResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-
429	Too Many Requests	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FilesExpand file tree

AgentsApi.md

Latest commit

History

AgentsApi.md

File metadata and controls

codegen_api_client.AgentsApi

create_agent_run_v1_organizations_org_id_agent_run_post

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

create_agent_run_v1_organizations_org_id_agent_run_post_0

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

create_agent_run_v1_organizations_org_id_agent_run_post_1

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_agent_run_v1_organizations_org_id_agent_run_agent_run_id_get

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_agent_run_v1_organizations_org_id_agent_run_agent_run_id_get_0

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_agent_run_v1_organizations_org_id_agent_run_agent_run_id_get_1

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details