Skip to main content
GET
/
api
/
v1
/
query
/
{id}
curl -X GET https://api.hypermodel.ai/api/v1/query/query_1234567890_abc123 \
  -H "X-API-Key: your-api-key"
{
  "id": "query_1234567890_abc123",
  "status": "completed",
  "destination": {
    "type": "URL",
    "url": "https://webhook.site/your-unique-id"
  },
  "error": null,
  "createdAt": "2025-01-01T00:00:00Z",
  "updatedAt": "2025-01-01T00:01:00Z"
}

Authentication

X-API-Key
string
required
Your API key for authentication

Path Parameters

id
string
required
The query ID returned from the create query endpoint

Response Fields

id
string
The unique query identifier
status
string
Current status: pending, processing, completed, or failed
destination
object
Destination configuration for the query
error
string | null
Error message if status is failed, otherwise null
createdAt
string
ISO 8601 timestamp when query was created
updatedAt
string
ISO 8601 timestamp when query was last updated
curl -X GET https://api.hypermodel.ai/api/v1/query/query_1234567890_abc123 \
  -H "X-API-Key: your-api-key"
{
  "id": "query_1234567890_abc123",
  "status": "completed",
  "destination": {
    "type": "URL",
    "url": "https://webhook.site/your-unique-id"
  },
  "error": null,
  "createdAt": "2025-01-01T00:00:00Z",
  "updatedAt": "2025-01-01T00:01:00Z"
}

Status Values

Pending

Query is queued for processing

Processing

Query is currently being processed

Completed

Query completed successfully

Failed

Query failed with an error
I