API Integration Guide

Step 1. Get Familiar

Documentation Review — 15 minutes

Learn about the endpoints available on the HighContext API and what a typical request looks like. View API Reference

Step 2. Create API Key

Authenticate with the HighContext API — 10 minutes

Visit the Create New API Key page to create a new API key value. Save your new API key in a safe place. Then request the following authentication-required URL:

curl -L https://api.highcontext.ai/v1/blobs \
-H "Authorization: Basic <:Base64-encoded API Key>"

You should see a response code 200 followed by a body containing "Welcome to HighContext!".

Step 3. Upload a JSON Blob

Create a Remote JSON Blob — 15 minutes

Prepare your JSON blob. Visit the What is JSON? reference documentation for help building a valid JSON object. Then POST your new blob to HighContext:

curl -L https://api.highcontext.ai/v1/blobs \
-H "Authorization: Basic <:Base64-encoded API Key>"\
-H "Content-Type: application/json" \
-d '{ "blob_name": "helloworld",
"blob_data": {"ip_address":"", "user_agent":"CCBot/2.0 (https://commoncrawl.org/faq/)"},
"blob_permissions_policy": {"expires_at":"2123-01-01 00:00:01", "public":false } }'

You should see a response code 201 followed by a body containing the "code": "Created" and a "message" containing your new remote blob's properties.

Step 3. Complete Release Checklist

Final Checklist — 5 minutes

Have you...
- Created a new API key and saved the value in safe place?
- Uploaded a new JSON blob via the HTTP API and saved the blob id?
- Tested requesting your new remote JSON blob?

If you answered yes to all of these questions, you're ready for release!

Get Hands-on Help

Have a question about HighContext? We'd be glad to assist you.

Send us a message on our Contact page, or email us directly at [email protected].

Contact Us