API Overview

The Scribe Sight REST API provides programmatic access to your recordings, transcripts, and AI-generated insights.

Base URL

https://scribesight.com/api/v1

Request Format

• All requests must include an Authorization header with your API key
• Request bodies must be JSON with Content-Type: application/json
• All timestamps are ISO 8601 format in UTC

Response Format

Success Response

{
  "data": { ... },
  "meta": {
    "request_id": "req_xxxxxxxxxxxx",
    "timestamp": "2026-01-06T10:30:00Z"
  }
}

List Response

{
  "data": [...],
  "pagination": {
    "has_more": true,
    "next_cursor": "eyJpZCI6Inh4eCJ9"
  },
  "meta": {
    "request_id": "req_xxxxxxxxxxxx",
    "timestamp": "2026-01-06T10:30:00Z"
  }
}

Error Response

{
  "error": {
    "code": "invalid_request",
    "message": "Human-readable description",
    "details": { ... }
  },
  "meta": {
    "request_id": "req_xxxxxxxxxxxx"
  }
}

Pagination

List endpoints use cursor-based pagination for consistent results.

Query Parameters

Parameter	Type	Description
limit	integer	Max items per page (1-100, default: 20)
cursor	string	Cursor from previous response

Example

# First page
curl "https://scribesight.com/api/v1/projects?limit=10" \
  -H "Authorization: Bearer sk_live_xxx"

# Next page (using cursor from response)
curl "https://scribesight.com/api/v1/projects?limit=10&cursor=eyJpZCI6Inh4eCJ9" \
  -H "Authorization: Bearer sk_live_xxx"

ID Prefixes

All resources use prefixed IDs for clarity:

Entity	Prefix	Example
Organization	org_	org_abc123def456
Project	proj_	proj_abc123def456
Content	cont_	cont_abc123def456
Analysis	ana_	ana_abc123def456
Project Insights	ins_	ins_abc123def456
Prompt	prompt_	prompt_abc123def456
Webhook	wh_	wh_abc123def456
API Key	key_	key_abc123def456
Event	evt_	evt_abc123def456

Versioning

The API is versioned via the URL path (/v1). We commit to maintaining backward compatibility within a major version.

Breaking changes will be announced in advance and deployed to a new version.

SDKs

Official SDKs are coming soon. In the meantime, use any HTTP client:

• Python: requests, httpx
• JavaScript: fetch, axios
• Ruby: faraday, httparty

OpenAPI Specification

An OpenAPI 3.0 specification is available for code generation and API exploration:

https://scribesight.com/api/v1/openapi.json