API · Manage · Sweeps
Create a sweep.
Create a Sweep — a typed tabular review that runs LLM extractors across a row source (documents, filings, grants, stakeholders, or entities) and persists structured cells with verbatim citations.
Returns the draft Sweep immediately with status: draft. Call POST /sweeps/{id}/run to execute. The two-call shape lets a caller inspect and adjust column definitions before any LLM tokens are spent.
Last updated
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
namestringRequiredentity_idstringOptionalportfolio_idstringOptionalrow_sourcestringRequiredOne of
"documents""filings""grants""stakeholders""entities"row_filterobjectOptionalcolumnsarray<object>RequiredidstringRequirednamestringRequiredtypestringRequiredOne of
"yes_no""date""monetary_amount""currency""percentage""number""tag""bulleted_list""free_text"instructionstringRequiredThe natural-language extractor prompt for this column.
tag_optionsarray<string>OptionalRequired when type: tag. Controlled vocabulary for the cell.
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
Request
curl -X POST "https://api.mattermode.com/v1/sweeps" \ -H "Content-Type: application/json" \ -d '{ "name": "string", "row_source": "documents", "columns": [ { "id": "col_termination", "name": "Termination notice (days)", "type": "yes_no", "instruction": "How many days\' notice is required to terminate the agreement?" } ] }'const body = JSON.stringify({ "name": "string", "row_source": "documents", "columns": [ { "id": "col_termination", "name": "Termination notice (days)", "type": "yes_no", "instruction": "How many days' notice is required to terminate the agreement?" } ]})fetch("https://api.mattermode.com/v1/sweeps", { method: "POST", headers: { "Content-Type": "application/json" }, body})package mainimport ( "fmt" "net/http" "io/ioutil" "strings")func main() { url := "https://api.mattermode.com/v1/sweeps" body := strings.NewReader(`{ "name": "string", "row_source": "documents", "columns": [ { "id": "col_termination", "name": "Termination notice (days)", "type": "yes_no", "instruction": "How many days' notice is required to terminate the agreement?" } ] }`) req, _ := http.NewRequest("POST", url, body) req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body))}import requestsheaders = { "Authorization": "Bearer sk_test_4eC39HqLyjWDarjtT1zdp7dc", "Matter-Version": "2026-06-10", "Idempotency-Key": "ee7c3a9b-3f1a-4d8e-9b2a-7c5e1f0a2d4b",}payload = { "name": "example", "row_source": "documents", "columns": [ { "id": "col_termination", "name": "Termination notice (days)", "type": "yes_no", "instruction": "How many days' notice is required to terminate the agreement?" } ]}resp = requests.post( "https://api.mattermode.com/v1/sweeps", headers=headers, json=payload,)resp.raise_for_status()print(resp.json())import java.net.URI;import java.net.http.HttpClient;import java.net.http.HttpRequest;import java.net.http.HttpResponse;import java.net.http.HttpResponse.BodyHandlers;import java.time.Duration;import java.net.http.HttpRequest.BodyPublishers;var body = BodyPublishers.ofString("""{ "name": "string", "row_source": "documents", "columns": [ { "id": "col_termination", "name": "Termination notice (days)", "type": "yes_no", "instruction": "How many days' notice is required to terminate the agreement?" } ]}""");HttpClient client = HttpClient.newBuilder() .connectTimeout(Duration.ofSeconds(10)) .build();HttpRequest.Builder requestBuilder = HttpRequest.newBuilder() .uri(URI.create("https://api.mattermode.com/v1/sweeps")) .header("Content-Type", "application/json") .POST(body) .build();try { HttpResponse<String> response = client.send(requestBuilder.build(), BodyHandlers.ofString()); System.out.println("Status code: " + response.statusCode()); System.out.println("Response body: " + response.body());} catch (Exception e) { e.printStackTrace();}using System;using System.Net.Http;using System.Text;var body = new StringContent("""{ "name": "string", "row_source": "documents", "columns": [ { "id": "col_termination", "name": "Termination notice (days)", "type": "yes_no", "instruction": "How many days' notice is required to terminate the agreement?" } ]}""", Encoding.UTF8, "application/json");var client = new HttpClient();var response = await client.PostAsync("https://api.mattermode.com/v1/sweeps", body);var responseBody = await response.Content.ReadAsStringAsync();curl --request POST 'https://api.mattermode.com/v1/sweeps' \ --header 'Authorization: Bearer sk_test_4eC39HqLyjWDarjtT1zdp7dc' \ --header 'Matter-Version: 2026-06-10' \ --header 'Idempotency-Key: ee7c3a9b-3f1a-4d8e-9b2a-7c5e1f0a2d4b' \ --header 'Content-Type: application/json' \ --data '{ "name": "example", "row_source": "documents", "columns": [ { "id": "col_termination", "name": "Termination notice (days)", "type": "yes_no", "instruction": "How many days'\'' notice is required to terminate the agreement?" } ]}'const response = await fetch("https://api.mattermode.com/v1/sweeps", { method: "POST", headers: { "Authorization": "Bearer sk_test_4eC39HqLyjWDarjtT1zdp7dc", "Matter-Version": "2026-06-10", "Idempotency-Key": "ee7c3a9b-3f1a-4d8e-9b2a-7c5e1f0a2d4b", "Content-Type": "application/json", }, body: JSON.stringify({ "name": "example", "row_source": "documents", "columns": [ { "id": "col_termination", "name": "Termination notice (days)", "type": "yes_no", "instruction": "How many days' notice is required to terminate the agreement?" } ] }),});if (!response.ok) { throw new Error(`Matter API ${response.status}: ${await response.text()}`);}const data = await response.json();console.log(data);Response
application/json{
"id": "swp_a1b2c3d4",
"object": "sweep",
"name": "Series A diligence — material contracts",
"entity_id": "string",
"portfolio_id": "string",
"row_source": "documents",
"row_filter": {},
"columns": [
{
"id": "col_termination",
"name": "Termination notice (days)",
"type": "yes_no",
"instruction": "How many days' notice is required to terminate the agreement?",
"tag_options": [
"string"
]
}
],
"cells": [
{
"row_id": "string",
"col_id": "string",
"summary": "string",
"reasoning": "string",
"citation": {
"ref": 1,
"doc_id": "doc_a1b2c3d4",
"version_id": "ver_e5f6",
"page": 5,
"quote": "A majority of the directors then in office shall constitute a quorum."
},
"status": "pending",
"error": "string"
}
],
"status": "draft",
"started_at": "2019-08-24T14:15:22Z",
"completed_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"created_by": "string"
}{
"type": "https://mattermode.com/docs/errors/invalid_request",
"title": "Invalid request",
"status": 400,
"code": "invalid_request",
"detail": "Request body could not be parsed as JSON.",
"doc_url": "https://mattermode.com/docs/guides/errors#invalid_request",
"request_id": "req_Qw9xYz8A"
}{
"type": "https://mattermode.com/docs/errors/authentication_required",
"title": "Authentication required",
"status": 401,
"code": "authentication_required",
"detail": "No bearer token was supplied. Pass `Authorization: Bearer sk_live_...` on every request.",
"doc_url": "https://mattermode.com/docs/guides/errors#authentication_required",
"request_id": "req_Qw9xYz8A"
}{
"type": "https://mattermode.com/docs/errors/rate_limit_exceeded",
"title": "Rate limit exceeded",
"status": 429,
"code": "rate_limit_exceeded",
"detail": "Request rate exceeded for this key. Retry after `retry_after` seconds or honor the `Retry-After` header.",
"doc_url": "https://mattermode.com/docs/guides/errors#rate_limit_exceeded",
"request_id": "req_Qw9xYz8A",
"retry_after": 30
}