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

Restate invocation API

Invocation management

Restate invocation API is one of 9 APIs that Restate publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 2 JSON Schema definitions.

Tagged areas include invocation. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a GitHub repository, and 2 JSON Schemas.

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

Requests are made against the base URL http://localhost:9070.

5 operations 5 paths 2 schemas 1 DELETE4 PATCH

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.4.0
Base URL
http://localhost:9070
Resource Areas
1

Paths & Operations 5

Across 5 paths, the API surfaces 5 operations — 1 DELETE, 4 PATCH. Each is listed below with its method, path, parameters, and response codes.

invocation 5

Invocation management

DELETE
/invocations/{invocation_id}deprecated
Delete An Invocation
delete_invocation 2 params → 202400403404409500503
PATCH
/invocations/{invocation_id}/cancel
Cancel An Invocation
cancel_invocation 1 param → 200202404 Not Found503 Service Unavailable400 Bad Request409 Conflict
PATCH
/invocations/{invocation_id}/kill
Kill An Invocation
kill_invocation 1 param → 200404 Not Found503 Service Unavailable400 Bad Request409 Conflict
PATCH
/invocations/{invocation_id}/purge
Purge An Invocation
purge_invocation 1 param → 200404 Not Found503 Service Unavailable400 Bad Request409 Conflict
PATCH
/invocations/{invocation_id}/purge-journal
Purge An Invocation Journal
purge_journal 1 param → 200404 Not Found503 Service Unavailable400 Bad Request409 Conflict

Schemas 2

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

DeletionMode
string
ErrorDescriptionResponse
object
Error details of the response
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

restate-invocation-api-openapi.yml Raw ↑

Other APIs Restate publishes across the network.

Restate cluster_health API
Restate deployment API
Restate health API
Restate openapi API
Restate service API
Restate service_handler API
Restate subscription API
Restate version API