Skip to main content
Use this endpoint to retrieve the AI-generated analysis for an appointment recording. Shilo processes each appointment asynchronously after ingestion, producing coaching feedback, a call rating, conversation summary, disposition outcomes, objection handling insights, and speaker identification. Because processing takes time, you should poll this endpoint and check the progress field — results are only fully available once progress reaches 100.

Endpoint

Authentication

All requests require your API key in the x-api-key header.

Path Parameters

string
required
The unique identifier for the appointment recording. Two formats are accepted:
  • {uuid} — The Shilo recording UUID (e.g., ee6f2136-b94a-4438-9335-3acf5b2a0d31)
  • external_recording_id:{string} — The external recording ID your integration provided (e.g., external_recording_id:ext-789)

Response

A successful request returns HTTP 200 with a RecordingAnalysis object. The top-level fields id, recording_id, created_at, and progress are always present. All sub-resource fields (coaching, rating, summary, etc.) are optional and only fully populated once progress equals 100.
string
required
The UUID of this analysis record.
string
required
The Shilo recording UUID of the appointment this analysis belongs to.
string
required
The ISO-8601 timestamp indicating when this analysis was created.
number
required
A value between 0 and 100 representing how far along the AI processing pipeline this recording is. Poll this endpoint until progress equals 100 before reading any result fields.
object
Recommended follow-up actions identified by the AI. Present only after processing completes.
object
AI-generated coaching feedback for the rep on this appointment. Present only after processing completes.
object
The AI-assessed outcome and reasoning for this appointment. Present only after processing completes.
object
Objections raised by the contact during the appointment. Present only after processing completes.
object
A numeric quality rating assigned to the rep’s performance on this appointment. Present only after processing completes.
object
AI-resolved speaker identities for the appointment recording. Present only after processing completes.
object
A concise AI-generated summary of the appointment. Present only after processing completes.
Poll this endpoint until progress equals 100 before reading result fields such as coaching, rating, or summary. Sub-resource fields are absent or incomplete until processing finishes.

Error Responses

Example Request

Example Response