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

Ray Jobs API

The Jobs API from Ray — 4 operation(s) for jobs.

Ray Jobs API is one of 5 APIs that Ray 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.

This API exposes 5 operations across 4 paths, and defines 2 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against a single base URL, http://127.0.0.1:8265.

5 operations 4 paths 2 schemas 3 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
http://127.0.0.1:8265/api
Resource Areas
1

Paths & Operations 5

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

Jobs 5
GET
/api/jobs/
List all jobs
listJobs → 200
POST
/api/jobs/
Submit a new job
submitJob body → 200
GET
/api/jobs/{job_id}
Get job status
getJob 1 param → 200
GET
/api/jobs/{job_id}/logs
Get job logs
getJobLogs 1 param → 200
POST
/api/jobs/{job_id}/stop
Stop a job
stopJob 1 param → 200

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are JobInfo (12 properties), JobSubmitRequest (7 properties). Each schema is shown below with its type and property counts.

JobSubmitRequest
object
7 properties 1 required
JobInfo
object
12 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ray-jobs-api-openapi.yml Raw ↑

Other APIs Ray publishes across the network.

Ray Jobs REST API
Ray Dashboard API
Ray Serve HTTP API
Ray Version API