Restate · Schema

Invocation

Represents a Restate durable invocation — an in-flight or completed call to a service handler with exactly-once execution semantics.

Durable ExecutionWorkflowsMicroservicesOrchestrationDistributed Systems

Properties

Name Type Description
id string Unique identifier for the invocation.
target string The fully qualified target in format ServiceName/handlerName or ServiceName/key/handlerName.
target_service_name string The name of the target service.
target_handler_name string The name of the target handler.
target_service_key stringnull The virtual object key (null for plain services).
status string Current execution status of the invocation.
created_at string ISO 8601 timestamp when the invocation was created.
modified_at string ISO 8601 timestamp when the invocation status last changed.
trace_id string Distributed trace identifier for observability.
deployment_id string The deployment that is handling this invocation.
retry_count integer Number of times this invocation has been retried.
last_failure stringnull Description of the last failure that caused a retry.
next_retry_at stringnull ISO 8601 timestamp for when the next retry will occur.
View JSON Schema on GitHub

JSON Schema

restate-invocation-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/restate/refs/heads/main/json-schema/restate-invocation-schema.json",
  "title": "Invocation",
  "description": "Represents a Restate durable invocation — an in-flight or completed call to a service handler with exactly-once execution semantics.",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier for the invocation."
    },
    "target": {
      "type": "string",
      "description": "The fully qualified target in format ServiceName/handlerName or ServiceName/key/handlerName."
    },
    "target_service_name": {
      "type": "string",
      "description": "The name of the target service."
    },
    "target_handler_name": {
      "type": "string",
      "description": "The name of the target handler."
    },
    "target_service_key": {
      "type": ["string", "null"],
      "description": "The virtual object key (null for plain services)."
    },
    "status": {
      "type": "string",
      "description": "Current execution status of the invocation.",
      "enum": ["pending", "ready", "running", "backing-off", "suspended", "completed"]
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "ISO 8601 timestamp when the invocation was created."
    },
    "modified_at": {
      "type": "string",
      "format": "date-time",
      "description": "ISO 8601 timestamp when the invocation status last changed."
    },
    "trace_id": {
      "type": "string",
      "description": "Distributed trace identifier for observability."
    },
    "deployment_id": {
      "type": "string",
      "description": "The deployment that is handling this invocation."
    },
    "retry_count": {
      "type": "integer",
      "minimum": 0,
      "description": "Number of times this invocation has been retried."
    },
    "last_failure": {
      "type": ["string", "null"],
      "description": "Description of the last failure that caused a retry."
    },
    "next_retry_at": {
      "type": ["string", "null"],
      "format": "date-time",
      "description": "ISO 8601 timestamp for when the next retry will occur."
    }
  },
  "required": ["id", "target", "status"]
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/restate-invocation"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.