Get recording by ID
curl --request GET \
--url https://api.siro.ai/v1/core/recordings/{id} \
--header 'x-siro-auth-token: <api-key>'import requests
url = "https://api.siro.ai/v1/core/recordings/{id}"
headers = {"x-siro-auth-token": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-siro-auth-token': '<api-key>'}};
fetch('https://api.siro.ai/v1/core/recordings/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.siro.ai/v1/core/recordings/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-siro-auth-token: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.siro.ai/v1/core/recordings/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-siro-auth-token", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.siro.ai/v1/core/recordings/{id}")
.header("x-siro-auth-token", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.siro.ai/v1/core/recordings/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-siro-auth-token"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"dateCreated": "<string>",
"deleted": true,
"processingStage": "done",
"organizationId": "<string>",
"teamId": "<string>",
"userId": "<string>",
"title": "<string>",
"durationInMilliseconds": 123,
"conversationType": "<string>",
"crmOpportunities": [
{
"opportunityExternalId": "opp_12345",
"accountId": "acc_67890",
"accountName": "Acme Corporation",
"accountExternalId": "ext_acc_12345",
"disposition": "Closed Won",
"closedAt": "2024-01-15T10:30:00Z",
"name": "Q1 Software License Renewal",
"amount": 50000,
"integrationName": "Salesforce",
"integrationPlatform": "salesforce",
"addresses": [
{
"street": "123 Main St",
"city": "New York",
"state": "NY",
"zip": "10001",
"country": "USA"
}
]
}
],
"crmCustomer": {
"id": "acc_12345",
"name": "Acme Corporation",
"customerType": "ACCOUNT",
"externalId": "ext_67890",
"createdAt": "2024-01-01T00:00:00.000Z",
"updatedAt": "2024-01-15T08:30:00.000Z",
"lastActivityAt": "2024-01-15T08:30:00.000Z",
"matchingSource": "DIRECT",
"emailAddress": "contact@acme.com",
"phoneNumber": "+1-555-123-4567",
"crmUrl": "https://acme.salesforce.com/lightning/r/Account/001XX000004C9Z6YAK/view",
"organizationId": "12345"
},
"evaluationScore": 123,
"followups": [
{
"recordingId": "<string>",
"recordingTitle": "<string>",
"repName": "<string>",
"repId": "<string>",
"teamName": "<string>",
"teamId": "<string>",
"followupId": "<string>",
"dateCreated": "<string>",
"score": 123,
"followupAction": "<string>",
"context": [
{
"header": "<string>",
"value": "<string>"
}
],
"updatedAt": "<string>",
"metadata": [
{}
],
"starred": true,
"thinking": "<string>",
"crmCustomer": {
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"organizationId": "<string>",
"name": "<string>",
"crmUrl": "<string>",
"lastActivityAt": "<string>",
"closedAt": "2023-11-07T05:31:56Z",
"emailAddress": "<string>",
"phoneNumber": "<string>",
"externalId": "<string>",
"amount": 123,
"disposition": "<string>",
"recordingId": "<string>",
"lastRecordingDate": "2023-11-07T05:31:56Z",
"numRecordings": 123,
"accountId": "<string>",
"opportunityAccountName": "<string>",
"contactId": "<string>",
"opportunityContactName": "<string>",
"opportunityId": "<string>",
"engagementId": "<string>",
"opportunity": {
"id": "<string>",
"externalId": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"organizationId": "<string>",
"name": "<string>",
"amount": 123,
"closedAt": "<string>",
"disposition": "<string>",
"recordingId": "<string>",
"accountId": "<string>",
"account": null,
"opportunityUsers": [
null
]
},
"opportunities": {
"data": [
{
"id": "<string>",
"externalId": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"organizationId": "<string>",
"name": "<string>",
"amount": 123,
"closedAt": "<string>",
"disposition": "<string>",
"recordingId": "<string>",
"accountId": "<string>",
"account": null,
"opportunityUsers": [
null
]
}
],
"cursor": "<string>"
},
"opportunityUsers": [
null
],
"contactAccount": {
"id": "<string>",
"name": "<string>",
"externalId": "<string>"
},
"address": "<string>",
"integrationConnectionId": "<string>",
"integrationName": "<string>"
},
"hasFollowupComment": true,
"note": "<string>",
"completed": true,
"completedBy": "<string>",
"completedAt": "<string>",
"history": [
{
"id": "<string>",
"updatedBy": "<string>",
"updatedByUserId": "<string>",
"createdAt": "<string>",
"note": "<string>"
}
],
"crmUrl": "<string>"
}
],
"universalOutcomeLabel": "POSITIVE",
"summary": "The Sales Rep offered a variety of options.",
"entityExtractions": [
{
"id": "extraction_001",
"recordingId": "recording_001",
"siroEntityDefinitionId": "siro_entity_definition_001",
"siroEntityDefinitionDeleted": false,
"status": "SUCCESS",
"extraction": [
{
"name": "Objection Reason",
"value": "Financial Concerns",
"mappings": [
{
"crmModelName": "Opportunity",
"crmFieldName": "Objection_Reason__c"
}
]
}
],
"createdAt": "2021-01-01T00:00:00Z",
"updatedAt": "2021-01-01T00:00:00Z",
"mappings": [
{
"crmModelName": "Opportunity",
"crmFieldName": "Next_Steps__c"
}
],
"siroEntityDefinitionName": "Objection Reason"
}
]
},
"cursor": "<string>",
"pageSize": 123,
"limit": 123,
"total": 123,
"hasNextPage": true
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"issues": [
{
"code": "<string>",
"path": [
"<string>"
],
"message": "<string>",
"expected": "<string>",
"received": "<string>"
}
],
"name": "ZodError"
}{
"error": "<string>"
}Recordings
Get recording by ID
Get a single recording by ID with optional related data
GET
/
v1
/
core
/
recordings
/
{id}
Get recording by ID
curl --request GET \
--url https://api.siro.ai/v1/core/recordings/{id} \
--header 'x-siro-auth-token: <api-key>'import requests
url = "https://api.siro.ai/v1/core/recordings/{id}"
headers = {"x-siro-auth-token": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-siro-auth-token': '<api-key>'}};
fetch('https://api.siro.ai/v1/core/recordings/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.siro.ai/v1/core/recordings/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-siro-auth-token: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.siro.ai/v1/core/recordings/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-siro-auth-token", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.siro.ai/v1/core/recordings/{id}")
.header("x-siro-auth-token", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.siro.ai/v1/core/recordings/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-siro-auth-token"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"dateCreated": "<string>",
"deleted": true,
"processingStage": "done",
"organizationId": "<string>",
"teamId": "<string>",
"userId": "<string>",
"title": "<string>",
"durationInMilliseconds": 123,
"conversationType": "<string>",
"crmOpportunities": [
{
"opportunityExternalId": "opp_12345",
"accountId": "acc_67890",
"accountName": "Acme Corporation",
"accountExternalId": "ext_acc_12345",
"disposition": "Closed Won",
"closedAt": "2024-01-15T10:30:00Z",
"name": "Q1 Software License Renewal",
"amount": 50000,
"integrationName": "Salesforce",
"integrationPlatform": "salesforce",
"addresses": [
{
"street": "123 Main St",
"city": "New York",
"state": "NY",
"zip": "10001",
"country": "USA"
}
]
}
],
"crmCustomer": {
"id": "acc_12345",
"name": "Acme Corporation",
"customerType": "ACCOUNT",
"externalId": "ext_67890",
"createdAt": "2024-01-01T00:00:00.000Z",
"updatedAt": "2024-01-15T08:30:00.000Z",
"lastActivityAt": "2024-01-15T08:30:00.000Z",
"matchingSource": "DIRECT",
"emailAddress": "contact@acme.com",
"phoneNumber": "+1-555-123-4567",
"crmUrl": "https://acme.salesforce.com/lightning/r/Account/001XX000004C9Z6YAK/view",
"organizationId": "12345"
},
"evaluationScore": 123,
"followups": [
{
"recordingId": "<string>",
"recordingTitle": "<string>",
"repName": "<string>",
"repId": "<string>",
"teamName": "<string>",
"teamId": "<string>",
"followupId": "<string>",
"dateCreated": "<string>",
"score": 123,
"followupAction": "<string>",
"context": [
{
"header": "<string>",
"value": "<string>"
}
],
"updatedAt": "<string>",
"metadata": [
{}
],
"starred": true,
"thinking": "<string>",
"crmCustomer": {
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"organizationId": "<string>",
"name": "<string>",
"crmUrl": "<string>",
"lastActivityAt": "<string>",
"closedAt": "2023-11-07T05:31:56Z",
"emailAddress": "<string>",
"phoneNumber": "<string>",
"externalId": "<string>",
"amount": 123,
"disposition": "<string>",
"recordingId": "<string>",
"lastRecordingDate": "2023-11-07T05:31:56Z",
"numRecordings": 123,
"accountId": "<string>",
"opportunityAccountName": "<string>",
"contactId": "<string>",
"opportunityContactName": "<string>",
"opportunityId": "<string>",
"engagementId": "<string>",
"opportunity": {
"id": "<string>",
"externalId": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"organizationId": "<string>",
"name": "<string>",
"amount": 123,
"closedAt": "<string>",
"disposition": "<string>",
"recordingId": "<string>",
"accountId": "<string>",
"account": null,
"opportunityUsers": [
null
]
},
"opportunities": {
"data": [
{
"id": "<string>",
"externalId": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"organizationId": "<string>",
"name": "<string>",
"amount": 123,
"closedAt": "<string>",
"disposition": "<string>",
"recordingId": "<string>",
"accountId": "<string>",
"account": null,
"opportunityUsers": [
null
]
}
],
"cursor": "<string>"
},
"opportunityUsers": [
null
],
"contactAccount": {
"id": "<string>",
"name": "<string>",
"externalId": "<string>"
},
"address": "<string>",
"integrationConnectionId": "<string>",
"integrationName": "<string>"
},
"hasFollowupComment": true,
"note": "<string>",
"completed": true,
"completedBy": "<string>",
"completedAt": "<string>",
"history": [
{
"id": "<string>",
"updatedBy": "<string>",
"updatedByUserId": "<string>",
"createdAt": "<string>",
"note": "<string>"
}
],
"crmUrl": "<string>"
}
],
"universalOutcomeLabel": "POSITIVE",
"summary": "The Sales Rep offered a variety of options.",
"entityExtractions": [
{
"id": "extraction_001",
"recordingId": "recording_001",
"siroEntityDefinitionId": "siro_entity_definition_001",
"siroEntityDefinitionDeleted": false,
"status": "SUCCESS",
"extraction": [
{
"name": "Objection Reason",
"value": "Financial Concerns",
"mappings": [
{
"crmModelName": "Opportunity",
"crmFieldName": "Objection_Reason__c"
}
]
}
],
"createdAt": "2021-01-01T00:00:00Z",
"updatedAt": "2021-01-01T00:00:00Z",
"mappings": [
{
"crmModelName": "Opportunity",
"crmFieldName": "Next_Steps__c"
}
],
"siroEntityDefinitionName": "Objection Reason"
}
]
},
"cursor": "<string>",
"pageSize": 123,
"limit": 123,
"total": 123,
"hasNextPage": true
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"issues": [
{
"code": "<string>",
"path": [
"<string>"
],
"message": "<string>",
"expected": "<string>",
"received": "<string>"
}
],
"name": "ZodError"
}{
"error": "<string>"
}Authorizations
OAuth access token for user-scoped requests (Authorization Code or machine-to-machine). Send header x-siro-auth-token: <oauth-access-token>. Not an organization API key.
Path Parameters
ID of the recording to fetch
Query Parameters
Include CRM opportunities in the response (true/false)
Include evaluation score in the response (true/false)
Include followups in the response (true/false)
Include crm accounts in the response (true/false)
Include recording summary in the response (true/false)
Include entity extractions in the response (true/false)
⌘I