Skip to main content

​
Base URL

https://api.hypermodel.ai/api/v1

​
Authentication

All endpoints (except PDF extraction) require authentication via the X-API-Key header: 
X-API-Key: your-api-key
Contact us to get your API key for authentication

​
Available Endpoints

Create Query

Submit a new query for processing with sync or async modes

Get Query Status

Retrieve the status and results of a specific query

List Queries

List all queries with their current status

PDF Extraction

Extract structured data from PDF documents using AI

Destinations

Configure URL, Snowflake, Sheets, or Clay destinations

JSON Schemas

Examples of JSON schemas for different use cases

​
Request Flow

1

Authenticate

Include your API key in the X-API-Key header
2

Choose Mode

Select synchronous (immediate results) or asynchronous (background processing)
3

Submit Query

Send your natural language query with a JSON schema
4

Receive Results

Get results directly (sync) or via your chosen destination (async)

​
Error Handling

All errors follow a consistent format: 
{
  "error": "Error type",
  "message": "Human-readable error message",
  "details": [/* Optional array of detailed error information */]
}

​
Common HTTP Status Codes

CodeDescription
200Synchronous query completed successfully
202Async query accepted for processing
400Invalid request parameters
401Missing API key
403Invalid API key
404Query ID not found
500Server-side error during processing

​
Rate Limits

Rate limits vary by plan. Contact us for information about rate limits on your account.

​
Support

Need help? Reach out to us for support.
⌘I