Resume a paused job

curl --request POST \
  --url https://api.brussle.com/v1/jobs/{id}/resume \
  --header 'Authorization: Bearer <token>'

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.brussle.com/v1/jobs/{id}/resume', 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.brussle.com/v1/jobs/{id}/resume",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.brussle.com/v1/jobs/{id}/resume"

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.brussle.com/v1/jobs/{id}/resume")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "id": "<string>",
  "type": "backfill",
  "status": "estimating",
  "namespace": "<string>",
  "spend_usd": 1,
  "progress": {
    "documents_done": 1
  },
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "judgment": "<string>",
  "estimate": {
    "documents": 1,
    "tokens": 1,
    "judgment_units": 1,
    "cost_usd": 1,
    "duration_s": 1,
    "downstream": [
      {
        "judgment": "<string>",
        "judgments_per_month": 1,
        "cost_usd": 1
      }
    ]
  },
  "estimated_completion_at": "2023-11-07T05:31:56Z",
  "error": "<string>",
  "attribute": "<string>",
  "resync": {
    "thresholds_before": {},
    "thresholds_after": {},
    "readers": [
      "<string>"
    ]
  },
  "group": "<string>",
  "proposal": {
    "options": [
      {
        "value": "<string>",
        "description": "<string>"
      }
    ],
    "proposed": [
      {
        "value": "<string>",
        "description": "<string>",
        "absorbs": 1,
        "sample_ids": [
          "<string>"
        ]
      }
    ],
    "sampled": 100,
    "escape_documents": 1,
    "unlabelled": 1
  },
  "simulation": {
    "population": 1,
    "sampled": 1,
    "thresholds": {},
    "examples": [
      "<string>"
    ],
    "excluded": {
      "failed": 1,
      "out_of_scope": 1
    },
    "fanout": {
      "documents": 1,
      "tokens": 1,
      "judgment_units": 1,
      "cost_usd": 1,
      "duration_s": 1,
      "downstream": [
        {
          "judgment": "<string>",
          "judgments_per_month": 1,
          "cost_usd": 1
        }
      ]
    },
    "larger_sample": 123
  },
  "version": 2,
  "report": {
    "documents": 1,
    "current": {
      "type": "bool",
      "mean": 123,
      "histogram": [
        {
          "lower": 123,
          "upper": 123,
          "count": 1
        }
      ]
    },
    "candidate": {
      "type": "bool",
      "mean": 123,
      "histogram": [
        {
          "lower": 123,
          "upper": 123,
          "count": 1
        }
      ]
    },
    "threshold_flips": {},
    "recompute": {
      "documents": 1,
      "tokens": 1,
      "judgment_units": 1,
      "cost_usd": 1,
      "duration_s": 1,
      "downstream": [
        {
          "judgment": "<string>",
          "judgments_per_month": 1,
          "cost_usd": 1
        }
      ]
    },
    "downstream": [
      {
        "judgment": "<string>",
        "judgments_per_month": 1,
        "cost_usd": 1
      }
    ]
  },
  "export": {
    "since": "2023-11-07T05:31:56Z",
    "until": "2023-11-07T05:31:56Z",
    "judgments": [
      "<string>"
    ],
    "evaluations": 1,
    "files": [
      {
        "url": "<string>",
        "url_expires_at": "2023-11-07T05:31:56Z",
        "evaluations": 2,
        "bytes": 2
      }
    ],
    "expires_at": "2023-11-07T05:31:56Z",
    "links_unavailable": "<string>"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "details": {
      "reason": "<string>",
      "suggested_context": {
        "recipe": {
          "fields": [
            "<string>"
          ],
          "last_n": {},
          "window": {},
          "max_tokens": 2,
          "related": {},
          "previous": {
            "fields": [
              "<string>"
            ],
            "anchor": "<string>"
          }
        },
        "cost_per_answer": 1,
        "whole_state_cost_per_answer": 1,
        "sampled_documents": 2,
        "excluded": [
          {
            "path": "<string>",
            "reason": "id"
          }
        ]
      }
    }
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "details": {
      "reason": "<string>",
      "suggested_context": {
        "recipe": {
          "fields": [
            "<string>"
          ],
          "last_n": {},
          "window": {},
          "max_tokens": 2,
          "related": {},
          "previous": {
            "fields": [
              "<string>"
            ],
            "anchor": "<string>"
          }
        },
        "cost_per_answer": 1,
        "whole_state_cost_per_answer": 1,
        "sampled_documents": 2,
        "excluded": [
          {
            "path": "<string>",
            "reason": "id"
          }
        ]
      }
    }
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "details": {
      "reason": "<string>",
      "suggested_context": {
        "recipe": {
          "fields": [
            "<string>"
          ],
          "last_n": {},
          "window": {},
          "max_tokens": 2,
          "related": {},
          "previous": {
            "fields": [
              "<string>"
            ],
            "anchor": "<string>"
          }
        },
        "cost_per_answer": 1,
        "whole_state_cost_per_answer": 1,
        "sampled_documents": 2,
        "excluded": [
          {
            "path": "<string>",
            "reason": "id"
          }
        ]
      }
    }
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "details": {
      "reason": "<string>",
      "suggested_context": {
        "recipe": {
          "fields": [
            "<string>"
          ],
          "last_n": {},
          "window": {},
          "max_tokens": 2,
          "related": {},
          "previous": {
            "fields": [
              "<string>"
            ],
            "anchor": "<string>"
          }
        },
        "cost_per_answer": 1,
        "whole_state_cost_per_answer": 1,
        "sampled_documents": 2,
        "excluded": [
          {
            "path": "<string>",
            "reason": "id"
          }
        ]
      }
    }
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "details": {
      "reason": "<string>",
      "suggested_context": {
        "recipe": {
          "fields": [
            "<string>"
          ],
          "last_n": {},
          "window": {},
          "max_tokens": 2,
          "related": {},
          "previous": {
            "fields": [
              "<string>"
            ],
            "anchor": "<string>"
          }
        },
        "cost_per_answer": 1,
        "whole_state_cost_per_answer": 1,
        "sampled_documents": 2,
        "excluded": [
          {
            "path": "<string>",
            "reason": "id"
          }
        ]
      }
    }
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "details": {
      "reason": "<string>",
      "suggested_context": {
        "recipe": {
          "fields": [
            "<string>"
          ],
          "last_n": {},
          "window": {},
          "max_tokens": 2,
          "related": {},
          "previous": {
            "fields": [
              "<string>"
            ],
            "anchor": "<string>"
          }
        },
        "cost_per_answer": 1,
        "whole_state_cost_per_answer": 1,
        "sampled_documents": 2,
        "excluded": [
          {
            "path": "<string>",
            "reason": "id"
          }
        ]
      }
    }
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "details": {
      "reason": "<string>",
      "suggested_context": {
        "recipe": {
          "fields": [
            "<string>"
          ],
          "last_n": {},
          "window": {},
          "max_tokens": 2,
          "related": {},
          "previous": {
            "fields": [
              "<string>"
            ],
            "anchor": "<string>"
          }
        },
        "cost_per_answer": 1,
        "whole_state_cost_per_answer": 1,
        "sampled_documents": 2,
        "excluded": [
          {
            "path": "<string>",
            "reason": "id"
          }
        ]
      }
    }
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "details": {
      "reason": "<string>",
      "suggested_context": {
        "recipe": {
          "fields": [
            "<string>"
          ],
          "last_n": {},
          "window": {},
          "max_tokens": 2,
          "related": {},
          "previous": {
            "fields": [
              "<string>"
            ],
            "anchor": "<string>"
          }
        },
        "cost_per_answer": 1,
        "whole_state_cost_per_answer": 1,
        "sampled_documents": 2,
        "excluded": [
          {
            "path": "<string>",
            "reason": "id"
          }
        ]
      }
    }
  }
}

