const response = await fetch(
`https://api.joinoverlap.com/clip?companyId=${process.env.OVERLAP_COMPANY_ID}&clipId=clip-id-from-results`,
{
headers: {
"Authorization": `Bearer ${process.env.OVERLAP_API_KEY}`
}
}
);
const data = await response.json();
curl "https://api.joinoverlap.com/clip?companyId=$OVERLAP_COMPANY_ID&clipId=clip-id-from-results" \
-H "Authorization: Bearer $OVERLAP_API_KEY"
Get Clip
Retrieve a saved clip document by company and clip id
GET
/
clip
const response = await fetch(
`https://api.joinoverlap.com/clip?companyId=${process.env.OVERLAP_COMPANY_ID}&clipId=clip-id-from-results`,
{
headers: {
"Authorization": `Bearer ${process.env.OVERLAP_API_KEY}`
}
}
);
const data = await response.json();
curl "https://api.joinoverlap.com/clip?companyId=$OVERLAP_COMPANY_ID&clipId=clip-id-from-results" \
-H "Authorization: Bearer $OVERLAP_API_KEY"
Endpoint
GET https://api.joinoverlap.com/clip?companyId={companyId}&clipId={clipId}
clipId and need the latest saved clip document, including fields updated by POST /update-clip.
Authentication
Authorization: Bearer YOUR_API_KEY
Query Parameters
| Parameter | Required | Description |
|---|---|---|
companyId | Yes | Your Overlap company or organization identifier. |
clipId | Yes | The clip id returned by GET /workflow-results/{triggerId}. |
The same lookup is also available at
GET /companies/{companyId}/clips/{clipId}.Response
Returns aClip object. Clip fields are included when available, so a response may omit values that have not been generated or rendered yet. For example, renderedUrl may be absent.
{
"clip": {
"id": "clip-id-from-results",
"title": "Product Launch Highlights",
"bio": "Key moments from the product launch webinar.",
"duration": 45.2,
"subtitleConfig": {}
}
}
clip object is the saved clip document with id set to the Firestore document id.
Clip Model
Review the fields that may appear on a clip response
const response = await fetch(
`https://api.joinoverlap.com/clip?companyId=${process.env.OVERLAP_COMPANY_ID}&clipId=clip-id-from-results`,
{
headers: {
"Authorization": `Bearer ${process.env.OVERLAP_API_KEY}`
}
}
);
const data = await response.json();
curl "https://api.joinoverlap.com/clip?companyId=$OVERLAP_COMPANY_ID&clipId=clip-id-from-results" \
-H "Authorization: Bearer $OVERLAP_API_KEY"
Was this page helpful?