BurstIQ Job Manager APIs API
Platform support asynchronous jobs, and these endpoints allow for the creation, status, and management of these jobs
Platform support asynchronous jobs, and these endpoints allow for the creation, status, and management of these jobs
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/burstiq-job-manager-apis-api"
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: LifeGraph Job Manager APIs API
description: LifeGraph API descriptions
license:
name: BurstIQ, Inc.
url: https://www.burstiq.com
version: 2.42.0
servers:
- url: https://api.burstiq.com
description: Generated server url
tags:
- name: Job Manager APIs
description: Platform support asynchronous jobs, and these endpoints allow for the creation, status, and management of these jobs
paths:
/api/jobs/requeue:
put:
tags:
- Job Manager APIs
description: 'Allowed user roles:
biqAdmin
sdzAdmin
requeue jobs IF the job queue is empty but there are queued jobs in the SDZ'
operationId: putRequeueJobs
responses:
'200':
description: OK
content:
'*/*':
schema:
type: object
summary: Put requeue jobs
x-summary-source: derived
/api/jobs/{chain}/upload:
post:
tags:
- Job Manager APIs
description: 'Allowed user roles:
sdzUser
adds data from a file as assets into GraphChain as an async job'
operationId: postUploadFile
parameters:
- name: chain
in: path
required: true
schema:
type: string
- name: owners
in: query
required: false
schema:
type: string
- name: limitedOwners
in: query
required: false
schema:
type: string
- name: metadata
in: query
required: false
schema:
type: string
- name: dataPipelineName
in: query
required: false
schema:
type: string
- name: sheetNum
in: query
required: false
schema:
type: integer
format: int32
- name: sheetName
in: query
required: false
schema:
type: string
- name: operation
in: query
required: false
schema:
type: string
- name: numThreads
in: query
required: false
schema:
type: integer
format: int32
default: 1
minimum: 1
- name: emailResultsTo
in: query
required: false
schema:
type: array
items:
type: string
uniqueItems: true
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
file:
type: string
format: binary
required:
- file
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/FileUploadJob_Public'
summary: Post upload file
x-summary-source: derived
/api/jobs/{chain}/truncate:
post:
tags:
- Job Manager APIs
description: 'Allowed user roles:
sdzAdmin
truncate all data in a graph chain in the secure data zone; preserves chain, dictionary, edge definitions, etc'
operationId: postTruncateChain
parameters:
- name: chain
in: path
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TruncateChainJobRequest_Public'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/TruncateChainJob_Public'
summary: Post truncate chain
x-summary-source: derived
/api/jobs/{chain}/smartcontracts/{sdoId}/{func}:
post:
tags:
- Job Manager APIs
description: 'Allowed user roles:
sdzUser
execute a smart contract, by address (sdo id) with arguments as named fields in the form; as an async job'
operationId: postExecuteSmartContract
parameters:
- name: chain
in: path
required: true
schema:
type: string
- name: sdoId
in: path
required: true
schema:
type: string
format: uuid
- name: func
in: path
required: true
schema:
type: string
- name: emailResultsTo
in: query
required: false
schema:
type: array
items:
type: string
uniqueItems: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/SmartContractExecJob_Public'
summary: Post execute smart contract
x-summary-source: derived
/api/jobs/{chain}/export:
post:
tags:
- Job Manager APIs
description: 'Allowed user roles:
sdzReadOnly
sdzUser
Exports data from a single chain and produces a JSON file, caller can request skip/limit of data for pagination of results always ordered by SDO ID; can be SFTP''ed or downloaded as an async job.'
operationId: postExportFile
parameters:
- name: chain
in: path
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ExportFileRequest_Public'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ExportDownloadJob_Public'
summary: Post export file
x-summary-source: derived
/api/jobs/{chain}/drop:
post:
tags:
- Job Manager APIs
description: 'Allowed user roles:
sdzAdmin
drops chain, all data, and all edges to/from this chain'
operationId: postDropChain
parameters:
- name: chain
in: path
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DropChainJobRequest_Public'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/DropChainJob_Public'
summary: Post drop chain
x-summary-source: derived
/api/jobs/sdz/wipe:
post:
tags:
- Job Manager APIs
description: 'Allowed user roles:
sdzAdmin
wipe all data, job infos, and blobs from the SDZ (NOT metadata)'
operationId: postWipeSDZ
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DropChainJobRequest_Public'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/WipeSDZDataJob_Public'
summary: Post wipe SDZ
x-summary-source: derived
/api/jobs/sdz/reset:
post:
tags:
- Job Manager APIs
description: 'Allowed user roles:
sdzAdmin
reset (wipe) all data and metadata; essentially reset the SDZ to look like its newly created'
operationId: postResetSDZ
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DropChainJobRequest_Public'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResetSDZJob_Public'
summary: Post reset SDZ
x-summary-source: derived
/api/jobs/download:
post:
tags:
- Job Manager APIs
description: 'Allowed user roles:
sdzReadOnly
sdzUser
queries data and produces a file; can be SFTP''ed or for downloaded as an async job. Supported file formats are CSV, PIPE, TAB, XLSX, and JSON. Warning: Care is needed when using CSV as there can be issues when the data is variable, complex and/or not fixed columns'
operationId: postDownloadFile
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DownloadFileRequest_Public'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/FileDownloadJob_Public'
summary: Post download file
x-summary-source: derived
/api/jobs/dictionary:
post:
tags:
- Job Manager APIs
description: 'Allowed user roles:
sdzAdmin
load (upsert) a dictionary into the SDZ using 1) POST with JSON body with dictionary and emailResultsTo (optional); or 2) MULTIPART POST with dictionary file and emailResultsTo (optional) as form fields'
operationId: postDictionaryFile
parameters:
- name: emailResultsTo
in: query
required: false
schema:
type: array
items:
type: string
uniqueItems: true
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
file:
type: string
format: binary
required:
- file
application/json:
schema:
$ref: '#/components/schemas/DictionaryUploadJobRequest_Public'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/DictionaryUploadJob_Public'
summary: Post dictionary file
x-summary-source: derived
/api/jobs/dbschema:
post:
tags:
- Job Manager APIs
description: 'Allowed user roles:
sdzAdmin
loads a dbschema (.dbs) XML file into the secure data zone; if delete is true any dictionaries in the SDZ not specified in the DbSchema file will be dropped'
operationId: postDbSchemaFile
parameters:
- name: delete
in: query
description: Required. If delete is true any dictionaries in the SDZ not specified in the DbSchema file will be dropped
required: true
schema:
type: boolean
- name: emailResultsTo
in: query
required: false
schema:
type: array
items:
type: string
uniqueItems: true
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
file:
type: string
format: binary
required:
- file
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/DbSchemaUploadJob_Public'
summary: Post db schema file
x-summary-source: derived
/api/jobs:
get:
tags:
- Job Manager APIs
description: 'Allowed user roles:
sdzAdmin
sdzReadOnly
sdzUser
Deprecated. Replace with combination of /api/jobs/query/summary for a list of job infos and /api/jobs/{jobId} for the details of a specific job info
Deprecated since 08 MAY 2025'
operationId: getQueryJobInfo
parameters:
- name: name
in: query
required: false
schema:
type: string
- name: type
in: query
required: false
schema:
type: string
- name: status
in: query
required: false
schema:
type: string
enum:
- NEW
- QUEUED
- RUNNING
- CANCELLED
- COMPLETED_ERROR
- COMPLETED_SUCCESS
- INCOMPLETE_ERROR
- name: callerId
in: query
required: false
schema:
type: string
format: uuid
- name: daysToReturn
in: query
required: false
schema:
type: integer
format: int32
default: 5
- name: orderBy
in: query
required: false
schema:
type: array
items:
type: string
- name: limit
in: query
required: false
schema:
type: integer
format: int32
- name: skip
in: query
required: false
schema:
type: integer
format: int32
responses:
'200':
description: OK
content:
'*/*':
schema:
type: array
items:
$ref: '#/components/schemas/JobBase_Public'
deprecated: true
summary: Get query job info
x-summary-source: derived
/api/jobs/{jobId}:
get:
tags:
- Job Manager APIs
description: 'Allowed user roles:
sdzAdmin
sdzReadOnly
sdzUser
get job info for a specific job id'
operationId: getJobInfo
parameters:
- name: jobId
in: path
required: true
schema:
type: string
format: uuid
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/JobBase_Public'
summary: Get job info
x-summary-source: derived
delete:
tags:
- Job Manager APIs
description: 'Allowed user roles:
sdzAdmin
sdzUser
cancel a pending job'
operationId: deleteCancelJob
parameters:
- name: jobId
in: path
required: true
schema:
type: string
format: uuid
responses:
'200':
description: OK
summary: Delete cancel job
x-summary-source: derived
/api/jobs/query/summary:
get:
tags:
- Job Manager APIs
description: 'Allowed user roles:
sdzAdmin
sdzReadOnly
sdzUser
Query for a summary of job infos (See JobInfoSummary schema for fields). Use /api/jobs/{jobId} to load complete job info'
operationId: getQueryJobInfoSummaries
parameters:
- name: name
in: query
description: Name of job. Can be an exact match or wildcard
required: false
schema:
type: string
examples:
exact match:
description: Exact match
value: name=FileUploadJob
wildcard match:
description: For all job infos with Upload in the name
value: name=*Upload*
- name: status
in: query
description: Status of job. Exact match only
required: false
schema:
type: string
enum:
- NEW
- QUEUED
- RUNNING
- CANCELLED
- COMPLETED_ERROR
- COMPLETED_SUCCESS
- INCOMPLETE_ERROR
- name: loggedInId
in: query
description: User wallet id of the logged in user that started the job. Only for sdzAdmins. Exact match only
required: false
schema:
type: string
format: uuid
examples:
'match example #1':
description: Logged In Id must be 3fa85f64-5717-4562-b3fc-2c963f66afa6
value: loggedInId=3fa85f64-5717-4562-b3fc-2c963f66afa6
'match example #2':
description: Logged In Id must be a41147fb-3915-4a7f-991d-a70e2b3bdfaf
value: loggedInId=a41147fb-3915-4a7f-991d-a70e2b3bdfaf
- name: daysToReturn
in: query
description: Limit results to jobs create in the last number of days
required: false
schema:
type: integer
format: int32
- name: orderBy
in: query
description: Order by field(s) with optional ACS or DESC keyword after each field
required: false
schema:
type: array
items:
type: string
- name: limit
in: query
description: Maximum amount of job infos to return. Use orderBy to ensure consistent ordering job infos
required: false
schema:
type: integer
format: int32
default: 100
- name: skip
in: query
description: Skip the X number of job infos then return the remaining job infos within the limit. Use orderBy to ensure consistent ordering of job infos
required: false
schema:
type: integer
format: int32
default: 0
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/JobInfoSummaryResponse'
summary: Get query job info summaries
x-summary-source: derived
/api/jobs/download/{jobId}:
get:
tags:
- Job Manager APIs
description: 'Allowed user roles:
sdzAdmin
sdzReadOnly
sdzUser
after the download job is completed, get the file (if not SFTP''ed). WARNING: files are deleted after being downloaded'
operationId: getDownloadFile
parameters:
- name: jobId
in: path
required: true
schema:
type: string
format: uuid
responses:
'200':
description: OK
content:
'*/*':
schema:
type: string
format: binary
summary: Get download file
x-summary-source: derived
components:
schemas:
ResetSDZJob_Public:
type: object
properties:
jobId:
type: string
format: uuid
name:
type: string
minLength: 1
status:
type: string
enum:
- NEW
- QUEUED
- RUNNING
- CANCELLED
- COMPLETED_ERROR
- COMPLETED_SUCCESS
- INCOMPLETE_ERROR
jobCreated:
type: string
format: date-time
jobQueued:
type: string
format: date-time
jobStarted:
type: string
format: date-time
jobCompleted:
type: string
format: date-time
emailRecipients:
type: array
items:
type: string
uniqueItems: true
timeout:
type: integer
format: int32
timeoutUnit:
type: string
enum:
- NANOSECONDS
- MICROSECONDS
- MILLISECONDS
- SECONDS
- MINUTES
- HOURS
- DAYS
results:
$ref: '#/components/schemas/JobResults_Public'
customerName:
type: string
minLength: 1
sdzName:
type: string
minLength: 1
effectiveId:
type: string
format: uuid
loggedInId:
type: string
format: uuid
mdc:
type: object
additionalProperties:
type: string
required:
- customerName
- effectiveId
- jobCreated
- jobId
- loggedInId
- mdc
- name
- sdzName
- status
- timeoutUnit
ExportFileRequest_Public:
type: object
properties:
title:
type: string
description:
type: string
filePassword:
type: string
sftpUrl:
type: string
sftpUsername:
type: string
sftpPassword:
type: string
emailResultsTo:
type: array
items:
type: string
uniqueItems: true
limit:
type: integer
format: int32
skip:
type: integer
format: int32
IndexDef_Public:
type: object
properties:
name:
type: string
minLength: 1
attributes:
type: array
items:
type: string
minLength: 1
minItems: 1
type:
type: string
enum:
- PRIMARY
- UNIQUE
- NORMAL
- KEYWORD
- FULL
- VECTOR
numDimensions:
type: integer
format: int32
maximum: 8192
minimum: 1
partialFilterTql:
type: string
required:
- attributes
- name
- numDimensions
- type
DownloadFileRequest_Public:
type: object
properties:
title:
type: string
description:
type: string
filePassword:
type: string
sftpUrl:
type: string
sftpUsername:
type: string
sftpPassword:
type: string
emailResultsTo:
type: array
items:
type: string
uniqueItems: true
fileType:
type: string
enum:
- CSV
- PIPE
- TAB
- XLS
- XLSX
- XLSM
- EDI
- JSON
- XML
- PARQUET
- SPSS
tql:
type: string
required:
- tql
DictionaryUploadJobRequest_Public:
type: object
properties:
dictionary:
$ref: '#/components/schemas/Dictionary_Public'
emailResultsTo:
type: array
items:
type: string
uniqueItems: true
required:
- dictionary
AttributeDef_Public:
type: object
properties:
name:
type: string
minLength: 1
description:
type: string
displayName:
type: string
datatype:
type: string
enum:
- STRING
- INTEGER
- LONG
- STRING_REFERENCE
- INTEGER_REFERENCE
- LONG_REFERENCE
- BOOLEAN
- DECIMAL
- DATE
- DATETIME
- ENUM
- FINGERPRINT
- CLOB
- BLOB
- OBJECT
- STRING_ARRAY
- INTEGER_ARRAY
- LONG_ARRAY
- STRING_REFERENCE_ARRAY
- INTEGER_REFERENCE_ARRAY
- LONG_REFERENCE_ARRAY
- BOOLEAN_ARRAY
- DECIMAL_ARRAY
- DATE_ARRAY
- DATETIME_ARRAY
- ENUM_ARRAY
- BLOB_ARRAY
- OBJECT_ARRAY
- VECTOR
required:
type: boolean
precision:
type: integer
format: int32
defaultValue:
type: string
min:
type: number
max:
type: number
regex:
type: string
enumValues:
type: array
items:
type: string
minLength: 1
uniqueItems: true
fingerprintAttributes:
type: array
items:
type: string
minLength: 1
vectorAttributes:
type: array
items:
type: string
minLength: 1
referenceDictionaryName:
type: string
required:
- datatype
- enumValues
- fingerprintAttributes
- name
- vectorAttributes
SmartContractExecJob_Public:
type: object
properties:
jobId:
type: string
format: uuid
name:
type: string
minLength: 1
status:
type: string
enum:
- NEW
- QUEUED
- RUNNING
- CANCELLED
- COMPLETED_ERROR
- COMPLETED_SUCCESS
- INCOMPLETE_ERROR
jobCreated:
type: string
format: date-time
jobQueued:
type: string
format: date-time
jobStarted:
type: string
format: date-time
jobCompleted:
type: string
format: date-time
emailRecipients:
type: array
items:
type: string
uniqueItems: true
timeout:
type: integer
format: int32
timeoutUnit:
type: string
enum:
- NANOSECONDS
- MICROSECONDS
- MILLISECONDS
- SECONDS
- MINUTES
- HOURS
- DAYS
results:
$ref: '#/components/schemas/JobResults_Public'
customerName:
type: string
minLength: 1
sdzName:
type: string
minLength: 1
effectiveId:
type: string
format: uuid
loggedInId:
type: string
format: uuid
mdc:
type: object
additionalProperties:
type: string
sdoId:
type: string
format: uuid
func:
type: string
args:
type: object
receipt:
$ref: '#/components/schemas/SDOReceiptSmartContract_Public'
dictName:
type: string
required:
- customerName
- effectiveId
- jobCreated
- jobId
- loggedInId
- mdc
- name
- sdzName
- status
- timeoutUnit
JobInfoSummaryResponse:
type: object
properties:
total:
type: integer
format: int32
description: Count of total possible jobs infos for given query
limit:
type: integer
format: int32
description: Limit of jobs infos return for this query
skip:
type: integer
format: int32
description: Skip the first number of job infos for this query
jobs:
type: array
description: List of job infos returned for this query
items:
$ref: '#/components/schemas/JobInfoSummary'
DictionaryUploadJob_Public:
type: object
properties:
jobId:
type: string
format: uuid
name:
type: string
minLength: 1
status:
type: string
enum:
- NEW
- QUEUED
- RUNNING
- CANCELLED
- COMPLETED_ERROR
- COMPLETED_SUCCESS
- INCOMPLETE_ERROR
jobCreated:
type: string
format: date-time
jobQueued:
type: string
format: date-time
jobStarted:
type: string
format: date-time
jobCompleted:
type: string
format: date-time
emailRecipients:
type: array
items:
type: string
uniqueItems: true
timeout:
type: integer
format: int32
timeoutUnit:
type: string
enum:
- NANOSECONDS
- MICROSECONDS
- MILLISECONDS
- SECONDS
- MINUTES
- HOURS
- DAYS
results:
$ref: '#/components/schemas/JobResults_Public'
customerName:
type: string
minLength: 1
sdzName:
type: string
minLength: 1
effectiveId:
type: string
format: uuid
loggedInId:
type: string
format: uuid
mdc:
type: object
additionalProperties:
type: string
originalFilename:
type: string
key:
type: string
dictName:
type: string
required:
- customerName
- effectiveId
- jobCreated
- jobId
- loggedInId
- mdc
- name
- sdzName
- status
- timeoutUnit
ReceiptSmartContract_Public:
type: object
properties:
function:
type: string
minLength: 1
arguments:
type: object
response: {}
successful:
type: boolean
consoleBase64:
type: string
errorLogBase64:
type: string
required:
- function
- successful
DropChainJobRequest_Public:
type: object
properties:
emailResultsTo:
type: array
items:
type: string
uniqueItems: true
DbSchemaUploadJob_Public:
type: object
properties:
jobId:
type: string
format: uuid
name:
type: string
minLength: 1
status:
type: string
enum:
- NEW
- QUEUED
- RUNNING
- CANCELLED
- COMPLETED_ERROR
- COMPLETED_SUCCESS
- INCOMPLETE_ERROR
jobCreated:
type: string
format: date-time
jobQueued:
type: string
format: date-time
jobStarted:
type: string
format: date-time
jobCompleted:
type: string
format: date-time
emailRecipients:
type: array
items:
type: string
uniqueItems: true
timeout:
type: integer
format: int32
timeoutUnit:
type: string
enum:
- NANOSECONDS
- MICROSECONDS
- MILLISECONDS
- SECONDS
- MINUTES
- HOURS
- DAYS
results:
$ref: '#/components/schemas/JobResults_Public'
customerName:
type: string
minLength: 1
sdzName:
type: string
minLength: 1
effectiveId:
type: string
format: uuid
loggedInId:
type: string
format: uuid
mdc:
type: object
additionalProperties:
type: string
originalFilename:
type: string
key:
type: string
delete:
type: boolean
required:
- customerName
- effectiveId
- jobCreated
- jobId
- loggedInId
- mdc
- name
- sdzName
- status
- timeoutUnit
Verification_Public:
type: object
properties:
verifier:
type: string
format: uuid
verifiedOn:
type: string
format: date-time
notes:
type: string
hash:
type: string
minLength: 1
required:
- hash
- verifiedOn
- verifier
TruncateChainJob_Public:
type: object
properties:
jobId:
type: string
format: uuid
name:
type: string
minLength: 1
status:
type: string
enum:
- NEW
- QUEUED
- RUNNING
- CANCELLED
- COMPLETED_ERROR
- COMPLETED_SUCCESS
- INCOMPLETE_ERROR
jobCreated:
type: string
format: date-time
jobQueued:
type: string
format: date-time
jobStarted:
type: string
format: date-time
jobCompleted:
type: string
format: date-time
emailRecipients:
type: array
items:
type: string
uniqueItems: true
timeout:
type: integer
format: int32
timeoutUnit:
type: string
enum:
- NANOSECONDS
- MICROSECONDS
- MILLISECONDS
- SECONDS
- MINUTES
- HOURS
- DAYS
results:
$ref: '#/components/schemas/JobResults_Public'
customerName:
type: string
minLength: 1
sdzName:
type: string
minLength: 1
effectiveId:
type: string
format: uuid
loggedInId:
type: string
format: uuid
mdc:
type: object
additionalProperties:
type: string
dictName:
type: string
required:
- customerName
- effectiveId
- jobCreated
- jobId
- loggedInId
- md
# --- truncated at 32 KB (48 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/burstiq/refs/heads/main/openapi/burstiq-job-manager-apis-api-openapi.yml