\AIAgentsAPI

All URIs are relative to https://dashboard.quantcdn.io

Method	HTTP request	Description
ChatWithAIAgent	Post /api/v3/organizations/{organisation}/ai/agents/{agentId}/chat	Chat with AI Agent
CreateAIAgent	Post /api/v3/organizations/{organisation}/ai/agents	Create AI Agent
DeleteAIAgent	Delete /api/v3/organizations/{organisation}/ai/agents/{agentId}	Delete Agent
DeleteAgentOverlay	Delete /api/v3/organizations/{organisation}/ai/agents/{agentId}/overlay	Delete Agent Overlay
GetAIAgent	Get /api/v3/organizations/{organisation}/ai/agents/{agentId}	Get Agent Details
GetAgentOverlay	Get /api/v3/organizations/{organisation}/ai/agents/{agentId}/overlay	Get Agent Overlay
ListAIAgents	Get /api/v3/organizations/{organisation}/ai/agents	List AI Agents
UpdateAIAgent	Put /api/v3/organizations/{organisation}/ai/agents/{agentId}	Update Agent
UpsertAgentOverlay	Put /api/v3/organizations/{organisation}/ai/agents/{agentId}/overlay	Upsert Agent Overlay

ChatWithAIAgent

ChatWithAIAgent200Response ChatWithAIAgent(ctx, organisation, agentId).ChatWithAIAgentRequest(chatWithAIAgentRequest).Execute()

Chat with AI Agent

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/quantcdn/quant-admin-go"
)

