Skip to main content

Quick Start

Get up and running with the Scribe Sight API in 5 minutes.

Prerequisites​

  • A Scribe Sight account with an active subscription
  • At least one project created in the dashboard

Step 1: Create an API Key​

API keys can be created at the organization or project level:

Organization-level key (access to all projects):

  1. Go to Organizations → [Your Org] → Settings → API Keys
    • URL: scribesight.com/user/organizations/{org-slug}/settings/api-keys
  2. Click Create API Key

Project-level key (access to a single project):

  1. Go to Organizations → [Your Org] → [Project] → Settings → API Keys
    • URL: scribesight.com/user/organizations/{org-slug}/{project-slug}/settings/api-keys
  2. Click Create API Key

Give your key a descriptive name (e.g., "Production Integration") and copy it securely — it won't be shown again.

caution

Keep your secret API key secure. Never expose it in client-side code or public repositories.

Step 2: Make Your First Request​

Test your API key by fetching your organization details:

curl https://scribesight.com/api/v1/org \
  -H "Authorization: Bearer sk_live_your_api_key_here"

Response:

{
  "data": {
    "id": "org_xxxxxxxxxxxx",
    "name": "My Company",
    "slug": "my-company",
    "created_at": "2025-01-15T10:30:00Z"
  },
  "meta": {
    "request_id": "req_xxxxxxxxxxxx",
    "timestamp": "2026-01-06T15:00:00Z"
  }
}

Step 3: List Your Projects​

curl https://scribesight.com/api/v1/projects \
  -H "Authorization: Bearer sk_live_your_api_key_here"

Response:

{
  "data": [
    {
      "id": "proj_xxxxxxxxxxxx",
      "name": "Sales Calls Q1",
      "slug": "sales-calls-q1",
      "description": "Q1 2026 sales recordings",
      "content_count": 47,
      "created_at": "2025-12-01T09:00:00Z"
    }
  ],
  "pagination": {
    "has_more": false,
    "next_cursor": null
  },
  "meta": {
    "request_id": "req_xxxxxxxxxxxx",
    "timestamp": "2026-01-06T15:00:00Z"
  }
}

Step 4: Get Content with Analyses​

curl "https://scribesight.com/api/v1/projects/proj_xxxxxxxxxxxx/content?status=completed&limit=5" \
  -H "Authorization: Bearer sk_live_your_api_key_here"

Step 5: Set Up a Webhook (Optional)​

Receive real-time notifications when transcriptions or analyses complete:

curl -X POST https://scribesight.com/api/v1/webhooks \
  -H "Authorization: Bearer sk_live_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://your-server.com/webhooks/scribesight",
    "events": ["transcription.completed", "content_analysis.completed"],
    "description": "Production webhook"
  }'

Next Steps​

Code Examples​

Python​

import requests

API_KEY = "sk_live_your_api_key_here"
BASE_URL = "https://scribesight.com/api/v1"

headers = {"Authorization": f"Bearer {API_KEY}"}

# Get organization
response = requests.get(f"{BASE_URL}/org", headers=headers)
org = response.json()["data"]
print(f"Organization: {org['name']}")

# List projects
response = requests.get(f"{BASE_URL}/projects", headers=headers)
projects = response.json()["data"]
for project in projects:
    print(f"- {project['name']}: {project['content_count']} recordings")

JavaScript/Node.js​

const API_KEY = "sk_live_your_api_key_here";
const BASE_URL = "https://scribesight.com/api/v1";

async function main() {
  const headers = { Authorization: `Bearer ${API_KEY}` };

  // Get organization
  const orgRes = await fetch(`${BASE_URL}/org`, { headers });
  const { data: org } = await orgRes.json();
  console.log(`Organization: ${org.name}`);

  // List projects
  const projectsRes = await fetch(`${BASE_URL}/projects`, { headers });
  const { data: projects } = await projectsRes.json();
  projects.forEach((p) => {
    console.log(`- ${p.name}: ${p.content_count} recordings`);
  });
}

main();