APIReference
Callable Jobs API
Generated OpenAPI reference for the Callable Jobs API surface.
Overview
Callable Jobs endpoints are part of the public Everyn API. Human-owned immutable deployment authoring and previews; authenticated machine Invocation submission, status, history, cancellation and results.
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/deployments | List Deployments | Bearer token (BearerAuth) | None. | 200 application/json: Page_CallableDeploymentReadResponse_ | API errors: 400, 401, 403, 404, 409, 422, 429 |
POST | /v1/deployments | Create Deployment | BrowserCsrf + BrowserSession OR Bearer token (BearerAuth) | application/json: CreateDeploymentBody | 201 application/json: CallableDeploymentResponse | API errors: 400, 401, 403, 404, 409, 422, 429 |
GET | /v1/deployments/{deployment_id} | Get Deployment | Bearer token (BearerAuth) | None. | 200 application/json: CallableDeploymentReadResponse | API errors: 400, 401, 403, 404, 409, 422, 429 |
PATCH | /v1/deployments/{deployment_id} | Set Enabled | BrowserCsrf + BrowserSession OR Bearer token (BearerAuth) | application/json: UpdateDeploymentBody | 200 application/json: CallableDeploymentResponse | API errors: 400, 401, 403, 404, 409, 422, 429 |
GET | /v1/deployments/{deployment_id}/history | History | Bearer token (BearerAuth) | None. | 200 application/json: Page_CallableHistoryResponse_ | API errors: 400, 401, 403, 404, 409, 422, 429 |
POST | /v1/deployments/{deployment_id}/invocations | Invoke | Bearer token (BearerAuth) | application/json: object | 202 application/json: CallableAcceptanceResponse | API errors: 400, 401, 403, 404, 409, 422, 429 |
POST | /v1/deployments/{deployment_id}/publish | Publish | BrowserCsrf + BrowserSession OR Bearer token (BearerAuth) | application/json: PublishDeploymentBody | 200 application/json: CallableDeploymentResponse | API errors: 400, 401, 403, 404, 409, 422, 429 |
POST | /v1/deployments/{deployment_id}/revisions | Create Revision | BrowserCsrf + BrowserSession OR Bearer token (BearerAuth) | application/json: CreateRevisionBody | 201 application/json: CallableRevisionResponse | API errors: 400, 401, 403, 404, 409, 422, 429 |
POST | /v1/deployments/{deployment_id}/revisions/{revision_id}/preview | Preview | BrowserCsrf + BrowserSession OR Bearer token (BearerAuth) | application/json: object | 202 application/json: CallableAcceptanceResponse | API errors: 400, 401, 403, 404, 409, 422, 429 |
GET | /v1/invocations/{invocation_id} | Status | Bearer token (BearerAuth) | None. | 200 application/json: CallableFinishedObservationResponse202 application/json: CallablePendingResponse | API errors: 400, 401, 403, 404, 409, 422, 429 |
POST | /v1/invocations/{invocation_id}/cancel | Cancel | Bearer token (BearerAuth) | None. | 200 application/json: CallableInvocationResponse | API errors: 400, 401, 403, 404, 409, 422, 429 |
GET | /v1/invocations/{invocation_id}/details | Invocation Details | Bearer token (BearerAuth) | None. | 200 application/json: CallableHistoryResponse | API errors: 400, 401, 403, 404, 409, 422, 429 |
GET | /v1/invocations/{invocation_id}/result | Result | Bearer token (BearerAuth) | None. | 200 application/json: CallableAddColumnsResultResponse or CallableCreateRowsResultResponse202 application/json: CallablePendingResponse | API errors: 400, 401, 403, 404, 409, 422, 429 |
GET | /v1/invocations/{invocation_id}/resume | Resume Context | BrowserSession OR Bearer token (BearerAuth) | None. | 200 application/json: CallableResumeContextResponse | API errors: 400, 401, 403, 404, 409, 422, 429 |
POST | /v1/invocations/{invocation_id}/resume | Resume | BrowserCsrf + BrowserSession OR Bearer token (BearerAuth) | application/json: CallableResumeBody | 200 application/json: CallableInvocationResponse | API errors: 400, 401, 403, 404, 409, 422, 429 |
GET | /v1/invocations/{invocation_id}/webhook-attempts | Webhook Attempts | Bearer token (BearerAuth) | None. | 200 application/json: Page_CallableWebhookAttemptResponse_ | API errors: 400, 401, 403, 404, 409, 422, 429 |
POST | /v1/invocations/{invocation_id}/webhook-attempts/{outbox_id}/redeliver | Redeliver Webhook | BrowserCsrf + BrowserSession OR Bearer token (BearerAuth) | application/json: CallableRedeliveryBody | 200 application/json: CallableWebhookCycleResponse | API errors: 400, 401, 403, 404, 409, 422, 429 |
GET | /v1/invocations/{invocation_id}/webhook-deliveries | Webhook Deliveries | Bearer token (BearerAuth) | None. | 200 application/json: Page_CallableWebhookCycleResponse_ | API errors: 400, 401, 403, 404, 409, 422, 429 |
Loading API reference...