List Executions

curl --request POST \
  --url https://api.mixpeek.com/v1/retrievers/{retriever_id}/executions/list \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Namespace: <api-key>' \
  --data '
{
  "filters": {},
  "sorts": [
    {}
  ],
  "status": "<string>"
}
'

import requests

url = "https://api.mixpeek.com/v1/retrievers/{retriever_id}/executions/list"

payload = {
    "filters": {},
    "sorts": [{}],
    "status": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "X-Namespace": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    Authorization: 'Bearer <token>',
    'X-Namespace': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({filters: {}, sorts: [{}], status: '<string>'})
};

fetch('https://api.mixpeek.com/v1/retrievers/{retriever_id}/executions/list', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.mixpeek.com/v1/retrievers/{retriever_id}/executions/list",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'filters' => [
        
    ],
    'sorts' => [
        [
                
        ]
    ],
    'status' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "X-Namespace: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.mixpeek.com/v1/retrievers/{retriever_id}/executions/list"

	payload := strings.NewReader("{\n  \"filters\": {},\n  \"sorts\": [\n    {}\n  ],\n  \"status\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("X-Namespace", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.mixpeek.com/v1/retrievers/{retriever_id}/executions/list")
  .header("Authorization", "Bearer <token>")
  .header("X-Namespace", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"filters\": {},\n  \"sorts\": [\n    {}\n  ],\n  \"status\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.mixpeek.com/v1/retrievers/{retriever_id}/executions/list")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["X-Namespace"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"filters\": {},\n  \"sorts\": [\n    {}\n  ],\n  \"status\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "pagination": {
    "total": 1,
    "limit": 1,
    "offset": 1,
    "has_next": true
  },
  "results": [
    {
      "execution_id": "<string>",
      "status": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "duration_ms": 1,
      "credits_used": 1,
      "total_processed": 1,
      "total_returned": 1,
      "completed_at": "2023-11-07T05:31:56Z",
      "cache_hit_rate": 0.5,
      "inputs_hash": "<string>",
      "query_summary": "<string>"
    }
  ]
}

{
  "status": 123,
  "error": {
    "message": "<string>",
    "type": "<string>",
    "code": "<string>",
    "details": {}
  },
  "success": false
}

{
  "status": 123,
  "error": {
    "message": "<string>",
    "type": "<string>",
    "code": "<string>",
    "details": {}
  },
  "success": false
}

{
  "status": 123,
  "error": {
    "message": "<string>",
    "type": "<string>",
    "code": "<string>",
    "details": {}
  },
  "success": false
}

{
  "status": 123,
  "error": {
    "message": "<string>",
    "type": "<string>",
    "code": "<string>",
    "details": {}
  },
  "success": false
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

{
  "status": 123,
  "error": {
    "message": "<string>",
    "type": "<string>",
    "code": "<string>",
    "details": {}
  },
  "success": false
}

POST

retrievers

{retriever_id}

executions

list

List Executions

curl --request POST \
  --url https://api.mixpeek.com/v1/retrievers/{retriever_id}/executions/list \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Namespace: <api-key>' \
  --data '
{
  "filters": {},
  "sorts": [
    {}
  ],
  "status": "<string>"
}
'

import requests

url = "https://api.mixpeek.com/v1/retrievers/{retriever_id}/executions/list"

payload = {
    "filters": {},
    "sorts": [{}],
    "status": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "X-Namespace": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    Authorization: 'Bearer <token>',
    'X-Namespace': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({filters: {}, sorts: [{}], status: '<string>'})
};

fetch('https://api.mixpeek.com/v1/retrievers/{retriever_id}/executions/list', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.mixpeek.com/v1/retrievers/{retriever_id}/executions/list",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'filters' => [
        
    ],
    'sorts' => [
        [
                
        ]
    ],
    'status' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "X-Namespace: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.mixpeek.com/v1/retrievers/{retriever_id}/executions/list"

	payload := strings.NewReader("{\n  \"filters\": {},\n  \"sorts\": [\n    {}\n  ],\n  \"status\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("X-Namespace", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.mixpeek.com/v1/retrievers/{retriever_id}/executions/list")
  .header("Authorization", "Bearer <token>")
  .header("X-Namespace", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"filters\": {},\n  \"sorts\": [\n    {}\n  ],\n  \"status\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.mixpeek.com/v1/retrievers/{retriever_id}/executions/list")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["X-Namespace"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"filters\": {},\n  \"sorts\": [\n    {}\n  ],\n  \"status\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "pagination": {
    "total": 1,
    "limit": 1,
    "offset": 1,
    "has_next": true
  },
  "results": [
    {
      "execution_id": "<string>",
      "status": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "duration_ms": 1,
      "credits_used": 1,
      "total_processed": 1,
      "total_returned": 1,
      "completed_at": "2023-11-07T05:31:56Z",
      "cache_hit_rate": 0.5,
      "inputs_hash": "<string>",
      "query_summary": "<string>"
    }
  ]
}

{
  "status": 123,
  "error": {
    "message": "<string>",
    "type": "<string>",
    "code": "<string>",
    "details": {}
  },
  "success": false
}

{
  "status": 123,
  "error": {
    "message": "<string>",
    "type": "<string>",
    "code": "<string>",
    "details": {}
  },
  "success": false
}

{
  "status": 123,
  "error": {
    "message": "<string>",
    "type": "<string>",
    "code": "<string>",
    "details": {}
  },
  "success": false
}

{
  "status": 123,
  "error": {
    "message": "<string>",
    "type": "<string>",
    "code": "<string>",
    "details": {}
  },
  "success": false
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

{
  "status": 123,
  "error": {
    "message": "<string>",
    "type": "<string>",
    "code": "<string>",
    "details": {}
  },
  "success": false
}

Authorizations

Authorization

string

header

required

Mixpeek API key, sent as Authorization: Bearer mxp_sk_.... Create one in Studio under Settings → API Keys, or with an admin key via POST /v1/organizations/users/{user_email}/api-keys. A missing header returns 403; an invalid or revoked key returns 401.

X-Namespace

string

header

required

Namespace id (ns_...), not the namespace name. This scopes the request rather than authenticating it, and it is required on every operation marked x-mixpeek-namespace-scoped.

Path Parameters

retriever_id

string

required

Retriever ID or name.

Query Parameters

limit

integer | null

Required range: 1 <= x <= 1000

page_size

integer | null

Required range: 1 <= x <= 1000

offset

integer | null

Required range: 0 <= x <= 10000

page

integer | null

Required range: x >= 1

cursor

string | null

next_cursor

string | null

after

string | null

include_total

boolean

default:false

Body

application/json

Request to list retriever executions.

filters

Filters · object | null

sorts

Sorts · object[] | null

status

string | null

Optional status filter (completed, failed, running).

Response

Successful Response

Re-export shared execution listing response for OpenAPI docs.

pagination

PaginationMetadata · object

required

Pagination metadata

Show child attributes

results

RetrieverExecutionSummary · object[]

Execution summaries

Show child attributes

Organization

Namespaces

Buckets

Feature Extractors

Batch Queue

Collections

Documents

Retrievers

Taxonomies

Clusters

Triggers

Alerts

Webhooks

Apps

Agent Sessions

Annotations

Templates

Manifest

Discovery

Analytics

Notifications

Tasks

Inference

Resource Search

Pricing

Events

Onboarding

List Executions

Authorizations

Path Parameters

Query Parameters

Body

Response