Sign in
Docs
API referenceCoordinator

API reference

Open a thread

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

Open a coordinator thread with a title (1 to 200 characters), a purpose and the documents it is about.

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.CreateThreadRequest; path variables override their fields

application/json
  1. body

iohr.coordinator.v1.CreateThreadRequest

account_id?string
documents?array<string>
purpose?string
title?string

Response Body

iohr.coordinator.v1.CreateThreadResponse

application/json
  1. response

iohr.coordinator.v1.CreateThreadResponse

thread?

iohr.coordinator.v1.Thread

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.createThread({    documents: ["<documents>"],    purpose: "<purpose>",    title: "<title>",  });  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
{  "thread": {    "account_id": "string",    "created_at": "string",    "created_by": "string",    "documents": [      "string"    ],    "purpose": "string",    "redacted": true,    "state": "string",    "status": "string",    "thread_id": "string",    "title": "string",    "updated_at": "string"  }}