Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Nimbleway

Nimbleway Jobs API

The Jobs API from Nimbleway — 9 operation(s) for jobs.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

This API exposes 13 operations across 9 paths, and defines 20 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against a single base URL, https://sdk.nimbleway.com.

13 operations 9 paths 20 schemas 1 DELETE8 GET1 PATCH3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://sdk.nimbleway.com/v1
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Nimbleway Jobs API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (BearerAuth).

Paths & Operations 13

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

Jobs 13
GET
/v1/jobs
List Jobs
list_jobs_v1_jobs_get 5 params → 200422
POST
/v1/jobs
Create Job
create_job_v1_jobs_post 1 param body → 201422
GET
/v1/jobs/{job_id}
Get Job
get_job_v1_jobs__job_id__get 2 params → 200422
PATCH
/v1/jobs/{job_id}
Update Job
update_job_v1_jobs__job_id__patch 2 params body → 200422
DELETE
/v1/jobs/{job_id}
Delete Job
delete_job_v1_jobs__job_id__delete 2 params → 204422
GET
/v1/jobs/{job_id}/runs
List Runs for Job
list_job_runs_v1_jobs__job_id__runs_get 5 params → 200422
POST
/v1/jobs/{job_id}/runs
Trigger Run
trigger_job_run_v1_jobs__job_id__runs_post 2 params → 201422
GET
/v1/jobs/runs/{run_id}
Get Run
get_run_v1_jobs_runs__run_id__get 2 params → 200422
POST
/v1/jobs/runs/{run_id}/cancel
Cancel Run
cancel_run_v1_jobs_runs__run_id__cancel_post 2 params → 200422
GET
/v1/jobs/runs/{run_id}/artifacts
List Run Artifacts
list_run_artifacts_v1_jobs_runs__run_id__artifacts_get 2 params → 200422
GET
/v1/jobs/runs/{run_id}/artifacts/{artifact_id}
Get Run Artifact
get_run_artifact_v1_jobs_runs__run_id__artifacts__artifact_id__get 3 params → 200422
GET
/v1/jobs/runs/{run_id}/artifacts/{artifact_id}/preview
Preview Run Artifact
preview_run_artifact_v1_jobs_runs__run_id__artifacts__artifact_id__preview_get 3 params → 200422
GET
/v1/jobs/runs/{run_id}/artifacts/{artifact_id}/download-url
Get Run Artifact Download URL
get_run_artifact_download_url_v1_jobs_runs__run_id__artifacts__artifact_id__download_url_get 3 params → 200422

Schemas 20

The contract defines 20 schemas that model the data the API accepts and returns. The most detailed are Job (12 properties), JobRunDetail (10 properties), JobRun (9 properties), CreateJobRequest (7 properties). Each schema is shown below with its type and property counts.

ArtifactPreview
object
A tabular preview of an artifact's contents.
3 properties 3 required
JobRunSummary
object
Aggregate metrics for a run.
3 properties
JobContext
object
Minimal job context embedded in a run detail.
5 properties 2 required
UpdateJobRequest
object
Partial update for an existing job; omitted fields are left unchanged.
5 properties
JobRunDetail
object
Full detail for a single run.
10 properties 5 required
JobRunCancelResponse
object
Result of cancelling a run.
2 properties 2 required
JobRunError
object
Error details for a failed run.
3 properties
Artifact
object
A file produced by a run.
4 properties 4 required
Job
object
A configured job: an agent plus its schedule, inputs, and destination.
12 properties 2 required
ArtifactDownloadUrl
object
A pre-signed URL for downloading an artifact.
2 properties 2 required
JobInputs
object
Configuration for the input data a job processes.
3 properties 1 required
ArtifactList
object
Artifacts produced by a run.
1 property 1 required
JobList
object
A page of jobs.
4 properties 4 required
JobDestination
object
Where a job writes its results.
3 properties 2 required
JobSchedule
object
Cron-based schedule controlling when a job runs automatically.
2 properties 2 required
ValidationError
object
5 properties 3 required
JobRun
object
A single execution of a job.
9 properties 5 required
CreateJobRequest
object
Payload to create a new job.
7 properties 2 required
HTTPValidationError
object
1 property
JobRunList
object
A page of job runs.
4 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nimbleway-jobs-api-openapi.yml Raw ↑

Other APIs Nimbleway publishes across the network.

Nimbleway Agents API
AE Profile APIs.io
Nimbleway Crawl API
AE Profile APIs.io
Nimbleway Domain Knowledge API
AE Profile APIs.io
Nimbleway Extract API
AE Profile APIs.io
Nimbleway Fast SERP API
AE Profile APIs.io
Nimbleway Map API
AE Profile APIs.io
Nimbleway Media API
AE Profile APIs.io
Nimbleway Search API
AE Profile APIs.io
Nimbleway SERP API
AE Profile APIs.io
Nimbleway Tasks API
AE Profile APIs.io
#Jobs
← Back to N APIs
API Details
ID
nimbleway:nimbleway-jobs-api
Base URL
https://sdk.nimbleway.com/v1
Docs
https://docs.nimbleway.com/home
Provider
Nimbleway
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network