Skip to content
Docs
API console (try a request with your own key)Get early access

API reference

SpecCapture API v1

Section titled “SpecCapture API v1”

Structured data from 2D engineering drawings: submit a drawing, follow its job, read each sheet’s values with confidence, review state and the box each value was read from. Errors are RFC 9457 problem details with a stable ‘code’. Guides, code samples and every error code: https://speccapture.com/docs/

Every request goes to https://api.speccapture.com with an API key: Authorization: Bearer sc_live_.... New here? Start with the Quickstart. To try a request with your own key in the browser, open the API console.

Information

  • OpenAPI version: 3.1.1

Operations

Section titled “Operations”
GET
/v1/account
GET
/v1/api-keys
GET
/v1/api-keys/{keyId}
GET
/v1/credits/history
GET
/v1/extractions
POST
/v1/extractions
GET
/v1/extractions/{jobId}
DELETE
/v1/extractions/{jobId}
GET
/v1/extractions/{jobId}/sheets/{sheetNumber}
GET
/v1/extractions/{jobId}/export
GET
/v1/templates
GET
/v1/templates/{templateId}
POST
/v1/extractions/{jobId}/sheets/{sheetNumber}/view-links
GET
/v1/view-links
GET
/v1/view-links/{viewLinkId}
DELETE
/v1/view-links/{viewLinkId}
GET
/v1/webhooks
POST
/v1/webhooks
GET
/v1/webhooks/{webhookId}
DELETE
/v1/webhooks/{webhookId}
POST
/v1/webhooks/{webhookId}/resume
GET
/v1/webhooks/{webhookId}/deliveries
GET
/v1/workspace
GET
/v1/workspace/members
GET
/v1/workspace/invitations
GET
/v1/workspace/invitations/{invitationId}

Authentication

Section titled “Authentication”

ApiKey

Section titled “ApiKey”

An API key from the dashboard, sent as ‘Authorization: Bearer sc_live_…’. sc_test_ keys never spend credits.

Security scheme type: http

Bearer format: sc_live_... or sc_test_...