func main() {
	organisation := "organisation_example" // string | The organisation ID
	agentId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | The agent ID
	chatWithAIAgentRequest := *openapiclient.NewChatWithAIAgentRequest("Message_example") // ChatWithAIAgentRequest | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.AIAgentsAPI.ChatWithAIAgent(context.Background(), organisation, agentId).ChatWithAIAgentRequest(chatWithAIAgentRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AIAgentsAPI.ChatWithAIAgent``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ChatWithAIAgent`: ChatWithAIAgent200Response
	fmt.Fprintf(os.Stdout, "Response from `AIAgentsAPI.ChatWithAIAgent`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
organisation	string	The organisation ID
agentId	string	The agent ID

Other Parameters

Other parameters are passed through a pointer to a apiChatWithAIAgentRequest struct via the builder pattern

Name	Type	Description	Notes

chatWithAIAgentRequest | ChatWithAIAgentRequest | |

Return type

ChatWithAIAgent200Response

Authorization

BearerAuth

HTTP request headers

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

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

CreateAIAgent

CreateAIAgent201Response CreateAIAgent(ctx, organisation).CreateAIAgentRequest(createAIAgentRequest).Execute()

Create AI Agent

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/quantcdn/quant-admin-go"
)

func main() {
	organisation := "organisation_example" // string | The organisation ID
	createAIAgentRequest := *openapiclient.NewCreateAIAgentRequest("Code Review Assistant", "Reviews code for security vulnerabilities and best practices", "You are a senior software engineer specializing in secure code review.", "anthropic.claude-3-5-sonnet-20241022-v2:0") // CreateAIAgentRequest | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.AIAgentsAPI.CreateAIAgent(context.Background(), organisation).CreateAIAgentRequest(createAIAgentRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AIAgentsAPI.CreateAIAgent``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `CreateAIAgent`: CreateAIAgent201Response
	fmt.Fprintf(os.Stdout, "Response from `AIAgentsAPI.CreateAIAgent`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
organisation	string	The organisation ID

Other Parameters

Other parameters are passed through a pointer to a apiCreateAIAgentRequest struct via the builder pattern

Name	Type	Description	Notes

createAIAgentRequest | CreateAIAgentRequest | |

Return type

CreateAIAgent201Response

Authorization

BearerAuth

HTTP request headers

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

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

DeleteAIAgent

DeleteAIAgent200Response DeleteAIAgent(ctx, organisation, agentId).Execute()

Delete Agent

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/quantcdn/quant-admin-go"
)

func main() {
	organisation := "organisation_example" // string | The organisation ID
	agentId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | The agent ID

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.AIAgentsAPI.DeleteAIAgent(context.Background(), organisation, agentId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AIAgentsAPI.DeleteAIAgent``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `DeleteAIAgent`: DeleteAIAgent200Response
	fmt.Fprintf(os.Stdout, "Response from `AIAgentsAPI.DeleteAIAgent`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
organisation	string	The organisation ID
agentId	string	The agent ID

Other Parameters

Other parameters are passed through a pointer to a apiDeleteAIAgentRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

DeleteAIAgent200Response

Authorization

BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

DeleteAgentOverlay

DeleteAgentOverlay200Response DeleteAgentOverlay(ctx, organisation, agentId).Execute()

Delete Agent Overlay

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/quantcdn/quant-admin-go"
)

func main() {
	organisation := "organisation_example" // string | The organisation ID
	agentId := "agentId_example" // string | Global agent identifier

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.AIAgentsAPI.DeleteAgentOverlay(context.Background(), organisation, agentId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AIAgentsAPI.DeleteAgentOverlay``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `DeleteAgentOverlay`: DeleteAgentOverlay200Response
	fmt.Fprintf(os.Stdout, "Response from `AIAgentsAPI.DeleteAgentOverlay`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
organisation	string	The organisation ID
agentId	string	Global agent identifier

Other Parameters

Other parameters are passed through a pointer to a apiDeleteAgentOverlayRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

DeleteAgentOverlay200Response

Authorization

BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

GetAIAgent

GetAIAgent200Response GetAIAgent(ctx, organisation, agentId).Execute()

Get Agent Details

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/quantcdn/quant-admin-go"
)

func main() {
	organisation := "organisation_example" // string | The organisation ID
	agentId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | The agent ID

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.AIAgentsAPI.GetAIAgent(context.Background(), organisation, agentId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AIAgentsAPI.GetAIAgent``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetAIAgent`: GetAIAgent200Response
	fmt.Fprintf(os.Stdout, "Response from `AIAgentsAPI.GetAIAgent`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
organisation	string	The organisation ID
agentId	string	The agent ID

Other Parameters

Other parameters are passed through a pointer to a apiGetAIAgentRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

GetAIAgent200Response

Authorization

BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

GetAgentOverlay

GetAgentOverlay200Response GetAgentOverlay(ctx, organisation, agentId).Execute()

Get Agent Overlay

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/quantcdn/quant-admin-go"
)

func main() {
	organisation := "organisation_example" // string | The organisation ID
	agentId := "agentId_example" // string | Global agent identifier (e.g., 'quantgov-code')

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.AIAgentsAPI.GetAgentOverlay(context.Background(), organisation, agentId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AIAgentsAPI.GetAgentOverlay``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetAgentOverlay`: GetAgentOverlay200Response
	fmt.Fprintf(os.Stdout, "Response from `AIAgentsAPI.GetAgentOverlay`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
organisation	string	The organisation ID
agentId	string	Global agent identifier (e.g., 'quantgov-code')

Other Parameters

Other parameters are passed through a pointer to a apiGetAgentOverlayRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

GetAgentOverlay200Response

Authorization

BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

ListAIAgents

ListAIAgents200Response ListAIAgents(ctx, organisation).Group(group).Execute()

List AI Agents

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/quantcdn/quant-admin-go"
)

func main() {
	organisation := "organisation_example" // string | The organisation ID
	group := "group_example" // string | Optional group filter (e.g., 'development', 'compliance') (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.AIAgentsAPI.ListAIAgents(context.Background(), organisation).Group(group).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AIAgentsAPI.ListAIAgents``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ListAIAgents`: ListAIAgents200Response
	fmt.Fprintf(os.Stdout, "Response from `AIAgentsAPI.ListAIAgents`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
organisation	string	The organisation ID

Other Parameters

Other parameters are passed through a pointer to a apiListAIAgentsRequest struct via the builder pattern

Name	Type	Description	Notes

group | string | Optional group filter (e.g., 'development', 'compliance') |

Return type

ListAIAgents200Response

Authorization

BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

UpdateAIAgent

UpdateAIAgent200Response UpdateAIAgent(ctx, organisation, agentId).UpdateAIAgentRequest(updateAIAgentRequest).Execute()

Update Agent

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/quantcdn/quant-admin-go"
)

func main() {
	organisation := "organisation_example" // string | The organisation ID
	agentId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | The agent ID
	updateAIAgentRequest := *openapiclient.NewUpdateAIAgentRequest() // UpdateAIAgentRequest | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.AIAgentsAPI.UpdateAIAgent(context.Background(), organisation, agentId).UpdateAIAgentRequest(updateAIAgentRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AIAgentsAPI.UpdateAIAgent``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `UpdateAIAgent`: UpdateAIAgent200Response
	fmt.Fprintf(os.Stdout, "Response from `AIAgentsAPI.UpdateAIAgent`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
organisation	string	The organisation ID
agentId	string	The agent ID

Other Parameters

Other parameters are passed through a pointer to a apiUpdateAIAgentRequest struct via the builder pattern

Name	Type	Description	Notes

updateAIAgentRequest | UpdateAIAgentRequest | |

Return type

UpdateAIAgent200Response

Authorization

BearerAuth

HTTP request headers

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

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

UpsertAgentOverlay

UpsertAgentOverlay200Response UpsertAgentOverlay(ctx, organisation, agentId).UpsertAgentOverlayRequest(upsertAgentOverlayRequest).Execute()

Upsert Agent Overlay

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/quantcdn/quant-admin-go"
)

func main() {
	organisation := "organisation_example" // string | The organisation ID
	agentId := "agentId_example" // string | Global agent identifier
	upsertAgentOverlayRequest := *openapiclient.NewUpsertAgentOverlayRequest() // UpsertAgentOverlayRequest | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.AIAgentsAPI.UpsertAgentOverlay(context.Background(), organisation, agentId).UpsertAgentOverlayRequest(upsertAgentOverlayRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AIAgentsAPI.UpsertAgentOverlay``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `UpsertAgentOverlay`: UpsertAgentOverlay200Response
	fmt.Fprintf(os.Stdout, "Response from `AIAgentsAPI.UpsertAgentOverlay`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
organisation	string	The organisation ID
agentId	string	Global agent identifier

Other Parameters

Other parameters are passed through a pointer to a apiUpsertAgentOverlayRequest struct via the builder pattern

Name	Type	Description	Notes

upsertAgentOverlayRequest | UpsertAgentOverlayRequest | |

Return type

UpsertAgentOverlay200Response

Authorization

BearerAuth

HTTP request headers

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

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

FilesExpand file tree

AIAgentsAPI.md

Latest commit

History

AIAgentsAPI.md

File metadata and controls

\AIAgentsAPI

ChatWithAIAgent

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

CreateAIAgent

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

DeleteAIAgent

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

DeleteAgentOverlay

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetAIAgent

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetAgentOverlay

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ListAIAgents

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

UpdateAIAgent

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

UpsertAgentOverlay

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers