Create call recording

v1.0.0

Create a call recording for a meeting. This endpoint is rate limited to 1 request per second.

A transcript should always be provided — it is technically optional for backwards compatibility, but a call recording created without one will be missing summaries and other transcript-derived features. video_url is optional, and a transcript-only call recording (with no video) is fully supported.

This endpoint is in beta. We will aim to avoid breaking changes, but small updates may be made as we roll out to more users.

Required scopes: meeting:read, call_recording:read-write.

Input

{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "transcript": {
          "type": "array",
          "description": "The call recording's transcript.\n\nThis field is technically optional for backwards compatibility, but you should always provide it — a call recording created without a transcript will be missing summaries and other transcript-derived features. This field will become required in a future version of this endpoint.",
          "items": {
            "type": "object",
            "required": [
              "speech",
              "start_time",
              "end_time",
              "speaker"
            ],
            "properties": {
              "end_time": {
                "type": "number",
                "description": "The end time of this speech segment in seconds."
              },
              "speaker": {
                "type": "object",
                "required": [
                  "name"
                ],
                "properties": {
                  "email_address": {
                    "type": "string",
                    "format": "email",
                    "description": "The email address of the speaker."
                  },
                  "name": {
                    "type": "string",
                    "description": "The name of the speaker."
                  }
                }
              },
              "speech": {
                "type": "string",
                "description": "The spoken text for this segment of the transcript."
              },
              "start_time": {
                "type": "number",
                "description": "The start time of this speech segment in seconds."
              }
            }
          }
        },
        "video_url": {
          "type": "string",
          "format": "uri",
          "description": "A publicly accessible URL to a video file of the call recording. Attio will download the video from this URL asynchronously.\n\nThis field is optional — a call recording can be created with only a `transcript` and no video.\n\n**Requirements:**\n- **Protocol:** The URL must use the `https` protocol.\n- **File type:** The file must be a `.mp4` file.\n- **File size:** The file must not exceed 1GB in size.\n- **Accessibility:** For the request to be accepted, the URL must be publicly accessible. Attio will make a `HEAD` request to the URL to verify its accessibility and retrieve file metadata. The response to this request must include a `Content-Length` header."
        }
      }
    },
    "meeting_id": {
      "type": "string",
      "format": "uuid",
      "description": "The ID of the meeting this recording belongs to."
    }
  },
  "required": [
    "data",
    "meeting_id"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "description": "Success",
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "type": "object",
      "required": [
        "created_at",
        "created_by_actor",
        "id",
        "status",
        "web_url"
      ],
      "properties": {
        "created_at": {
          "type": "string",
          "description": "The timestamp of when the call recording was created."
        },
        "created_by_actor": {
          "type": "object",
          "description": "The actor that created this call recording.",
          "properties": {
            "id": {
              "type": "string",
              "description": "An ID to identify the actor."
            },
            "type": {
              "type": "string",
              "description": "The type of actor. [Read more information on actor types here](/docs/actors).",
              "enum": [
                "api-token",
                "workspace-member",
                "system",
                "app"
              ]
            }
          }
        },
        "id": {
          "type": "object",
          "required": [
            "call_recording_id",
            "meeting_id",
            "workspace_id"
          ],
          "properties": {
            "call_recording_id": {
              "type": "string",
              "format": "uuid",
              "description": "The call recording ID of the call recording."
            },
            "meeting_id": {
              "type": "string",
              "format": "uuid",
              "description": "The ID of the meeting associated with this call recording."
            },
            "workspace_id": {
              "type": "string",
              "format": "uuid",
              "description": "The ID of the workspace this call recording belongs to."
            }
          }
        },
        "status": {
          "type": "string",
          "description": "The status of the call recording. When a call recording is first created, it will have a status of `PROCESSING`. Once the recording is ready, it will transition to `COMPLETED`. If the recording fails for any reason, the status will be `FAILED`.",
          "enum": [
            "processing",
            "completed",
            "failed"
          ]
        },
        "web_url": {
          "type": "string",
          "format": "uri",
          "description": "A URL that links directly to the call recording in the Attio web application."
        }
      }
    }
  }
}