Your API Key

Contact us to get your early access API key.

Create Users

You can create one use per customer you want to serve. Data is stored separately for each user. Queries are also specific to user.

POST <https://api.contextlink.ai/api/v1/users>
Authorization: Bearer {API_KEY}
Content-Type: application/json

{
  "name": "Tony"
}

Open Customer Portal

Customer Portal allows your customers to manage their own data sources from within your app via an iframe or popup integration.

To open the portal, create a session:

POST <https://api.contextlink.ai/api/v1/sessions>
Authorization: Bearer {API_KEY}
Content-Type: application/json

{
  "userID": 1
}

Example response:

{
  "sessionToken": "session-...",
  "url": "<https://portal.contextlink.ai/>...",
  "expiresIn": 3600
}

Open the url in a separate window, popup, or embed it as an iframe in your app.

image.png

Document Tags

Use tags to organize user’s documents. The user can also update document tags from the portal. Tags can be used in search queries to narrow down results.

image.png

Perform Search:

Searches must be performed at user scope. Tags can be used to further organize the documents.

curl -H "Authorization: Bearer API_KEY" \\
"<https://api.contextlink.ai/api/v1/search?userID=1&query=refund%20policy&tags=marketing>"

Example response: