trata_dart_client_sdk 1.0.5

Trata API client SDK for Dart/Flutter

trata_dart_client_sdk (EXPERIMENTAL)

Human like conversation to answer calls, drive engagement, automate follow-ups & schedule bookings 24/7 with end to end integrations ensuring you never miss a sales enquiry.

This Dart package is automatically generated by the OpenAPI Generator project:

• API version: 1.0.0
• Generator version: 7.14.0
• Build package: org.openapitools.codegen.languages.DartDioClientCodegen

Requirements

• Dart 2.15.0+ or Flutter 2.8.0+
• Dio 5.0.0+ (https://pub.dev/packages/dio)

Installation & Usage

pub.dev

To use the package from pub.dev, please include the following in pubspec.yaml

dependencies:
  trata_dart_client_sdk: 1.0.0

Github

If this Dart package is published to Github, please include the following in pubspec.yaml

dependencies:
  trata_dart_client_sdk:
    git:
      url: https://github.com/GIT_USER_ID/GIT_REPO_ID.git
      #ref: main

Local development

To use the package from your local drive, please include the following in pubspec.yaml

dependencies:
  trata_dart_client_sdk:
    path: /path/to/trata_dart_client_sdk

Getting Started

Please follow the installation procedure and then run the following:

import 'package:trata_dart_client_sdk/trata_dart_client_sdk.dart';


final api = TrataDartClientSdk().getActionAgentLinkApi();
final String actionId = actionId_example; // String | ID of the action
final String agentId = agentId_example; // String | ID of the agent

try {
    final response = await api.createActionAgentLinkV1(actionId, agentId);
    print(response);
} catch on DioException (e) {
    print("Exception when calling ActionAgentLinkApi->createActionAgentLinkV1: $e\n");
}

Documentation for API Endpoints

All URIs are relative to https://api.trata.ai

Class	Method	HTTP request	Description
ActionAgentLinkApi	createActionAgentLinkV1	POST /v1/actions/{action_id}/ai-agents/{agent_id}/link	Create a Link Between an Action and an Agent
ActionAgentLinkApi	deleteActionAgentLinkV1	DELETE /v1/actions/{action_id}/ai-agents/{agent_id}/link	Delete a Link Between an Action and an Agent
ActionAgentLinkApi	listActionsOfAgentV1	GET /v1/ai-agents/{agent_id}/actions	List All Actions Linked to a Specific Agent
ActionsApi	createActionV1	POST /v1/actions	Create a New Action
ActionsApi	deleteActionV1	DELETE /v1/actions/{action_id}	Delete a Specific Action by ID
ActionsApi	getActionV1	GET /v1/actions/{action_id}	Get a Specific Action by ID
ActionsApi	listActionsV1	GET /v1/actions	List All Actions
ActionsApi	updateActionV1	PUT /v1/actions/{action_id}	Update a Specific Action by ID
AgentsApi	createAIAgentV1	POST /v1/ai-agents	Create a New AI Agent
AgentsApi	deleteAIAgentV1	DELETE /v1/ai-agents/{agent_id}	Delete a Specific AI Agent by ID
AgentsApi	getAIAgentV1	GET /v1/ai-agents/{agent_id}	Get a Specific AI Agent by ID
AgentsApi	listAIAgentsV1	GET /v1/ai-agents	List All AI Agents
AgentsApi	updateAIAgentV1	PUT /v1/ai-agents/{agent_id}	Update a Specific AI Agent by ID
AnalyticsApi	getMetricsV1MetricsPost	POST /v1/metrics	Get Metrics
AnalyticsApi	getOverallStatsV1StatsGet	GET /v1/stats	Get Aggregated Stats
AnalyticsApi	getUserAnalyticsV1	POST /v1/sparr/analytics/users	Get User Analytics
AnalyticsApi	getUserPerformanceSummaryV1	POST /v1/sparr/analytics/users/performance-summary	Get User Performance Summary
ApiKeyApi	createApiKeyV1	POST /v1/api-keys	Create Api Key
ApiKeyApi	deleteApiKeyV1	DELETE /v1/api-keys/{key_id}	Delete Api Key
ApiKeyApi	getCallKeyV1	GET /v1/api-keys/call-key	Get Call Key
ApiKeyApi	listApiKeysV1	GET /v1/api-keys	List Api Keys
BillingApi	createCheckoutSessionForBillableProductV1	POST /v1/subscription/billable-products/{billable_product_id}/checkout	Create Checkout Session For Billable Product
BillingApi	getCustomerSessionSecretV1	GET /v1/subscription/customer-session-secret	Get Customer Session Secret
BillingApi	getSubscriptionBillableProductsV1	GET /v1/subscription/billable-products	Get Subscription Billable Products
BillingApi	getSubscriptionPortalV1	GET /v1/subscription/portal	Get Subscription Portal
BillingApi	getSubscriptionV1	GET /v1/subscription	Get Subscription
ConnectApi	connectOauthV1	POST /v1/sparr/connect/telephony/oauth	Telephonyoauthconnect
ConversationProspectLinkApi	createConversationProspectLinkV1	POST /v1/conversations/{conversation_id}/prospects/{prospect_id}/links	Create a link between a conversation and a prospect
ConversationProspectLinkApi	deleteConversationProspectLinkV1	DELETE /v1/conversations/{conversation_id}/prospects/{prospect_id}/links	Delete a link between a conversation and a prospect
ConversationProspectLinkApi	listConversationsOfProspectsV1	GET /v1/prospects/{prospect_id}/conversations	List all conversations linked to a specific prospect
ConversationsApi	addFeedbackV1	POST /v1/conversations/{conversation_id}/feedback	Add Feedback to a Specific Conversation
ConversationsApi	createConversationV1	POST /v1/conversations	Create a New Conversation
ConversationsApi	deleteConversationV1	DELETE /v1/conversations/{conversation_id}	Delete a Specific Conversation by ID
ConversationsApi	getConversationV1	GET /v1/conversations/{conversation_id}	Get a Specific Conversation by ID
ConversationsApi	listConversationsV1	GET /v1/conversations	List All Conversations
ConversationsApi	updateConversationV1	PUT /v1/conversations/{conversation_id}	Update a Specific Conversation by ID
DataPlaneApi	createConnection	POST /v1/connections	Create Connection
DataPlaneApi	generateLiveKitToken	POST /v1/livekit/token	Generate LiveKit Token
DataPlaneApi	getPlivoAudioStreamXml	GET /v1/connections/{connection_id}/plivo-audio-stream-xml	Get Audio Stream XML For Plivo
DataPlaneApi	listConnections	GET /v1/connections	Listconnections
FilesApi	deleteFileV1	DELETE /v1/files	Delete Files
FilesApi	uploadAudioFileV1	POST /v1/audio-files	Upload Audio Files
FilesApi	uploadFileV1	POST /v1/files	Upload Files
HealthApi	statusStatusGet	GET /status	Heart Beat Status Of Trata Backend
HealthApi	statusWorkflowsStatusGet	GET /workflows/status	Heart Beat Status Of Workflow Service
HiveApi	createHiveV1	POST /v1/hives	Create a New Hive
HiveApi	deleteHiveV1	DELETE /v1/hives/{hive_id}	Delete a Specific Hive by ID
HiveApi	getHiveV1	GET /v1/hives/{hive_id}	Get a Specific Hive by ID
HiveApi	listHivesV1	GET /v1/hives	List All Hives
HiveApi	updateHiveV1	PUT /v1/hives/{hive_id}	Update a Specific Hive by ID
HiveAgentLinkApi	createHiveAgentLinkV1	POST /v1/hives/{hive_id}/ai-agents/{agent_id}/link	Create a Link Between a Hive and an Agent
HiveAgentLinkApi	deleteHiveAgentLinkV1	DELETE /v1/hives/{hive_id}/ai-agents/{agent_id}/link	Delete a Link Between a Hive and an Agent
HiveAgentLinkApi	listAgentsOfHiveV1	GET /v1/hives/{hive_id}/ai-agents	List All Agents Linked to a Specific Hive
HiveAgentLinkApi	listHivesOfAgentV1	GET /v1/ai-agents/{agent_id}/hives	List All Hives Linked to a Specific Agent
InternalApi	acceptInviteV1	POST /v1/invites/accept	Acceptinvite
InternalApi	createOrganizationV1	POST /v1/organizations	Createorganization
InternalApi	createUserV1	POST /v1/users	Createuser
InternalApi	deleteOrganizationV1	DELETE /v1/organizations	Deleteorganization
InternalApi	deleteUserV1	DELETE /v1/users/{user_id}	Deleteuser
InternalApi	getCustomerCreditsV1	GET /v1/customers/credits	Get Customer Credits
InternalApi	getCustomerPricingV1	GET /v1/customers/pricing	Get Customer Pricing
InternalApi	getOrganizationBrandingV1	GET /v1/organizations/branding	Getorganizationbranding
InternalApi	getOrganizationV1	GET /v1/organizations	Getorganization
InternalApi	getUserByIdV1	GET /v1/users/{user_id}	Getuserbyid
InternalApi	listInvitesV1	GET /v1/invites	Listinvites
InternalApi	listUsersV1	GET /v1/users	Listusers
InternalApi	sendInviteV1	POST /v1/invites	Inviteusers
InternalApi	updateOrganizationV1	PUT /v1/organizations/{org_id}	Updateorganization
InternalApi	updateUserV1	PUT /v1/users/{user_id}	Updateuser
ProductsApi	createProductV1	POST /v1/products	Create a New Product
ProductsApi	deleteProductV1	DELETE /v1/products/{product_id}	Delete a Specific Product by ID
ProductsApi	getProductV1	GET /v1/products/{product_id}	Get a Specific Product by ID
ProductsApi	listAgentsOfProductV1	GET /v1/products/{product_id}/agents	List All Agents Linked to a Specific Product
ProductsApi	listProductsV1	GET /v1/products	List All Products
ProductsApi	updateProductV1	PUT /v1/products/{product_id}	Update a Specific Product by ID
ProspectsApi	createProspectV1	POST /v1/prospects	Create a New Prospect
ProspectsApi	deleteProspectV1	DELETE /v1/prospects/{prospect_id}	Delete a Specific Prospect by ID
ProspectsApi	getProspectV1	GET /v1/prospects/{prospect_id}	Get a Specific Prospect by ID
ProspectsApi	listProspectsV1	GET /v1/prospects	List All Prospects
ProspectsApi	updateProspectV1	PUT /v1/prospects/{prospect_id}	Update a Specific Prospect by ID
ResellerCourseAssignmentsApi	changeResellerCourseAssignmentsV1	PUT /v1/resellers/course-assignments	Change Reseller Course Assignments
ResellerCourseAssignmentsApi	getAssignedCoursesByCustomerV1	GET /v1/resellers/customers/{customer_org_id}/courses	Get Assigned Courses By Customer V1
ResellerCourseAssignmentsApi	getCustomersByAssignedCourseV1	GET /v1/resellers/courses/{course_id}/customers	Get Customers By Assigned Course V1
ResellerCustomerApi	createCustomerOrganizationV1	POST /v1/resellers/customers	Create Customer V1
ResellerCustomerApi	deleteResellerCustomerV1	DELETE /v1/resellers/customers/{customer_org_id}	Delete Customer V1
ResellerCustomerApi	getCustomerBasicCredentialsV1	GET /v1/resellers/customers/{customer_org_id}/basic_credentials	Get Customer Basic Credentials V1
ResellerCustomerApi	getCustomerCredentialsV1	GET /v1/resellers/customers/{customer_org_id}/credentials	Get Customer Credentials V1
ResellerCustomerApi	getResellerCustomerByIdV1	GET /v1/resellers/customers/{customer_org_id}	Get Reseller Customer By Id V1
ResellerCustomerApi	listResellerCustomersV1	GET /v1/resellers/customers	List Reseller Customers V1
ResellerCustomerApi	updateCustomerOrganizationV1	PUT /v1/resellers/customers/{customer_org_id}	Update Customer V1
ResellerCustomerAuditLogsApi	getResellerCustomerAuditLogsV1ResellersCustomersCustomerOrgIdAuditLogsGet	GET /v1/resellers/customers/{customer_org_id}/audit-logs	Get Reseller Customer Audit Logs
ResellerCustomerCheckoutApi	createCheckoutSessionForResellerCustomerV1	POST /v1/resellers/customers/{customer_org_id}/pricing/{price_id}/checkout	Create Checkout Session For Reseller Customer
ResellerCustomerDefaultPricingApi	getCustomerDefaultPricingV1	GET /v1/resellers/customers/pricing/default	Get Customer Default Pricing V1
ResellerCustomerDefaultPricingApi	updateCustomerDefaultPricingV1	PUT /v1/resellers/customers/pricing/default/{price_id}	Update Customer Default Pricing V1
ResellerCustomerPortalApi	createCustomerPortalForResellerCustomerV1	POST /v1/resellers/customers/{customer_org_id}/portal	Create Customer Portal For Reseller Customer
ResellerCustomerPricingApi	createCustomerPricingV1	POST /v1/resellers/customers/{customer_org_id}/pricing	Create Customer Pricing V1
ResellerCustomerPricingApi	getResellerCustomerCreditsV1	GET /v1/resellers/customers/{customer_org_id}/credits	Get Reseller Customer Credits V1
ResellerCustomerPricingApi	getResellerCustomerPricingV1	GET /v1/resellers/customers/{customer_org_id}/pricing	Get Reseller Customer Pricing V1
ResellerCustomerPricingApi	updateCustomerPricingV1	PUT /v1/resellers/customers/{customer_org_id}/pricing/{price_id}	Update Customer Pricing V1
ResellerCustomerUserApi	deleteResellerCustomerUserV1	DELETE /v1/resellers/customers/{customer_org_id}/users/{user_id}	Delete Reseller Customer User V1
ResellerCustomerUserApi	getResellerCustomerUserAndInvitesV1	GET /v1/resellers/customers/{customer_org_id}/users_and_invites	Get Reseller Customer User And Invites V1
ResellerCustomerUserApi	getResellerCustomerUserByIdV1	GET /v1/resellers/customers/{customer_org_id}/users/{user_id}	Get Reseller Customer User By Id V1
ResellerCustomerUserApi	listCustomerInvitesV1	GET /v1/resellers/customers/{customer_org_id}/invites	List Customer Invites V1
ResellerCustomerUserApi	listResellerCustomerUsersV1	GET /v1/resellers/customers/{customer_org_id}/users	List Reseller Customer Users V1
ResellerCustomerUserApi	revokeCustomerInviteV1	DELETE /v1/resellers/customers/{customer_org_id}/invites/{email}	Revoke Customer Invite V1
ResellerCustomerUserApi	sendCustomerUserInviteV1	POST /v1/resellers/customers/{customer_org_id}/invites	Invite Customer Users V1
ResellerCustomerUserApi	updateResellerCustomerUserV1	PUT /v1/resellers/customers/{customer_org_id}/users/{user_id}	Update Reseller Customer User V1
ResellerFilesApi	deleteResellerFilesV1	DELETE /v1/resellers/files	Delete Files
ResellerFilesApi	uploadResellerFilesV1	POST /v1/resellers/files	Upload Files
ResellerMetricsApi	getResellerMetricsV1	POST /v1/resellers/metrics	Get Reseller Metrics
ResellerOrganizationApi	createResellerOrganizationV1	POST /v1/resellers/organizations	Create Reseller Organization V1
ResellerOrganizationApi	deleteResellerOrganizationV1	DELETE /v1/resellers/organizations	Delete Reseller Organization V1
ResellerOrganizationApi	getResellerOrganizationV1	GET /v1/resellers/organizations	Get Reseller Organization V1
ResellerOrganizationApi	updateResellerOrganizationV1	PUT /v1/resellers/organizations	Update Reseller Organization V1
ResellerPricingApi	addStripeAccountLinkToResellerOrgV1	POST /v1/resellers/stripe-account/link	Add Stripe Account Link To Reseller Org
ResellerPricingApi	createStripeAccountLinkV1	GET /v1/resellers/stripe-account/connect-link	Create Stripe Account Link
ResellerPricingApi	getStripeAccountDetailsV1	GET /v1/resellers/stripe-account	Get Stripe Account Details
ResellerPricingApi	stripeDisconnectV1	DELETE /v1/resellers/stripe-account	Revoke Stripe Connection
ResellerSettingsApi	addResellerSettingsV1	POST /v1/resellers/settings	Organization Settings V1
ResellerSettingsApi	getOrganizationSettingsV1	GET /v1/resellers/settings	Get Organization Settings V1
ResellerSettingsApi	updateResellerSettingsV1	PUT /v1/resellers/settings	Organization Settings Update V1
ResellerUserApi	acceptResellerUserInviteV1	POST /v1/resellers/invites/accept	Accept Invite V1
ResellerUserApi	deleteResellerUserV1	DELETE /v1/resellers/users/{user_id}	Delete Reseller User V1
ResellerUserApi	getResellerUserByIdV1	GET /v1/resellers/users/{user_id}	Get Reseller User By Id V1
ResellerUserApi	listResellerUserInvitesV1	GET /v1/resellers/invites	List Reseller User Invites V1
ResellerUserApi	listResellerUsersV1	GET /v1/resellers/users	List Reseller Users V1
ResellerUserApi	sendResellerUserInviteV1	POST /v1/resellers/invites	Invite Users V1
ResellerUserApi	updateResellerUserV1	PUT /v1/resellers/users/{user_id}	Update Reseller User V1
SparrApi	addModuleAttemptV1	POST /v1/sparr/courses/modules/{module_id}/attempts	Add Module Attempt
SparrApi	assignCourseV1	POST /v1/sparr/courses/{course_id}/assign/{user_id}	Assign Course
SparrApi	attachTagV1SparrEntityTagsEntityTypeEntityIdTagsPost	POST /v1/sparr/entity-tags/{entity_type}/{entity_id}/tags	Attach Tag
SparrApi	createCheckoutSessionForPriceV1	POST /v1/sparr/pricing/{price_id}/checkout	Create Checkout Session For Price
SparrApi	createCourseV1	POST /v1/sparr/courses	Create Course
SparrApi	createCustomerPortalV1	POST /v1/sparr/customers/portal	Create Customer Portal
SparrApi	createFeedbackCommentV1	POST /v1/sparr/feedback-comments	Create Feedback Comment
SparrApi	createFeedbackV1	POST /v1/sparr/feedbacks	Create Feedback
SparrApi	createGoalsV1	POST /v1/sparr/goals	Create Goals
SparrApi	createPersonaV1	POST /v1/sparr/personas	Create Persona
SparrApi	createPostCallEvaluationParamsV1	POST /v1/sparr/evaluators	Create Evaluator
SparrApi	createScenarioV1	POST /v1/sparr/scenarios	Create Scenario
SparrApi	createTrackerV1	POST /v1/sparr/trackers	Create Tracker
SparrApi	deleteCourseV1	DELETE /v1/sparr/courses/{course_id}	Delete Course
SparrApi	deleteEvaluatorV1	DELETE /v1/sparr/evaluators/{params_id}	Delete Evaluator
SparrApi	deleteFeedbackCommentV1	DELETE /v1/sparr/feedback-comments/{feedback_comment_id}	Delete Feedback Comment
SparrApi	deleteFeedbackV1	DELETE /v1/sparr/feedbacks/{feedback_id}	Delete Feedback
SparrApi	deleteFileV1	DELETE /v1/sparr/files/{file_id}	Delete File
SparrApi	deleteGoalsV1	DELETE /v1/sparr/goals/{goals_id}	Delete Goals
SparrApi	deletePersonaV1	DELETE /v1/sparr/personas/{persona_id}	Delete Persona
SparrApi	deleteScenarioV1	DELETE /v1/sparr/scenarios/{scenario_id}	Delete Scenario
SparrApi	deleteTrackerV1	DELETE /v1/sparr/trackers/{tracker_id}	Delete Tracker
SparrApi	detachTagV1SparrEntityTagsEntityTypeEntityIdTagsTagNameDelete	DELETE /v1/sparr/entity-tags/{entity_type}/{entity_id}/tags/{tag_name}	Detach Tag
SparrApi	evaluateFeedbackV1	POST /v1/sparr/evaluate-feedback	Evaluate Feedback V1
SparrApi	generateEvaluatorV1	POST /v1/sparr/evaluators/generate	Generate Evaluator
SparrApi	generateFeedbackV1	POST /v1/sparr/feedbacks/generate_feedback	Generate Feedback
SparrApi	generatePersonaV1	POST /v1/sparr/generate/persona	Generate Persona
SparrApi	generateScenarioV1	POST /v1/sparr/generate/scenario	Generate Scenario
SparrApi	getCourseV1	GET /v1/sparr/courses/{course_id}	Get Course
SparrApi	getCreditsV1	GET /v1/sparr/credits	Get Credits V1
SparrApi	getEntitiesByTagV1SparrEntityTagsEntityTypeByTagTagNameGet	GET /v1/sparr/entity-tags/{entity_type}/by-tag/{tag_name}	Get Entities By Tag
SparrApi	getEntityTagsV1SparrEntityTagsEntityTypeEntityIdTagsGet	GET /v1/sparr/entity-tags/{entity_type}/{entity_id}/tags	Get Entity Tags
SparrApi	getEvaluatorV1	GET /v1/sparr/evaluators/{params_id}	Get Evaluator By Id
SparrApi	getFeedbackCommentV1	GET /v1/sparr/feedback-comments/{feedback_comment_id}	Get Feedback Comment By Id
SparrApi	getFeedbackV1	GET /v1/sparr/feedbacks/{feedback_id}	Get Feedback
SparrApi	getFileV1	GET /v1/sparr/files/{file_id}	Get File
SparrApi	getGoalsV1	GET /v1/sparr/goals/{goals_id}	Get Goals By Id
SparrApi	getMetricsV1	POST /v1/sparr/feedbacks/metrics	Get Metrics
SparrApi	getPersonaV1	GET /v1/sparr/personas/{persona_id}	Get Persona
SparrApi	getPricingV1	GET /v1/sparr/pricing	Get Pricing V1
SparrApi	getScenarioV1	GET /v1/sparr/scenarios/{scenario_id}	Get Scenario
SparrApi	getTrackerV1	GET /v1/sparr/trackers/{tracker_id}	Get Tracker By Id
SparrApi	getUserStatsV1	GET /v1/sparr/user_stats/{user_id}	Get User Stats
SparrApi	importLinkedinPersonaV1	POST /v1/sparr/personas/import-linkedin	Import Linkedin Persona
SparrApi	initializeWorkspaceV1	POST /v1/sparr/initialize-workspace	Initialize Workspace V1
SparrApi	listCoursesV1	GET /v1/sparr/courses	Get Courses
SparrApi	listEvaluatorV1	GET /v1/sparr/evaluators	Get Evaluator
SparrApi	listFeedbackCommentsV1	GET /v1/sparr/feedback-comments	List Feedback Comments
SparrApi	listFeedbacksV1	GET /v1/sparr/feedbacks	Get Feedbacks
SparrApi	listGoalsV1	GET /v1/sparr/goals	Get Goals
SparrApi	listPersonasV1	GET /v1/sparr/personas	Get Personas
SparrApi	listScenariosV1	GET /v1/sparr/scenarios	Get Scenarios
SparrApi	listTrackerV1	GET /v1/sparr/trackers	Get Trackers
SparrApi	listUserAssignmentsV1	GET /v1/sparr/courses/users/{user_id}/assignments	Get User Assignments
SparrApi	listUserCourseAttemptsV1	GET /v1/sparr/courses/{course_id}/attempts/users/{user_id}	Get User Course Attempts
SparrApi	listUserModuleAttemptsV1	GET /v1/sparr/courses/modules/{module_id}/attempts/{user_id}	Get User Module Attempts
SparrApi	revokeCourseV1	DELETE /v1/sparr/courses/{course_id}/assign/{user_id}	Revoke Course
SparrApi	searchGoalsV1	GET /v1/sparr/goals/search	Search Goals
SparrApi	searchPersonasV1	GET /v1/sparr/personas/search	Search Personas
SparrApi	searchScenariosV1	GET /v1/sparr/scenarios/search	Search Scenarios
SparrApi	searchTrackerV1	GET /v1/sparr/trackers/search	Search Tracker
SparrApi	statusSparrStatusGet	GET /sparr/status	Heart Beat Status Of Sparr Service
SparrApi	updateCourseCompletionStatusV1	PUT /v1/sparr/courses/{course_id}/assign/{user_id}/status	Update Course Completion Status
SparrApi	updateCourseV1	PUT /v1/sparr/courses/{course_id}	Update Course
SparrApi	updateEvaluatorV1	PUT /v1/sparr/evaluators/{params_id}	Update Evaluator
SparrApi	updateFeedbackCommentV1	PUT /v1/sparr/feedback-comments/{feedback_comment_id}	Update Feedback Comment
SparrApi	updateFeedbackV1	PUT /v1/sparr/feedbacks/{feedback_id}	Update Feedback
SparrApi	updateGoalsV1	PUT /v1/sparr/goals/{goals_id}	Update Goals
SparrApi	updatePersonaV1	PUT /v1/sparr/personas/{persona_id}	Update Persona
SparrApi	updateScenarioV1	PUT /v1/sparr/scenarios/{scenario_id}	Update Scenario
SparrApi	updateTrackerV1	PUT /v1/sparr/trackers/{tracker_id}	Update Tracker
SparrApi	uploadFilesV1	POST /v1/sparr/files/upload	Upload Files
SparrResellerApi	createCourseResellerV1	POST /v1/resellers/sparr/courses/	Create Course
SparrResellerApi	createEvaluatorResellerV1	POST /v1/resellers/sparr/evaluators/	Create Evaluator
SparrResellerApi	createGoalsResellerV1	POST /v1/resellers/sparr/goals/	Create Goals
SparrResellerApi	createPersonaResellerV1	POST /v1/resellers/sparr/personas/	Create Persona
SparrResellerApi	createScenarioResellerV1	POST /v1/resellers/sparr/scenarios/	Create Scenario
SparrResellerApi	createTrackerResellerV1	POST /v1/resellers/sparr/trackers/	Create Tracker
SparrResellerApi	deleteCourseResellerV1	DELETE /v1/resellers/sparr/courses/{course_id}	Delete Course
SparrResellerApi	deleteEvaluatorResellerV1	DELETE /v1/resellers/sparr/evaluators/{params_id}	Delete Evaluator
SparrResellerApi	deleteGoalsResellerV1	DELETE /v1/resellers/sparr/goals/{goals_id}	Delete Goals
SparrResellerApi	deletePersonaResellerV1	DELETE /v1/resellers/sparr/personas/{persona_id}	Delete Persona
SparrResellerApi	deleteScenarioResellerV1	DELETE /v1/resellers/sparr/scenarios/{scenario_id}	Delete Scenario
SparrResellerApi	deleteTrackerResellerV1	DELETE /v1/resellers/sparr/trackers/{tracker_id}	Delete Tracker
SparrResellerApi	generateEvaluatorResellerV1	POST /v1/resellers/sparr/evaluators/generate	Generate Evaluator
SparrResellerApi	getCourseResellerV1	GET /v1/resellers/sparr/courses/{course_id}	Get Course
SparrResellerApi	getEvaluatorResellerV1	GET /v1/resellers/sparr/evaluators/{params_id}	Get Evaluator By Id
SparrResellerApi	getGoalsResellerV1	GET /v1/resellers/sparr/goals/{goals_id}	Get Goals By Id
SparrResellerApi	getPersonaResellerV1	GET /v1/resellers/sparr/personas/{persona_id}	Get Persona
SparrResellerApi	getScenarioResellerV1	GET /v1/resellers/sparr/scenarios/{scenario_id}	Get Scenario
SparrResellerApi	getTrackerResellerV1	GET /v1/resellers/sparr/trackers/{tracker_id}	Get Tracker By Id
SparrResellerApi	importLinkedinPersonaResellerV1	POST /v1/resellers/sparr/personas/import-linkedin	Import Linkedin Persona
SparrResellerApi	listCoursesResellerV1	GET /v1/resellers/sparr/courses	Get Courses
SparrResellerApi	listEvaluatorResellerV1	GET /v1/resellers/sparr/evaluators/	Get Evaluator
SparrResellerApi	listGoalsResellerV1	GET /v1/resellers/sparr/goals/	Get Goals
SparrResellerApi	listPersonasResellerV1	GET /v1/resellers/sparr/personas/	Get Personas
SparrResellerApi	listScenariosResellerV1	GET /v1/resellers/sparr/scenarios/	Get Scenarios
SparrResellerApi	listTrackerResellerV1	GET /v1/resellers/sparr/trackers/	Get Trackers
SparrResellerApi	searchGoalsResellerV1	GET /v1/resellers/sparr/goals/search	Search Goals
SparrResellerApi	searchPersonasResellerV1	GET /v1/resellers/sparr/personas/search	Search Personas
SparrResellerApi	searchScenariosResellerV1	GET /v1/resellers/sparr/scenarios/search	Search Scenarios
SparrResellerApi	searchTrackerResellerV1	GET /v1/resellers/sparr/trackers/search	Search Tracker
SparrResellerApi	updateCourseResellerV1	PUT /v1/resellers/sparr/courses/{course_id}	Update Course
SparrResellerApi	updateEvaluatorResellerV1	PUT /v1/resellers/sparr/evaluators/{params_id}	Update Evaluator
SparrResellerApi	updateGoalsResellerV1	PUT /v1/resellers/sparr/goals/{goals_id}	Update Goals
SparrResellerApi	updatePersonaResellerV1	PUT /v1/resellers/sparr/personas/{persona_id}	Update Persona
SparrResellerApi	updateScenarioResellerV1	PUT /v1/resellers/sparr/scenarios/{scenario_id}	Update Scenario
SparrResellerApi	updateTrackerResellerV1	PUT /v1/resellers/sparr/trackers/{tracker_id}	Update Tracker
SparringApi	createVirtualProspectV1SparrVirtualProspectsPost	POST /v1/sparr/virtual-prospects	Create Virtual Prospect
SparringApi	deleteVirtualProspectV1SparrVirtualProspectsProspectIdDelete	DELETE /v1/sparr/virtual-prospects/{prospect_id}	Delete Virtual Prospect
SparringApi	getSparringStatsV1SparrSparringStatsGet	GET /v1/sparr/sparring-stats	Get Sparring Stats
SparringApi	getVirtualProspectByAgentIdV1SparrAgentAgentIdVirtualProspectGet	GET /v1/sparr/agent/{agent_id}/virtual-prospect	Get Virtual Prospect by Agent ID
SparringApi	getVirtualProspectV1SparrVirtualProspectsProspectIdGet	GET /v1/sparr/virtual-prospects/{prospect_id}	Get Virtual Prospect
SparringApi	linkVirtualProspectToAgentV1SparrVirtualProspectsProspectIdAgentAgentIdLinkPost	POST /v1/sparr/virtual-prospects/{prospect_id}/agent/{agent_id}/link	Link Virtual Prospect to Agent
SparringApi	listVirtualProspectsV1SparrVirtualProspectsGet	GET /v1/sparr/virtual-prospects	List Virtual Prospects
SparringApi	updateVirtualProspectV1SparrVirtualProspectsProspectIdPut	PUT /v1/sparr/virtual-prospects/{prospect_id}	Update Virtual Prospect
TelephonyApi	getAgentPhonesV1	GET /v1/ai-agents/{agent_id}/phones	Get Agent Phones
TelephonyApi	linkPhoneToAgentV1	POST /v1/telephony/phones/{phone_id}/ai-agents/{agent_id}/link	Link Phone To Agent
TelephonyApi	listAvailablePhonesV1	GET /v1/telephony/countries/{country_code}/available-phones	List Available Phones
TelephonyApi	listPurchasedPhonesV1	GET /v1/telephony/phones	List Purchased Phones
TelephonyApi	listSupportedCountriesV1	GET /v1/telephony/countries	List Supported Countries
TelephonyApi	purchasePhoneV1	POST /v1/telephony/phones	Purchase Phone
TelephonyApi	releasePhoneV1	DELETE /v1/telephony/phones/{phone_id}	Release Phone
TelephonyApi	unlinkPhoneFromAgentV1	DELETE /v1/telephony/phones/{phone_id}/ai-agents/{agent_id}/link	Unlink Phone From Agent
UIApi	listActionTemplatesV1	GET /v1/ui/action-templates	List Action Templates
UIApi	listProductsDetailedV1	GET /v1/ui/products	List Products
UIApi	listPromptTemplatesV1	GET /v1/ui/prompt-templates	List Prompt Templates
UIApi	listRoleTemplatesV1	GET /v1/ui/role-templates	List Role Templates
VoiceModelsApi	listSparrVoiceModelsV1	GET /v1/sparr-voice-models	Get List Of Voices Available For Sparr
VoiceModelsApi	listVoiceModelsV1	GET /v1/voice-models	Get List Of Voices Available For Conversations
WorkflowsApi	createWorkflowV1WorkflowsPost	POST /v1/workflows	Create Workflow
WorkflowsApi	deleteWorkflowV1WorkflowsWorkflowIdDelete	DELETE /v1/workflows/{workflow_id}	Delete Workflow
WorkflowsApi	readWorkflowV1WorkflowsWorkflowIdGet	GET /v1/workflows/{workflow_id}	Read Workflow
WorkflowsApi	readWorkflowsV1WorkflowsGet	GET /v1/workflows	Read Workflows
WorkflowsApi	triggerWorkflowStepV1WorkflowsWorkflowIdStepStepIdTriggerPost	POST /v1/workflows/{workflow_id}/step/{step_id}/trigger	Trigger Workflow Step
WorkflowsApi	updateWorkflowV1WorkflowsWorkflowIdPut	PUT /v1/workflows/{workflow_id}	Update Workflow
WorkflowsApi	uploadFileV1WorkflowsWorkflowIdFilePost	POST /v1/workflows/{workflow_id}/file	Upload File
WorkflowsApiHubspotApi	handleHubspotWebhookV1WorkflowsApiHubspotWebhookPost	POST /v1/workflows/api/hubspot/webhook	Handle Hubspot Webhook
WorkflowsAppsApi	createAppV1WorkflowsAppsPost	POST /v1/workflows/apps	Create App
WorkflowsAppsApi	deleteAppV1WorkflowsAppsAppIdDelete	DELETE /v1/workflows/apps/{app_id}	Delete App
WorkflowsAppsApi	getConnectionsByAppIdV1WorkflowsAppsAppIdVersionsVersionConnectionsGet	GET /v1/workflows/apps/{app_id}/versions/{version}/connections	Get Connections By App Id
WorkflowsAppsApi	readAppV1WorkflowsAppsAppIdGet	GET /v1/workflows/apps/{app_id}	Read App
WorkflowsAppsApi	readAppsV1WorkflowsAppsGet	GET /v1/workflows/apps	Read Apps
WorkflowsAppsApi	updateAppV1WorkflowsAppsAppIdPut	PUT /v1/workflows/apps/{app_id}	Update App
WorkflowsConnectionsApi	createConnectionV1WorkflowsConnectionsPost	POST /v1/workflows/connections	Create Connection
WorkflowsConnectionsApi	deleteConnectionV1WorkflowsConnectionsConnectionIdDelete	DELETE /v1/workflows/connections/{connection_id}	Delete Connection
WorkflowsConnectionsApi	readConnectionV1WorkflowsConnectionsConnectionIdGet	GET /v1/workflows/connections/{connection_id}	Read Connection
WorkflowsConnectionsApi	readConnectionsV1WorkflowsConnectionsGet	GET /v1/workflows/connections	Read Connections
WorkflowsConnectionsApi	updateConnectionV1WorkflowsConnectionsConnectionIdPut	PUT /v1/workflows/connections/{connection_id}	Update Connection
WorkflowsExecutionsApi	executeWorkflowV1WorkflowsExecutionsWorkflowIdExecutePost	POST /v1/workflows/executions/{workflow_id}/execute	Execute Workflow
WorkflowsExecutionsApi	getWorkflowStatusV1WorkflowsExecutionsWorkflowIdRunsRunIdGet	GET /v1/workflows/executions/{workflow_id}/runs/{run_id}	Get Workflow Status
WorkflowsExecutionsApi	listWorkflowRunsV1WorkflowsExecutionsWorkflowIdRunsGet	GET /v1/workflows/executions/{workflow_id}/runs	List Workflow Runs
WorkflowsExecutionsApi	triggerWorkflowV1WorkflowsExecutionsWorkflowIdTriggerPost	POST /v1/workflows/executions/{workflow_id}/trigger	Trigger Workflow
WorkflowsSubWorkflowsApi	getSubWorkflowsV1WorkflowsStepsSubWorkflowsPost	POST /v1/workflows/steps/sub_workflows	Get Sub Workflows

Documentation For Models

• AIAgentInput
• AIAgentOutput
• Accent
• AcceptInviteRequest
• ActionInput
• ActionInvocationTrigger
• ActionOutput
• Adaptability
• Adaptability1
• Adaptability2
• AddressInput
• AddressOutput
• AgentConfig
• AgenticWorkflowActionEndpoint
• AgenticWorkflowAdkModelsWorkflowAppEnum
• AgenticWorkflowDbModelsConnection
• AgenticWorkflowModelsBaseBaseResponse
• AgentsInner
• AggregationFormulaInput
• AggregationFormulaOutput
• AggregationPeriod
• Aiwhatcanbeimproved
• Aiwhatwentwell
• AnalyticsModelInput
• AnalyticsModelInputWeightedScoresValue
• AnalyticsModelOutput
• AnalyticsRequest
• AnalyticsResponse
• ApiKeyAuth
• ApiKeyCredentials
• ApiKeyRequest
• App
• AppAction
• AppActionEntity
• AppActionType
• AppEntity
• AppEnumInput
• AppEnumOutput
• AppResponse
• AuditLog
• AuthInner
• AuthRole
• AvailablePhoneNumber
• BaseResponseInput
• BasicAuth
• BasicAuthCredentials
• BasicCredentials
• BatchMetricsRequestsInput
• BatchMetricsResponseInput
• BodyCreateCustomerOrganizationV1
• BodyCreateOrganizationV1
• BodyCreateResellerOrganizationV1
• CallRecording
• CallSentiment
• CallType
• ChangeAssignmentOperation
• ChangeAssignmentRequest
• CoachAnalyticsModel
• CombinedEvaluatorResponse
• Comment
• CommunicationStyle
• CommunicationStyle1
• Condition
• ConnectionCore
• ConnectionOutput
• ConnectionSource
• ConversationAnalyticsModelInput
• ConversationEndEvent
• ConversationEndEventPayload
• ConversationEvaluation
• ConversationEvaluationData
• ConversationEvaluationMetric
• ConversationEvaluationMetrics
• ConversationFeedback
• ConversationInput
• ConversationOutput
• ConversationSourceType
• ConversationStartEvent
• ConversationStartEventPayload
• ConversationStatsModel
• CountryInfo
• Course
• CourseAssignmentStatus
• CourseCompletionStatus
• CourseCore
• CourseRequest
• CourseResponse
• CourseUpdateRequest
• CourseWithAssignmentStatus
• Courses
• CreateScenarioRequest
• Credentials
• Credit
• CreditTypeEnum
• CustomerBranding
• Customers
• DecisionMakingStyle
• DecisionMakingStyle1
• DialogLine
• DialogWordWithTimestamp
• EmbeddingsModelConfig
• Endpoint
• EngagementLevel
• EngagementLevel1
• EntityTag
• EvaluationInput
• EvaluationOutput
• Evaluator
• EvaluatorCore
• EvaluatorRequest
• EvaluatorResponse
• Excitementlevel
• ExternalReference
• ExternalServiceProviderInput
• ExternalServiceProviderOutput
• FamiliarityLevel
• Feedback
• FeedbackCommentCore
• FeedbackCommentInput
• FeedbackCommentThreadInput
• FeedbackCommentThreadOutput
• FeedbackCore
• FeedbackProps
• File
• Files
• FillerWords
• FillersConfig
• FilterOperator
• FlexibleGenerationRequest
• FrustrationTolerance
• FrustrationTolerance1
• GenerateFeedbackRequest
• GeneratePersona
• GenerateScenario
• GoalAnalyticsModelInput
• GoalAnalyticsModelOutput
• GoalCategoryResponseInput
• GoalCategoryResponseOutput
• GoalCoreInput
• GoalCoreOutput
• GoalEvaluationResultInput
• GoalEvaluationResultOutput
• GoalInput
• GoalsSearchResponse
• GuestInput
• GuestOutput
• HTTPValidationError
• Hive
• HiveContentInput
• HiveContentOutput
• HiveStorageConfig
• HiveType
• HttpActionEndpoint
• Humanwhatcanbeimproved
• Humanwhatwentwell
• IntelligenceProvider
• IntelligenceProviderConfig
• InteractionTone
• InternalActionEndpoint
• Language
• LanguageAccentCombo
• LiveFeedbackProps
• LiveKitTokenRequest
• LocationInner
• LongestMonologue
• MetricDataPoint
• MetricFilter
• MetricNameInput
• MetricRequest
• MetricResponseDataPointInput
• MetricsRequestInput
• MetricsResponseInput
• Mission
• Module
• ModuleAnalytics
• ModuleAttemptStatus
• ModuleCore
• ModuleUpdateRequest
• NegotiationStyle
• NegotiationStyle1
• NextStepResolver
• NoAuth
• NoAuthCredentials
• NumberPurchaseRequest
• OAuth
• OAuthCredentials
• Objection
• OrgUsersPriceCredits
• OrgWithCourseAssignment
• OrgWithUsers
• OrganizationInitializationStatus
• OrganizationInput
• OrganizationOutput
• OrganizationSettings
• PatienceLevel
• PatienceLevel1
• PersonaAttributesAndTraits
• PersonaCore
• PersonaInput
• PersonaOutput
• PersonaSearchResponse
• PreferredTone
• PreferredTone1
• Price
• PriceInterval
• PriceItem
• PricingRequest
• ProductInput
• ProductOutput
• ProductWithAgents
• PromptTemplate
• ProspectInput
• ProspectOutput
• ProspectStatus
• ResellerBatchMetricsRequests
• ResellerPaymentAccountDetails
• ResponseGetorganizationbrandingv1
• Role
• RoleTemplate
• RubricLevel
• RubricScore
• Rudenesslevel
• ScenarioInput
• ScenarioOutput
• ScenarioResponse
• ScenarioSearchResponse
• Sequence
• SortOrder
• SparrAdaptability
• SparrCommunicationStyle
• SparrDbModelsFeedbackComment
• SparrDbModelsGoal
• SparrDecisionMakingStyle
• SparrDemeanorInput
• SparrDemeanorOutput
• SparrDialogLine
• SparrDialogLineWithSentiment
• SparrDialogLineWithTimestamp
• SparrEngagementLevel
• SparrExcitementLevel
• SparrFeedbackProps
• SparrFrustrationTolerance
• SparrInitializeWorkspacePayload
• SparrInteractionTone
• SparrLanguageAccentCombo
• SparrModelsAnalyticsAggregationFormula
• SparrModelsAnalyticsBatchMetricsRequests
• SparrModelsAnalyticsBatchMetricsResponse
• SparrModelsAnalyticsConversationAnalyticsModel
• SparrModelsAnalyticsMetricName
• SparrModelsAnalyticsMetricResponseDataPoint
• SparrModelsAnalyticsMetricsRequest
• SparrModelsAnalyticsMetricsResponse
• SparrModelsBaseBaseResponse
• SparrModelsFeedbackFeedbackComment
• SparrModelsScenarioGoal
• SparrNegotiationStyle
• SparrPatienceLevel
• SparrPersonaAttributesAndTraits
• SparrRudenessLevel
• SparrStatsData
• SparrStatsResponse
• SparrVoiceAccent
• SparrVoiceInput
• SparrVoiceLanguage
• SparrVoiceOutput
• SparrWorkDetails
• Sparrv1EvaluateFeedbackRequest
• StatsData
• StatsResponse
• Status
• Step
• Subscription
• SubscriptionInfo
• SynthesizerConfig
• SystemMetricsInput
• SystemMetricsOutput
• TagCreate
• TaxDetailsInput
• TaxDetailsOutput
• TelephoneNumber
• TelephonyApp
• TelephonyConnectRequest
• TelephonyConnectResponse
• TimestampRange
• Tracker
• TrackerAnalyticsModel
• TrackerCore
• TrackerSearchResponse
• TrackingCategory
• Transcriber
• TranscriberConfig
• UiNodeType
• UpdateResellerOrganizationRequest
• UpdateUserRequest
• UploadFileResponse
• User
• UserApiKeyLink
• UserCourseAssignment
• UserCourseAssignmentAnalyticsResponse
• UserData
• UserModuleAttempt
• UserModuleAttemptCore
• UserModuleAttemptResponse
• UserPayload
• UserPerformanceSummary
• UserPerformanceSummaryRequest
• UserPerformanceSummaryResponse
• UserRecentActivity
• UserStats
• UserStatsItem
• ValidationError
• Value
• ValueAnyOfInner
• VirtualProspectAIAgentLink
• VirtualProspectInput
• VirtualProspectOutput
• VirtualProspectTypeEnum
• VoiceInput
• VoiceModel
• VoiceOutput
• Workflow
• WorkflowActivityInfo
• WorkflowContext
• WorkflowCore
• WorkflowExecution
• WorkflowStepInput
• WorkflowStepOutput
• WorkflowStepTriggerRequest
• WorkflowStepTriggerResponse

Documentation For Authorization

Authentication schemes defined for the API:

HTTPBearer

• Type: HTTP Bearer Token authentication

Author