How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

SingleStore Jobs API

Create, retrieve, list, and delete scheduled notebook jobs within SingleStore Helios. Jobs enable automated execution of notebooks on configurable schedules.

SingleStore Jobs API is one of 9 APIs that SingleStore publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Job. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 5 operations across 3 paths, and defines 8 schemas. It is described by OpenAPI 3.2.0, at version v1.

Requests are made against a single base URL, https://api.singlestore.com/v1.

5 operations 3 paths 8 schemas 1 DELETE3 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v1
Base URL
https://{workspaceHost}
Authentication
HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 1

SingleStore Jobs API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — API key generated from the SingleStore Cloud Portal. Pass the key as a Bearer token in the Authorization header of every request.

Paths & Operations 5

Across 3 paths, the API surfaces 5 operations — 1 DELETE, 3 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Jobs 5

Create, retrieve, list, and delete scheduled notebook jobs within SingleStore Helios. Jobs enable automated execution of notebooks on configurable schedules.

GET
/jobs
List Jobs
listJobs 1 param → 200401
POST
/jobs
Create a Job
createJob body → 200400401
GET
/jobs/{jobID}
Get a Job
getJob 1 param → 200401404
DELETE
/jobs/{jobID}
Delete a Job
deleteJob 1 param → 200401404
GET
/jobs/{jobID}/executions
List Job Executions
listJobExecutions 3 params → 200401404

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are Job (10 properties), JobExecution (8 properties), JobCreate (6 properties), JobTargetConfig (4 properties). Each schema is shown below with its type and property counts.

Error
object
Standard error response returned when an API request fails.
2 properties
JobExecutionConfig
object
Configuration specifying the notebook to execute and runtime environment.
3 properties 1 required
JobSchedule
object
Schedule configuration defining when and how often a job runs.
3 properties
JobTargetConfig
object
Configuration specifying the workspace and database the notebook job should connect to.
4 properties 2 required
JobParameter
object
A parameter passed to a notebook at job execution time.
3 properties 2 required
Job
object
A scheduled notebook job that executes a specified notebook on a configurable schedule against a target workspace and database.
10 properties
JobExecution
object
A single execution instance of a scheduled job, capturing its status and timing information.
8 properties
JobCreate
object
Request body for creating a new scheduled notebook job.
6 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

singlestore-jobs-api-openapi.yml Raw ↑

Other APIs SingleStore publishes across the network.

SingleStore Files API
SingleStore Health API
SingleStore Organizations API
SingleStore Queries API
SingleStore Regions API
SingleStore Secrets API
SingleStore WorkspaceGroups API
SingleStore Workspaces API
Where this information came from

This is an independent, third-party profile of SingleStore Jobs API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.