> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.
# Grain: Get Recording
> Get a recording by recording_id, optionally including participants, notes, highlights and AI summaries. Requires recording_id.
Get a recording by recording\_id, optionally including participants, notes, highlights and AI summaries.
Tool ID: `grain_get_recording`
## Run this action
Use the TypeScript SDK for a single call. Put `ctx.tools.execute(...)` inside a Play when the call should be durable, scheduled, or run across a CSV.
```ts theme={null}
import { Deepline } from 'deepline';
const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
'grain_get_recording',
{
"recording_id": "recording_123"
},
);
console.log(result.toolResponse.raw);
```
### CLI
```bash theme={null}
deepline tools execute grain_get_recording --input '{
"recording_id": "recording_123"
}' --json
```
## Example response
The SDK exposes this shape at `result.toolResponse.raw`. Values below are representative.
```json theme={null}
{
"data": {
"id": "id_123",
"title": "VP of Engineering",
"start_datetime": "2026-01-15T12:00:00Z"
}
}
```
Use `deepline tools get grain_get_recording --json` for the latest machine-readable contract.
## Input reference
Get a recording by recording\_id, optionally including participants, notes, highlights and AI summaries. Requires recording\_id.
| Name | Type | Required | Default | Details |
| ---------------------- | -------- | -------- | ------- | ------- |
| `payload.recording_id` | `string` | Yes | — | — |
| `payload.include` | `object` | No | — | — |
Show raw input schema
### Input JSON Schema
```json theme={null}
{
"type": "object",
"description": "Get a recording by recording_id, optionally including participants, notes, highlights and AI summaries. Requires recording_id.",
"properties": {
"recording_id": {
"type": "string"
},
"include": {
"type": "object",
"properties": {
"highlights": {
"type": "boolean",
"description": "Include clips / highlights in the response"
},
"participants": {
"type": "boolean",
"description": "Include participants in the response"
},
"ai_action_items": {
"type": "boolean",
"description": "Include the ai_action_items in the response"
},
"ai_summary": {
"type": "boolean",
"description": "Include the ai_summary in the response"
},
"private_notes": {
"type": "boolean",
"description": "Include your private notes in the response"
},
"calendar_event": {
"type": "boolean",
"description": "Include calendar event data in the response"
},
"hubspot": {
"type": "boolean",
"description": "Include HubSpot related data in the response"
},
"screenshares": {
"type": "boolean",
"description": "Include screenshare ranges in the response"
},
"ai_template_sections": {
"type": "object",
"description": "Includes ai_template_sections in the response",
"properties": {
"format": {
"type": "string",
"description": "Controls the output of ai_template_sections Defaults to json",
"enum": [
"json",
"markdown",
"text"
]
},
"allowed_sections": {
"type": "array",
"description": "Only include sections which title matches the given allowed_sections Case insensitive",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"required": [
"recording_id"
],
"additionalProperties": false
}
```
## Output reference
Standard tool result payload.
| Name | Type | Required | Default | Details |
| ------------------------------------------------ | ----------------------------------------------------------------------------------------------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
| `result.data` | `object` | Yes | — | Provider response payload. |
| `result.data.id` | `string` | No | — | Id of the recording |
| `result.data.title` | `string` | No | — | Title of the recording |
| `result.data.start_datetime` | `string` | No | — | UTC datetime at which grain started the recording |
| `result.data.end_datetime` | `string` | No | — | UTC datetime at which the recording ended |
| `result.data.duration_ms` | `integer` | No | — | Duration of the recording in ms |
| `result.data.media_type` | `"audio" \| "transcript" \| "video"` | No | — | Media type of the recording Allowed: `audio`, `transcript`, `video`. |
| `result.data.source` | `"aircall" \| "local_capture" \| "meet" \| "teams" \| "upload" \| "webex" \| "zoom" \| "other"` | No | — | From what source did Grain get the recording Allowed: `aircall`, `local_capture`, `meet`, `teams`, `upload`, `webex`, `zoom`, `other`. |
| `result.data.share_state` | `"public" \| "workspace" \| "restricted"` | No | — | public Anyone with the link workspace All workspace members restricted Only people with access Allowed: `public`, `workspace`, `restricted`. |
| `result.data.url` | `string` | No | — | URL to the recording in Grain |
| `result.data.thumbnail_url` | `string \| null` | No | — | URL to the recording's thumbnail |
| `result.data.highlights` | `array` | No | — | List of Highlights |
| `result.data.highlights[].id` | `string` | No | — | id of the highlight |
| `result.data.highlights[].recording_id` | `string` | No | — | id of the recording it was clipped from |
| `result.data.highlights[].text` | `string` | No | — | Small description of the clip, equivalent to a title |
| `result.data.highlights[].transcript` | `string` | No | — | Transcript of the clip formatted as text |
| `result.data.highlights[].speakers` | `array` | No | — | Names of the speakers of the clip |
| `result.data.highlights[].timestamp` | `integer` | No | — | Timestamp in ms from the recording of when the clip starts |
| `result.data.highlights[].duration` | `integer` | No | — | Duration of the clip in ms |
| `result.data.highlights[].tags` | `array` | No | — | Tags of the clip |
| `result.data.highlights[].url` | `string` | No | — | URL to the highlight in Grain |
| `result.data.highlights[].thumbnail_url` | `string` | No | — | URL to the highlight's thumbnail |
| `result.data.highlights[].created_datetime` | `string` | No | — | UTC datetime of when the clip was created |
| `result.data.tags` | `array` | No | — | Tags of the recording |
| `result.data.teams` | `array` | No | — | List of Teams the recording belongs to. |
| `result.data.teams[].id` | `string` | No | — | id of the team |
| `result.data.teams[].name` | `string` | No | — | Name of the team |
| `result.data.recorders` | `array` | No | — | List of users that recorded the meeting |
| `result.data.recorders[].id` | `string` | No | — | User id of the recorder |
| `result.data.recorders[].name` | `string` | No | — | Name of the recorder |
| `result.data.recorders[].email` | `string` | No | — | Email of the recorder |
| `result.data.recorders[].participant_id` | `string \| null` | No | — | Participant id of the recorder |
| `result.data.meeting_type` | `object \| null` | No | — | — |
| `result.data.meeting_type.id` | `string` | No | — | id of the meeting type |
| `result.data.meeting_type.name` | `string` | No | — | Name of the meeting type |
| `result.data.meeting_type.scope` | `"internal" \| "external"` | No | — | Scope of the meeting type Allowed: `internal`, `external`. |
| `result.data.ai_template_sections` | `array` | No | — | List of AI Template Sections |
| `result.data.ai_template_sections[].title` | `string` | No | — | Title of the section |
| `result.data.ai_template_sections[].data` | `unknown` | No | — | Section data; fields depend on the section type and requested format. |
| `result.data.ai_action_items` | `array` | No | — | List of Action Items |
| `result.data.ai_action_items[].status` | `"pending" \| "completed"` | No | — | Status of the action item Allowed: `pending`, `completed`. |
| `result.data.ai_action_items[].timestamp` | `integer` | No | — | Observed timestamp in ms at which the action item was mentioned |
| `result.data.ai_action_items[].text` | `string` | No | — | Content of the action item |
| `result.data.ai_action_items[].assignee` | `object \| null` | No | — | Assignee of the action item |
| `result.data.ai_action_items[].assignee.id` | `string` | No | — | Id of the assignee |
| `result.data.ai_action_items[].assignee.name` | `string` | No | — | Name of the assignee |
| `result.data.ai_action_items[].assignee.user_id` | `string \| null` | No | — | User id of the assignee |
| `result.data.ai_summary` | `object` | No | — | — |
| `result.data.ai_summary.text` | `string` | No | — | Markdown text of the ai summary |
| `result.data.calendar_event` | `object \| null` | No | — | — |
The table shows the first 50 fields. Expand the raw schema below for every field.
This output schema is too large to embed without slowing the page. Get the complete live contract with `deepline tools get grain_get_recording --json`.
## Deepline cost
* Pricing model: `fixed` (per call).
* Estimated Deepline credits: `0` per pricing unit.
* Provider-native pricing may still exist outside Deepline credit billing.
## Related documentation
* [Grain provider guide](/docs/providers/grain/guide)
* [SDK V2 quickstart](/docs/sdk-v2/quickstart)
* [SDK reference](/docs/sdk-v2/sdk-reference)
* [Run tools across a CSV](/docs/sdk-v2/batch-csv)