Job Specs API
Generated OpenAPI reference for the Job Specs API surface.
Overview
Job Specs endpoints are part of the public Everyn API. Reusable job specs and immutable job-spec versions.
Endpoints
The generated OpenAPI component below contains request parameters, request bodies, response bodies, status codes, and schemas for this tag. The static summary keeps the endpoint purpose, authentication, schema names, and API error guidance available before the interactive reference loads.
The details below are static HTML generated from the same OpenAPI schema, so they remain readable without client-side JavaScript. The interactive component after this section provides expandable examples and richer schema browsing.
Endpoint summary for quick scanning before using the generated reference:
| Method | Path | Purpose | Authentication | Request body / schema | Success response / schema | Errors |
|---|---|---|---|---|---|---|
GET | /v1/job-specs | List Job Specs | Bearer token (BearerAuth) | None. | 200 application/json: Page_JobSpecResponse_ | API errors: 400, 401, 403, 404, 409, 422, 429 |
POST | /v1/job-specs | Create Job Spec | Bearer token (BearerAuth) | application/json: JobSpecRequestBody | 201 application/json: JobSpecResponse | API errors: 400, 401, 403, 404, 409, 422, 429 |
GET | /v1/job-specs/summaries | List Job Spec Summaries | Bearer token (BearerAuth) | None. | 200 application/json: CountedBidirectionalPage_JobSpecSummaryResponse_ | API errors: 400, 401, 403, 404, 409, 422, 429 |
GET | /v1/job-specs/toolsets | List Row Agent Toolsets | Bearer token (BearerAuth) | None. | 200 application/json: AgentToolsetListResponse | API errors: 400, 401, 403, 404, 409, 422, 429 |
GET | /v1/job-specs/{job_spec_id} | Get Job Spec | Bearer token (BearerAuth) | None. | 200 application/json: JobSpecDetailResponse | API errors: 400, 401, 403, 404, 409, 422, 429 |
PATCH | /v1/job-specs/{job_spec_id} | Update Job Spec | Bearer token (BearerAuth) | application/json: JobSpecUpdateRequestBody | 200 application/json: JobSpecResponse | API errors: 400, 401, 403, 404, 409, 422, 429 |
GET | /v1/job-specs/{job_spec_id}/runs | List Job Runs | Bearer token (BearerAuth) | None. | 200 application/json: BidirectionalPage_JobRunHistoryResponse_ | API errors: 400, 401, 403, 404, 409, 422, 429 |
GET | /v1/job-specs/{job_spec_id}/versions | List Job Spec Versions | Bearer token (BearerAuth) | None. | 200 application/json: BidirectionalPage_JobSpecVersionResponse_ | API errors: 400, 401, 403, 404, 409, 422, 429 |
GET | /v1/job-specs/{job_spec_id}/versions/{version_id} | Get Job Spec Version | Bearer token (BearerAuth) | None. | 200 application/json: JobSpecVersionResponse | API errors: 400, 401, 403, 404, 409, 422, 429 |
Loading API reference...