POST

jobs

{id}

resume

Resume a paused job

curl --request POST \
  --url https://api.brussle.com/v1/jobs/{id}/resume \
  --header 'Authorization: Bearer <token>'

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.brussle.com/v1/jobs/{id}/resume', 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.brussle.com/v1/jobs/{id}/resume",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.brussle.com/v1/jobs/{id}/resume"

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.brussle.com/v1/jobs/{id}/resume")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "id": "<string>",
  "type": "backfill",
  "status": "estimating",
  "namespace": "<string>",
  "spend_usd": 1,
  "progress": {
    "documents_done": 1
  },
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "judgment": "<string>",
  "estimate": {
    "documents": 1,
    "tokens": 1,
    "judgment_units": 1,
    "cost_usd": 1,
    "duration_s": 1,
    "downstream": [
      {
        "judgment": "<string>",
        "judgments_per_month": 1,
        "cost_usd": 1
      }
    ]
  },
  "estimated_completion_at": "2023-11-07T05:31:56Z",
  "error": "<string>",
  "attribute": "<string>",
  "resync": {
    "thresholds_before": {},
    "thresholds_after": {},
    "readers": [
      "<string>"
    ]
  },
  "group": "<string>",
  "proposal": {
    "options": [
      {
        "value": "<string>",
        "description": "<string>"
      }
    ],
    "proposed": [
      {
        "value": "<string>",
        "description": "<string>",
        "absorbs": 1,
        "sample_ids": [
          "<string>"
        ]
      }
    ],
    "sampled": 100,
    "escape_documents": 1,
    "unlabelled": 1
  },
  "simulation": {
    "population": 1,
    "sampled": 1,
    "thresholds": {},
    "examples": [
      "<string>"
    ],
    "excluded": {
      "failed": 1,
      "out_of_scope": 1
    },
    "fanout": {
      "documents": 1,
      "tokens": 1,
      "judgment_units": 1,
      "cost_usd": 1,
      "duration_s": 1,
      "downstream": [
        {
          "judgment": "<string>",
          "judgments_per_month": 1,
          "cost_usd": 1
        }
      ]
    },
    "larger_sample": 123
  },
  "version": 2,
  "report": {
    "documents": 1,
    "current": {
      "type": "bool",
      "mean": 123,
      "histogram": [
        {
          "lower": 123,
          "upper": 123,
          "count": 1
        }
      ]
    },
    "candidate": {
      "type": "bool",
      "mean": 123,
      "histogram": [
        {
          "lower": 123,
          "upper": 123,
          "count": 1
        }
      ]
    },
    "threshold_flips": {},
    "recompute": {
      "documents": 1,
      "tokens": 1,
      "judgment_units": 1,
      "cost_usd": 1,
      "duration_s": 1,
      "downstream": [
        {
          "judgment": "<string>",
          "judgments_per_month": 1,
          "cost_usd": 1
        }
      ]
    },
    "downstream": [
      {
        "judgment": "<string>",
        "judgments_per_month": 1,
        "cost_usd": 1
      }
    ]
  },
  "export": {
    "since": "2023-11-07T05:31:56Z",
    "until": "2023-11-07T05:31:56Z",
    "judgments": [
      "<string>"
    ],
    "evaluations": 1,
    "files": [
      {
        "url": "<string>",
        "url_expires_at": "2023-11-07T05:31:56Z",
        "evaluations": 2,
        "bytes": 2
      }
    ],
    "expires_at": "2023-11-07T05:31:56Z",
    "links_unavailable": "<string>"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "details": {
      "reason": "<string>",
      "suggested_context": {
        "recipe": {
          "fields": [
            "<string>"
          ],
          "last_n": {},
          "window": {},
          "max_tokens": 2,
          "related": {},
          "previous": {
            "fields": [
              "<string>"
            ],
            "anchor": "<string>"
          }
        },
        "cost_per_answer": 1,
        "whole_state_cost_per_answer": 1,
        "sampled_documents": 2,
        "excluded": [
          {
            "path": "<string>",
            "reason": "id"
          }
        ]
      }
    }
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "details": {
      "reason": "<string>",
      "suggested_context": {
        "recipe": {
          "fields": [
            "<string>"
          ],
          "last_n": {},
          "window": {},
          "max_tokens": 2,
          "related": {},
          "previous": {
            "fields": [
              "<string>"
            ],
            "anchor": "<string>"
          }
        },
        "cost_per_answer": 1,
        "whole_state_cost_per_answer": 1,
        "sampled_documents": 2,
        "excluded": [
          {
            "path": "<string>",
            "reason": "id"
          }
        ]
      }
    }
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "details": {
      "reason": "<string>",
      "suggested_context": {
        "recipe": {
          "fields": [
            "<string>"
          ],
          "last_n": {},
          "window": {},
          "max_tokens": 2,
          "related": {},
          "previous": {
            "fields": [
              "<string>"
            ],
            "anchor": "<string>"
          }
        },
        "cost_per_answer": 1,
        "whole_state_cost_per_answer": 1,
        "sampled_documents": 2,
        "excluded": [
          {
            "path": "<string>",
            "reason": "id"
          }
        ]
      }
    }
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "details": {
      "reason": "<string>",
      "suggested_context": {
        "recipe": {
          "fields": [
            "<string>"
          ],
          "last_n": {},
          "window": {},
          "max_tokens": 2,
          "related": {},
          "previous": {
            "fields": [
              "<string>"
            ],
            "anchor": "<string>"
          }
        },
        "cost_per_answer": 1,
        "whole_state_cost_per_answer": 1,
        "sampled_documents": 2,
        "excluded": [
          {
            "path": "<string>",
            "reason": "id"
          }
        ]
      }
    }
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "details": {
      "reason": "<string>",
      "suggested_context": {
        "recipe": {
          "fields": [
            "<string>"
          ],
          "last_n": {},
          "window": {},
          "max_tokens": 2,
          "related": {},
          "previous": {
            "fields": [
              "<string>"
            ],
            "anchor": "<string>"
          }
        },
        "cost_per_answer": 1,
        "whole_state_cost_per_answer": 1,
        "sampled_documents": 2,
        "excluded": [
          {
            "path": "<string>",
            "reason": "id"
          }
        ]
      }
    }
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "details": {
      "reason": "<string>",
      "suggested_context": {
        "recipe": {
          "fields": [
            "<string>"
          ],
          "last_n": {},
          "window": {},
          "max_tokens": 2,
          "related": {},
          "previous": {
            "fields": [
              "<string>"
            ],
            "anchor": "<string>"
          }
        },
        "cost_per_answer": 1,
        "whole_state_cost_per_answer": 1,
        "sampled_documents": 2,
        "excluded": [
          {
            "path": "<string>",
            "reason": "id"
          }
        ]
      }
    }
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "details": {
      "reason": "<string>",
      "suggested_context": {
        "recipe": {
          "fields": [
            "<string>"
          ],
          "last_n": {},
          "window": {},
          "max_tokens": 2,
          "related": {},
          "previous": {
            "fields": [
              "<string>"
            ],
            "anchor": "<string>"
          }
        },
        "cost_per_answer": 1,
        "whole_state_cost_per_answer": 1,
        "sampled_documents": 2,
        "excluded": [
          {
            "path": "<string>",
            "reason": "id"
          }
        ]
      }
    }
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "details": {
      "reason": "<string>",
      "suggested_context": {
        "recipe": {
          "fields": [
            "<string>"
          ],
          "last_n": {},
          "window": {},
          "max_tokens": 2,
          "related": {},
          "previous": {
            "fields": [
              "<string>"
            ],
            "anchor": "<string>"
          }
        },
        "cost_per_answer": 1,
        "whole_state_cost_per_answer": 1,
        "sampled_documents": 2,
        "excluded": [
          {
            "path": "<string>",
            "reason": "id"
          }
        ]
      }
    }
  }
}

