ReferenceAPI Reference
Query
Argo DSL query engine
Execute Argo query
Authorization
bearerAuth AuthorizationBearer <token>
Supabase JWT token
In: header
Request Body
application/json
path*string
Argo query string
Length
1 <= lengthk?integer
Maximum number of results to return
Default
25Range
1 <= value <= 100k_explore?integer
Beam width for exploration (default: k * 3)
Range
1 <= value <= 300collection?string
Scope query to collection PI
expand?string
Control entity expansion in results and path steps.
- omitted/preview (default): Attach lightweight preview data (label, timestamps, truncated description/text)
- full: Attach complete entity manifest (all properties, relationships, version info)
- none: No expansion - return only Pinecone metadata (fastest, smallest payload)
Value in
"none" | "preview" | "full"Response Body
application/json
application/json
curl -X POST "https://arke-v1.arke.institute/query" \ -H "Content-Type: application/json" \ -d '{ "path": "\"medical college\" -[*]{,4}-> type:file" }'{
"results": [
{
"entity": {
"pi": "01KE4ZY69F9R40E88PK9S0TQRQ",
"type": "file",
"label": "Theory of Relativity.pdf",
"collection_pi": "01JCOLL_RESEARCH",
"preview_data": {
"id": "01KE4ZY69F9R40E88PK9S0TQRQ",
"type": "file",
"label": "Theory of Relativity.pdf",
"collection_pi": "01JCOLL_RESEARCH",
"description_preview": "Seminal paper on special and general relativity...",
"created_at": "2025-01-10T08:00:00.000Z",
"updated_at": "2025-01-10T08:00:00.000Z"
}
},
"path": [
{
"entity": "01KPERSON_EINSTEIN",
"label": "Albert Einstein",
"type": "person",
"preview_data": {
"id": "01KPERSON_EINSTEIN",
"type": "person",
"label": "Albert Einstein",
"created_at": "2025-01-01T00:00:00.000Z",
"updated_at": "2025-01-15T12:00:00.000Z"
}
},
{
"edge": "authored",
"direction": "outgoing"
}
],
"score": 0.89
}
],
"metadata": {
"query": "string",
"hops": 0,
"k": 0,
"k_explore": 0,
"total_candidates_explored": 0,
"execution_time_ms": 0,
"collection": "string",
"error": "string",
"reason": "string",
"partial_path": [
{
"entity": "01KPERSON_EINSTEIN",
"label": "Albert Einstein",
"type": "person",
"score": 0.92,
"preview_data": {
"id": "01KPERSON_EINSTEIN",
"type": "person",
"label": "Albert Einstein",
"description_preview": "German-born theoretical physicist...",
"created_at": "2025-01-01T00:00:00.000Z",
"updated_at": "2025-01-15T12:00:00.000Z"
}
}
],
"stopped_at_hop": 0
}
}{
"error": "Validation failed",
"details": {
"issues": [
{
"path": [
"properties",
"label"
],
"message": "Required"
}
]
}
}