Public API

Authentication and endpoints for the Nexalog public API.

Use the public API through Zuplo. Each request is authenticated with:

  • x-api-key (Zuplo API key)
  • x-zuplo-consumer (consumer ID injected by Zuplo)
  • x-signature (HMAC SHA-256 signature)
  • x-timestamp (UNIX seconds)

Signature string

METHOD\nPATH\nBODY_HASH\nTIMESTAMP

Required path format

All endpoints include the account and project scope:

/public/v1/accounts/{accountId}/projects/{projectId}/tags
/public/v1/accounts/{accountId}/projects/{projectId}/highlights
/public/v1/accounts/{accountId}/projects/{projectId}/fields
/public/v1/accounts/{accountId}/projects/{projectId}/videos
/public/v1/accounts/{accountId}/projects/{projectId}/videos/{videoId}/transcripts
/public/v1/accounts/{accountId}/projects/{projectId}/videos/{videoId}/fields

Example headers

x-api-key: <zuplo-api-key>
x-zuplo-consumer: <consumer-id>
x-signature: <hex-signature>
x-timestamp: <unix-seconds>