curl -X GET https://api.hypermodel.ai/api/v1/query/query_1234567890_abc123 \
-H "X-API-Key: your-api-key"
const response = await fetch(
'https://api.hypermodel.ai/api/v1/query/query_1234567890_abc123',
{
method: 'GET',
headers: {
'X-API-Key': 'your-api-key',
},
}
);
const data = await response.json();
import requests
response = requests.get(
'https://api.hypermodel.ai/api/v1/query/query_1234567890_abc123',
headers={
'X-API-Key': 'your-api-key',
},
)
data = response.json()
{
"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"
}
{
"id": "query_1234567890_abc123",
"status": "processing",
"destination": {
"type": "URL"
},
"error": null,
"createdAt": "2025-01-01T00:00:00Z",
"updatedAt": "2025-01-01T00:00:30Z"
}
{
"id": "query_1234567890_abc123",
"status": "failed",
"destination": {
"type": "URL"
},
"error": "Failed to process query: Invalid schema",
"createdAt": "2025-01-01T00:00:00Z",
"updatedAt": "2025-01-01T00:00:45Z"
}
{
"error": "Query not found"
}
API Reference
Get Query Status
Retrieve the status and results of a specific query (for async queries)
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"
const response = await fetch(
'https://api.hypermodel.ai/api/v1/query/query_1234567890_abc123',
{
method: 'GET',
headers: {
'X-API-Key': 'your-api-key',
},
}
);
const data = await response.json();
import requests
response = requests.get(
'https://api.hypermodel.ai/api/v1/query/query_1234567890_abc123',
headers={
'X-API-Key': 'your-api-key',
},
)
data = response.json()
{
"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"
}
{
"id": "query_1234567890_abc123",
"status": "processing",
"destination": {
"type": "URL"
},
"error": null,
"createdAt": "2025-01-01T00:00:00Z",
"updatedAt": "2025-01-01T00:00:30Z"
}
{
"id": "query_1234567890_abc123",
"status": "failed",
"destination": {
"type": "URL"
},
"error": "Failed to process query: Invalid schema",
"createdAt": "2025-01-01T00:00:00Z",
"updatedAt": "2025-01-01T00:00:45Z"
}
{
"error": "Query not found"
}
Authentication
string
required
Your API key for authentication
Path Parameters
string
required
The query ID returned from the create query endpoint
Response Fields
string
The unique query identifier
string
Current status:
pending, processing, completed, or failedobject
string | null
Error message if status is
failed, otherwise nullstring
ISO 8601 timestamp when query was created
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"
const response = await fetch(
'https://api.hypermodel.ai/api/v1/query/query_1234567890_abc123',
{
method: 'GET',
headers: {
'X-API-Key': 'your-api-key',
},
}
);
const data = await response.json();
import requests
response = requests.get(
'https://api.hypermodel.ai/api/v1/query/query_1234567890_abc123',
headers={
'X-API-Key': 'your-api-key',
},
)
data = response.json()
{
"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"
}
{
"id": "query_1234567890_abc123",
"status": "processing",
"destination": {
"type": "URL"
},
"error": null,
"createdAt": "2025-01-01T00:00:00Z",
"updatedAt": "2025-01-01T00:00:30Z"
}
{
"id": "query_1234567890_abc123",
"status": "failed",
"destination": {
"type": "URL"
},
"error": "Failed to process query: Invalid schema",
"createdAt": "2025-01-01T00:00:00Z",
"updatedAt": "2025-01-01T00:00:45Z"
}
{
"error": "Query not found"
}
Status Values
Pending
Query is queued for processing
Processing
Query is currently being processed
Completed
Query completed successfully
Failed
Query failed with an error
