Sign in
Docs
API referenceCoordinator

API reference

File a job

Have a token? Manage tokens in the console
POST
/v1/coordinator/jobs

File a job at Intake: kind, brief, the document it implements, repository. It runs on the caller's own runners and walks every gate; nothing skips one.

Needs scope coordinator:write.

Authorization

bearer
headerAuthorizationBearer <JWT>

An access token from the identity provider: a person's, or a customer's from the client credentials grant with an API key (developers.inorbit.hr). The gateway verifies it; the audience is iohr-api.

Request Body

iohr.coordinator.v1.CreateJobRequest; path variables override their fields

application/json
  1. body

iohr.coordinator.v1.CreateJobRequest

acceptance?array<string>
account_id?string
brief?string
compliance_pr?string
document_excerpt?string
document_id?string
files?array<string>
kind?string
model?string
model_override_reason?string
parent_job_id?string
pipeline_id?string
pipeline_version?integer
Formatint32
priority?integer
Formatint32
queued_ask_id?string
repository?string
runner_labels?array<string>
security?boolean
supersedes?string
tags?array<string>
thread_id?string
token_budget?integer
Formatint32
trust_tier?string

Response Body

iohr.coordinator.v1.CreateJobResponse

application/json
  1. response

iohr.coordinator.v1.CreateJobResponse

job?

iohr.coordinator.v1.Job

import { ApiError, Public } from "@inorbithr/sdk";// Reads INORBIT_TOKEN, or INORBIT_KEY_ID and INORBIT_KEY_SECRET.const api = Public.fromEnv();try {  const { value } = await api.coordinator.createJob({    acceptance: ["<acceptance>"],    brief: "<brief>",    compliance_pr: "<compliance_pr>",    document_excerpt: "<document_excerpt>",  });  console.log(value);} catch (e) {  if (!(e instanceof ApiError)) throw e;  console.error(`${e.code}: ${e.problem} (request id ${e.raw.requestId})`);  process.exitCode = 1;}

npm install @inorbithr/sdk. Calls the package's public surface; an operation newer than your package needs the next release or a client generated for your account. The SDKs.

Example Response
{  "job": {    "account_id": "string",    "await_deadline": "string",    "await_escalation": "string",    "await_kind": "string",    "brief": "string",    "brief_sha256": "string",    "compliance": {      "evidence_id": "string",      "needed": "string",      "paths_observed": true,      "pull_request": "string",      "pull_request_state": "string",      "reasons": [        "string"      ],      "repository": "string",      "required": true,      "verified": true    },    "created_at": "string",    "created_by": "string",    "document_id": "string",    "hold_ask": "string",    "hold_reason": "string",    "job_id": "string",    "kind": "string",    "lease_id": "string",    "mode": "string",    "model": "string",    "model_override_reason": "string",    "parent_job_id": "string",    "paused_from": "string",    "priority": 0,    "repository": "string",    "retried": true,    "retry_at": "string",    "runner_labels": [      "string"    ],    "stage": "string",    "state": "string",    "supersedes": "string",    "tags": [      "string"    ],    "thread_id": "string",    "token_budget": 0,    "trust_tier": "string",    "updated_at": "string",    "usage": {      "cache_read_tokens": "string",      "cache_write_tokens": "string",      "done_job_tokens": "string",      "reports": 0,      "tokens_in": "string",      "tokens_out": "string",      "total_tokens": "string"    },    "user": "string"  }}