Skip to main content
GET
/
v1
/
retrievers
/
{retriever_id}
/
executions
/
{execution_id}
Get Execution
curl --request GET \
  --url https://api.mixpeek.com/v1/retrievers/{retriever_id}/executions/{execution_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Namespace: <x-namespace>'
{
  "execution_id": "<string>",
  "status": "<string>",
  "documents": [
    {}
  ],
  "pagination": {},
  "stage_statistics": {
    "stages": {},
    "total_time_ms": 0,
    "credits_used": 0
  },
  "budget": {},
  "error": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z",
  "current_stage": "<string>",
  "stages_completed": 0,
  "total_stages": 0
}

Authorizations

​
Authorization
string
header
required

Bearer token authentication using your API key. Format: 'Bearer your_api_key'. To get an API key, create an account at mixpeek.com/start and generate a key in your account settings.

Headers

​
Authorization
string
required

REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings.

Examples:

"Bearer sk_live_abc123def456"

"Bearer sk_test_xyz789"

​
X-Namespace
string
required

REQUIRED: Namespace identifier for scoping this request. All resources (collections, buckets, taxonomies, etc.) are scoped to a namespace. You can provide either the namespace name or namespace ID. Format: ns_xxxxxxxxxxxxx (ID) or a custom name like 'my-namespace'

Examples:

"ns_abc123def456"

"production"

"my-namespace"

Path Parameters

​
retriever_id
string
required

Retriever ID or name.

​
execution_id
string
required

Execution identifier.

Response

Successful Response

Alias wrapper for execution detail documentation.

​
execution_id
string
required

Identifier of this execution run (REQUIRED).

​
status
string
required

Execution status (e.g., 'completed', 'failed') (REQUIRED).

​
documents
Documents · object[]

Final document results after pipeline completion (REQUIRED).

​
pagination
object

Pagination metadata (varies by pagination method) (REQUIRED).

​
stage_statistics
object

Per-stage execution statistics (REQUIRED).

​
budget
object

Snapshot of budget usage for this execution (REQUIRED).

​
error
string | null

Pipeline-level error if execution failed (OPTIONAL).

​
created_at
string<date-time>

Timestamp when execution began

​
completed_at
string<date-time> | null

Timestamp when execution finished

​
current_stage
string | null

Stage currently running when execution in-flight

​
stages_completed
integer
default:0

Number of stages finished so far

Required range: x >= 0
​
total_stages
integer
default:0

Total stages configured

Required range: x >= 0