Authorizations

Authorization

string

header

required

An organization API key. Keys carry a role (read_write or read_only) and may be restricted to a namespace prefix such as acme/*, or to one namespace such as acme/prod/tenant_1. A prefix matches on a / boundary: acme/prod/tenant_1* covers acme/prod/tenant_1 and everything under acme/prod/tenant_1/, never acme/prod/tenant_12.

Headers

Idempotency-Key

string

One key per logical request, reused only on its retries. A key belongs to one request: within your organization, the same method, path, query and body. For 24 hours after a successful response, a request with the key and the same body gets that response back verbatim, with Idempotent-Replayed: true, and runs nothing. Only a successful response is kept, so the retry of a request that failed runs again. While the first request runs or its response is kept, the key with a different request is idempotency_key_reused (422). A request sent while one with its key is still running is rate_limited with Retry-After: 1, without running: retry it to get the first one's response. In the rare case the key can't be checked, the request runs as if it had none.

Required string length: 1 - 255

Path Parameters

string

required

Minimum string length: 1

Response

The job.

A job. A shadow job comes from activating a differing version without force. It starts in awaiting_confirm and runs its sample while it waits; report fills in when the sample is done. confirm activates version and the job ends done; cancel leaves the active version unchanged. On a template prefix, namespace is the prefix. A reference_index job builds the index an entity judgment's relations need; it starts running, and attribute names the attribute it indexes. An evaluation_export job starts running, counts evaluations written in progress.documents_done, never spends, and has export.

A resync job re-renders the readers of a changed threshold (resync) and re-judges the documents whose rendering flipped; a group_build job computes a new group's or aggregate's first aggregates with no fan-out (group); a discover job fills in proposal; a simulation job fills in simulation. Each starts running; discover and simulation never spend. Fan-out is not a job: it runs within the judgment's rolling limit and is deferred past it.

string

required

type

enum<string>

required

Available options:

backfill,

shadow,

periodic,

namespace_delete,

reference_index,

evaluation_export,

resync,

group_build,

discover,

simulation

status

enum<string>

required

Available options:

estimating,

awaiting_confirm,

running,

paused,

done,

failed,

cancelled

namespace

string

required

A namespace name, or a template prefix: a namespace path ending in /*, such as acme/prod/*, which every namespace under acme/prod/ inherits judgments from. Up to 256 bytes. Never exactly . or .., which a URL path can't carry.

Required string length: 1 - 256

Pattern: ^(?!\.\.?$)[A-Za-z0-9._:/-]+(/\*)?$

spend_usd

number

required

Judging billed by this job so far, in US dollars.

Required range: x >= 0

progress

object

required

Show child attributes

created_at

string<date-time>

required

RFC 3339, UTC.

updated_at

string<date-time>

required

RFC 3339, UTC.

judgment

string

A judgment, attribute or threshold name. Names are path segments in field references, so they never contain ..

Required string length: 1 - 128

Pattern: ^[A-Za-z0-9_-]+$

estimate

object | null

Show child attributes

estimated_completion_at

string<date-time> | null

RFC 3339, UTC.

error

string | null

attribute

string | null

Only on reference_index jobs, as attributes.<name>. The attribute whose reference index the job builds. Null for other jobs.

Pattern: ^attributes\.[A-Za-z0-9_-]+$

resync

object

Only on resync jobs.

Show child attributes

group

string

Only on group_build jobs, the group whose aggregates it computes.

Required string length: 1 - 128

Pattern: ^[A-Za-z0-9_-]+$

proposal

object | null

Only on discover jobs; null until done.

Show child attributes

simulation

object | null

Only on simulation jobs; null until done.

Show child attributes

version

integer<int32>

Shadow jobs only. The version being activated.

Required range: x >= 1

report

object

Shadow jobs only. Null while the sample runs; progress counts the sampled documents. A composite version's job has a CompositeShadowReport, and when it has too few labels it fails with an error that starts with insufficient_labels.

Option 1
Option 2

Show child attributes

export

object

evaluation_export jobs only: the range, the evaluations written, and once done the download links.

Show child attributes

Namespaces

Documents

Judgments

Outcomes and calibration

Groups

Subscriptions

Jobs

Engines

Organization

Webhooks

Resume a paused job

Authorizations

Headers

Path Parameters

Response