iQ Suite - Docs

Quickstart

Welcome to the iQ Suite Platform Quickstart guide. This guide will help you set up and make your first API call to iQ Suite.

Prerequisites

Before you begin, ensure you have:

  • An iQ Suite Platform account
  • Your API key.

Get Your API Key

  1. Visit iQ Suite Platform.
  2. Sign up with your email or GitHub account.
  3. Navigate to "API Keys" in the sidebar
  4. Create a new API key
  5. Save your API key securely - it won't be shown again.

Install the SDK

Choose your preferred language and install the SDK:

pip install iqsuite

Initialize the Client

Set up the client with your API key:

import os
from iqsuite import IQSuiteClient
 
client = IQSuiteClient(os.environ["IQSUITE_API_KEY"])
 
# Verify authentication
try:
    user = client.get_user()
    print(f"Successfully authenticated as: {user.email}")
except AuthenticationError:
    print("Invalid API key")

Create Your First Index

Create a searchable index from your documents:

# Open the document you want to index in binary read mode
with open('document.pdf', 'rb') as file:
  # Send a request to create an index with the provided document
  response = client.create_index(document=file, filename='document.pdf')
  # Print the received Task ID to monitor progress
  print(f"Task ID: {response.data.task_id}")

Query Your Index

Once your index is created, you can start querying it:

try:
    response = client.retrieve(
        index_id='your-index-id',
        query='What are the main points discussed?'
        document_id='your_document_id' # Optional field to filter and retrieve from specific document
    )
    print(f"Response: {response}")
except APIError as e:
    print(f"Error: {e}")

Supported file types

Supported File Types

  • PDF, PPTX, PPT, DOC, DOCX.

Next Steps

Now that you've set up your first index and made a query, you can:

Need Help?

Next

Use Cases

On this page