API Documentation
Prospects
Agents
VoiceModels
Hive
HiveAgentLink
Actions
ActionAgentLink
Products
Conversations
ConversationProspectLink
Products
List All Agents Linked to a Specific Product
List All Agents Linked to a Specific Product
GET
/
v1
/
products
/
{product_id}
/
agents
Copy
curl --request GET \
--url https://api.trata.ai/v1/products/{product_id}/agents \
--header 'Authorization: Bearer <token>'
Copy
[
{
"id": "<string>",
"orgId": "<string>",
"name": "<string>",
"imageUrl": "<string>",
"mission": {
"prompt": "Check Trata AI docs on the specifics of prompting.",
"objective": "This is a more easier version where the user dont have to given the entire prompt but just share the objective of the call and rest will be handled by Trata.",
"greeting": "Hello! Thank you for taking the time to speak with me today.",
"sequence": [
{
"stageName": "Introduction",
"description": "This stage involves introducing the AI agent to the user and explaining the purpose of the call.",
"otherNotes": "Ensure the user understands the privacy policy."
}
],
"farewell": "<string>"
},
"role": "<string>",
"roleDescription": "<string>",
"transcriber": {
"providerName": "<string>",
"transcriberModel": "<string>",
"providerProps": {}
},
"intelligenceProvider": {
"providerName": "<string>",
"model": "<string>",
"providerProps": {}
},
"voice": {
"gender": "Male",
"languageAccent": {
"language": "English",
"accent": "American"
},
"modelId": "<string>"
},
"status": "<string>",
"timezone": "<string>",
"createdBy": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedBy": "<string>",
"updatedAt": "2023-11-07T05:31:56Z"
}
]
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
ID of the product
Response
200
application/json
Successful Response
The response is of type AIAgent · object[]
.
Copy
curl --request GET \
--url https://api.trata.ai/v1/products/{product_id}/agents \
--header 'Authorization: Bearer <token>'
Copy
[
{
"id": "<string>",
"orgId": "<string>",
"name": "<string>",
"imageUrl": "<string>",
"mission": {
"prompt": "Check Trata AI docs on the specifics of prompting.",
"objective": "This is a more easier version where the user dont have to given the entire prompt but just share the objective of the call and rest will be handled by Trata.",
"greeting": "Hello! Thank you for taking the time to speak with me today.",
"sequence": [
{
"stageName": "Introduction",
"description": "This stage involves introducing the AI agent to the user and explaining the purpose of the call.",
"otherNotes": "Ensure the user understands the privacy policy."
}
],
"farewell": "<string>"
},
"role": "<string>",
"roleDescription": "<string>",
"transcriber": {
"providerName": "<string>",
"transcriberModel": "<string>",
"providerProps": {}
},
"intelligenceProvider": {
"providerName": "<string>",
"model": "<string>",
"providerProps": {}
},
"voice": {
"gender": "Male",
"languageAccent": {
"language": "English",
"accent": "American"
},
"modelId": "<string>"
},
"status": "<string>",
"timezone": "<string>",
"createdBy": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedBy": "<string>",
"updatedAt": "2023-11-07T05:31:56Z"
}
]
Assistant
Responses are generated using AI and may contain mistakes.