Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.hoplynk.com/llms.txt

Use this file to discover all available pages before exploring further.

​
API Keys

API keys are prefixed with hlk_ and are issued from the Hoplynk dashboard. Pass your key in the X-API-Key header on every request. 
curl https://argus.hoplynk.com/api/kits \
  -H "X-API-Key: hlk_..."
API keys are shown only once at creation. Store them securely — treat them like passwords.

​
Getting a Key

Contact your Hoplynk account manager or email support@hoplynk.com to get an API key issued for your account.

​
Key Scopes

All partner API keys have the following scopes by default:
ScopeAccess
telemetry:readRead kit location, links, and telemetry
assets:readRead assets and their feeds

​
Environment Variables

We recommend storing your API key and kit ID as environment variables: 
export HOPLYNK_API_KEY=hlk_...
export HOPLYNK_KIT_ID=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx