APIReferenz
Callable Jobs API
Generierte OpenAPI-Referenz für die Callable Jobs-API-Oberfläche.
Überblick
Callable Jobs-Endpoints gehören zur öffentlichen Everyn-API. Aufrufbare Jobs: Deployments und unveränderliche Revisionen, Vorschauen, Veröffentlichung sowie authentifizierte Aufrufe und Ergebnisse.
Endpunkte
Die generierte OpenAPI-Komponente unten enthält Request-Parameter, Request Bodies, Response Bodies, Statuscodes und Schemas für dieses Tag. Die statische Zusammenfassung hält Zweck, Authentifizierung, Schemanamen und Hinweise zur API-Fehlerbehandlung verfügbar, bevor die interaktive Referenz geladen ist.
Die Details unten sind statisches HTML aus demselben OpenAPI-Schema und bleiben ohne clientseitiges JavaScript lesbar. Die interaktive Komponente danach ergänzt ausklappbare Beispiele und Schema-Browsing.
Endpoint-Zusammenfassung für den schnellen Überblick vor der generierten Referenz:
| Methode | Pfad | Zweck | Authentifizierung | Request Body / Schema | Erfolgs-Response / Schema | Fehler |
|---|---|---|---|---|---|---|
GET | /v1/deployments | Callable-Deployments auflisten | Bearer-Token (BearerAuth) | Keine. | 200 application/json: Page_CallableDeploymentReadResponse_ | API-Fehler: 400, 401, 403, 404, 409, 422, 429 |
POST | /v1/deployments | Callable-Deployment erstellen | BrowserCsrf + BrowserSession ODER Bearer-Token (BearerAuth) | application/json: CreateDeploymentBody | 201 application/json: CallableDeploymentResponse | API-Fehler: 400, 401, 403, 404, 409, 422, 429 |
GET | /v1/deployments/{deployment_id} | Callable-Deployment abrufen | Bearer-Token (BearerAuth) | Keine. | 200 application/json: CallableDeploymentReadResponse | API-Fehler: 400, 401, 403, 404, 409, 422, 429 |
PATCH | /v1/deployments/{deployment_id} | Callable-Deployment aktivieren oder deaktivieren | BrowserCsrf + BrowserSession ODER Bearer-Token (BearerAuth) | application/json: UpdateDeploymentBody | 200 application/json: CallableDeploymentResponse | API-Fehler: 400, 401, 403, 404, 409, 422, 429 |
GET | /v1/deployments/{deployment_id}/history | Aufrufhistorie eines Callable-Deployments auflisten | Bearer-Token (BearerAuth) | Keine. | 200 application/json: Page_CallableHistoryResponse_ | API-Fehler: 400, 401, 403, 404, 409, 422, 429 |
POST | /v1/deployments/{deployment_id}/invocations | Callable-Deployment aufrufen | Bearer-Token (BearerAuth) | application/json: object | 202 application/json: CallableAcceptanceResponse | API-Fehler: 400, 401, 403, 404, 409, 422, 429 |
POST | /v1/deployments/{deployment_id}/publish | Revision eines Callable-Deployments veröffentlichen | BrowserCsrf + BrowserSession ODER Bearer-Token (BearerAuth) | application/json: PublishDeploymentBody | 200 application/json: CallableDeploymentResponse | API-Fehler: 400, 401, 403, 404, 409, 422, 429 |
POST | /v1/deployments/{deployment_id}/revisions | Unveränderliche Callable-Revision erstellen | BrowserCsrf + BrowserSession ODER Bearer-Token (BearerAuth) | application/json: CreateRevisionBody | 201 application/json: CallableRevisionResponse | API-Fehler: 400, 401, 403, 404, 409, 422, 429 |
POST | /v1/deployments/{deployment_id}/revisions/{revision_id}/preview | Callable-Revision als Vorschau ausführen | BrowserCsrf + BrowserSession ODER Bearer-Token (BearerAuth) | application/json: object | 202 application/json: CallableAcceptanceResponse | API-Fehler: 400, 401, 403, 404, 409, 422, 429 |
GET | /v1/invocations/{invocation_id} | Status eines Callable-Aufrufs abrufen | Bearer-Token (BearerAuth) | Keine. | 200 application/json: CallableFinishedObservationResponse202 application/json: CallablePendingResponse | API-Fehler: 400, 401, 403, 404, 409, 422, 429 |
POST | /v1/invocations/{invocation_id}/cancel | Callable-Aufruf abbrechen | Bearer-Token (BearerAuth) | Keine. | 200 application/json: CallableInvocationResponse | API-Fehler: 400, 401, 403, 404, 409, 422, 429 |
GET | /v1/invocations/{invocation_id}/details | Details eines Callable-Aufrufs abrufen | Bearer-Token (BearerAuth) | Keine. | 200 application/json: CallableHistoryResponse | API-Fehler: 400, 401, 403, 404, 409, 422, 429 |
GET | /v1/invocations/{invocation_id}/result | Ergebnis eines Callable-Aufrufs abrufen | Bearer-Token (BearerAuth) | Keine. | 200 application/json: CallableAddColumnsResultResponse oder CallableCreateRowsResultResponse202 application/json: CallablePendingResponse | API-Fehler: 400, 401, 403, 404, 409, 422, 429 |
GET | /v1/invocations/{invocation_id}/resume | Aktuelle Pause eines Callable-Aufrufs prüfen | BrowserSession ODER Bearer-Token (BearerAuth) | Keine. | 200 application/json: CallableResumeContextResponse | API-Fehler: 400, 401, 403, 404, 409, 422, 429 |
POST | /v1/invocations/{invocation_id}/resume | Callable-Aufruf lokal fortsetzen | BrowserCsrf + BrowserSession ODER Bearer-Token (BearerAuth) | application/json: CallableResumeBody | 200 application/json: CallableInvocationResponse | API-Fehler: 400, 401, 403, 404, 409, 422, 429 |
GET | /v1/invocations/{invocation_id}/webhook-attempts | Webhook-Versuche eines Callable-Aufrufs auflisten | Bearer-Token (BearerAuth) | Keine. | 200 application/json: Page_CallableWebhookAttemptResponse_ | API-Fehler: 400, 401, 403, 404, 409, 422, 429 |
POST | /v1/invocations/{invocation_id}/webhook-attempts/{outbox_id}/redeliver | Originales Callable-Ereignis erneut zustellen | BrowserCsrf + BrowserSession ODER Bearer-Token (BearerAuth) | application/json: CallableRedeliveryBody | 200 application/json: CallableWebhookCycleResponse | API-Fehler: 400, 401, 403, 404, 409, 422, 429 |
GET | /v1/invocations/{invocation_id}/webhook-deliveries | Aktuelle Webhook-Zustellungszyklen eines Callable-Aufrufs auflisten | Bearer-Token (BearerAuth) | Keine. | 200 application/json: Page_CallableWebhookCycleResponse_ | API-Fehler: 400, 401, 403, 404, 409, 422, 429 |
API-Referenz wird geladen...