{ "openapi": "3.0.3", "info": { "description": "The v2 API delivers a significantly improved developer experience with consistent design patterns and enhanced functionality.", "title": "Inngest REST API v2", "version": "2.0.0" }, "servers": [ { "description": "Production server", "url": "https://api.inngest.com/v2" }, { "description": "Development server", "url": "http://localhost:8288/api/v2" } ], "paths": { "/account": { "get": { "description": "Returns the account for the authenticated user", "operationId": "V2_FetchAccount", "responses": { "200": { "content": { "application/json": { "examples": { "default": { "value": { "data": { "createdAt": "2024-01-10T09:15:00Z", "email": "user@company.com", "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479", "name": "Current User", "updatedAt": "2024-01-20T12:00:00Z" }, "metadata": { "cachedUntil": null, "fetchedAt": "2024-01-20T14:22:33Z" } } } }, "schema": { "$ref": "#/components/schemas/v2FetchAccountResponse" } } }, "description": "Account" }, "401": { "content": { "application/json": { "examples": { "default": { "value": "Authentication failed" } }, "schema": { "$ref": "#/components/schemas/v2ErrorResponse" } } }, "description": "Unauthorized - authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ErrorResponse" } } }, "description": "Forbidden - Insufficient permissions" }, "500": { "content": { "application/json": { "examples": { "default": { "value": { "errors": [ { "code": "internal_error", "message": "Something went wrong" } ] } } }, "schema": { "$ref": "#/components/schemas/v2ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "BearerAuth": [] } ], "summary": "Get account", "tags": [ "Account" ] } }, "/apps": { "get": { "description": "Lists active apps in the authenticated environment. Set archived to true to list archived apps instead.", "operationId": "V2_GetApps", "parameters": [ { "description": "Pagination cursor from previous response", "in": "query", "name": "cursor", "schema": { "type": "string" } }, { "description": "Number of apps to return per page (min: 1, max: 100)", "in": "query", "name": "limit", "schema": { "default": "20", "format": "int32", "type": "integer" } }, { "description": "Whether to return archived apps instead of active apps", "in": "query", "name": "archived", "schema": { "default": "false", "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2GetAppsResponse" } } }, "description": "A successful response." } }, "security": [ { "BearerAuth": [] } ], "summary": "Get apps", "tags": [ "Apps" ], "x-beta": true } }, "/apps/{appId}": { "get": { "description": "Fetches details for a single app, including sync metadata and function count", "operationId": "V2_GetApp", "parameters": [ { "description": "The user-defined app ID", "in": "path", "name": "appId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "default": { "value": { "data": { "createdAt": "2024-01-10T09:15:00Z", "functionCount": 2, "id": "my-app", "isArchived": false, "latestSync": { "sdkLanguage": "typescript", "sdkVersion": "3.22.0", "url": "https://example.com/api/inngest" }, "method": "SERVE", "name": "my-app" }, "metadata": { "cachedUntil": null, "fetchedAt": "2024-01-20T14:22:33Z" } } } }, "schema": { "$ref": "#/components/schemas/v2GetAppResponse" } } }, "description": "A successful response." } }, "security": [ { "BearerAuth": [] } ], "summary": "Get app", "tags": [ "Apps" ], "x-beta": true } }, "/apps/{appId}/functions": { "get": { "description": "Lists function configuration and status details for an app", "operationId": "V2_GetFunctions", "parameters": [ { "in": "path", "name": "appId", "required": true, "schema": { "type": "string" } }, { "description": "Pagination cursor from previous response", "in": "query", "name": "cursor", "schema": { "type": "string" } }, { "description": "Number of functions to return per page (min: 1, max: 100)", "in": "query", "name": "limit", "schema": { "default": "20", "format": "int32", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "default": { "value": { "data": [ { "app": { "id": "production-app" }, "configuration": { "retries": { "isDefault": true, "value": 3 } }, "id": "send-welcome-email", "isArchived": false, "isPaused": false, "name": "Send welcome email", "slug": "send-welcome-email", "triggers": [ { "type": "EVENT", "value": "user.created" } ] } ], "metadata": { "fetchedAt": "2026-06-10T12:00:00Z" }, "page": { "cursor": null, "hasMore": false, "limit": 20 } } } }, "schema": { "$ref": "#/components/schemas/v2GetFunctionsResponse" } } }, "description": "A successful response." } }, "security": [ { "BearerAuth": [] } ], "summary": "Get functions", "tags": [ "Functions" ], "x-beta": true } }, "/apps/{appId}/functions/{functionId}": { "get": { "description": "Fetches function configuration and status details for a function within an app", "operationId": "V2_GetFunction", "parameters": [ { "in": "path", "name": "appId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "functionId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2GetFunctionResponse" } } }, "description": "A successful response." } }, "security": [ { "BearerAuth": [] } ], "summary": "Get function", "tags": [ "Functions" ], "x-beta": true } }, "/apps/{appId}/functions/{functionId}/experiments": { "get": { "description": "Lists observed experiments for one function in the authenticated environment.", "operationId": "V2_ListExperiments2", "parameters": [ { "in": "path", "name": "appId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "functionId", "required": true, "schema": { "type": "string" } }, { "description": "Pagination cursor from previous response", "in": "query", "name": "cursor", "schema": { "type": "string" } }, { "description": "Number of experiments to return per page (min: 1, max: 100)", "in": "query", "name": "limit", "schema": { "default": "20", "format": "int32", "type": "integer" } }, { "in": "query", "name": "from", "schema": { "format": "date-time", "type": "string" } }, { "in": "query", "name": "until", "schema": { "format": "date-time", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ListExperimentsResponse" } } }, "description": "A successful response." } }, "security": [ { "BearerAuth": [] } ], "summary": "List experiments for a function", "tags": [ "Experiments" ], "x-beta": true } }, "/apps/{appId}/functions/{functionId}/experiments/{experimentId}": { "get": { "description": "Fetches variant run counts and score aggregates for one experiment on one function.", "operationId": "V2_GetExperiment", "parameters": [ { "in": "path", "name": "appId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "functionId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "experimentId", "required": true, "schema": { "pattern": ".+", "type": "string" } }, { "description": "Optional variant name to restrict the aggregate response.", "in": "query", "name": "variant", "schema": { "type": "string" } }, { "in": "query", "name": "from", "schema": { "format": "date-time", "type": "string" } }, { "in": "query", "name": "until", "schema": { "format": "date-time", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2GetExperimentResponse" } } }, "description": "A successful response." } }, "security": [ { "BearerAuth": [] } ], "summary": "Get experiment aggregates", "tags": [ "Experiments" ], "x-beta": true } }, "/apps/{appId}/functions/{functionId}/invoke": { "post": { "description": "Invokes a function, executing the function either asynchronously or synchronously based on the mode parameter in the request body", "operationId": "V2_InvokeFunction", "parameters": [ { "description": "The ID of the app containing the function", "in": "path", "name": "appId", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the function to invoke", "in": "path", "name": "functionId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2InvokeFunctionBody" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2InvokeFunctionResponse" } } }, "description": "Function invoked asynchronously" }, "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2InvokeFunctionResponse" } } }, "description": "Function invoked synchronously but has not yet finished executing" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ErrorResponse" } } }, "description": "Bad Request - invalid input data" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ErrorResponse" } } }, "description": "Unauthorized - authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ErrorResponse" } } }, "description": "Forbidden - insufficient permissions" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ErrorResponse" } } }, "description": "Not Found - function not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2InvokeFunctionResponse" } } }, "description": "Conflict - this function has already been invoked using the given idempotency key. Note that this returns the previously invoked run's data." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ErrorResponse" } } }, "description": "Unprocessable Entity - function was rate limited, debounced, skipped, or otherwise could not be invoked" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ErrorResponse" } } }, "description": "Too Many Requests - API rate limit exceeded. The request was entirely rejected, and no function was invoked." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "BearerAuth": [] } ], "summary": "Invoke function", "tags": [ "Functions" ] } }, "/apps/{appId}/functions/{functionId}/runs": { "get": { "description": "Lists runs for one function in the authenticated environment", "operationId": "V2_ListFunctionRuns", "parameters": [ { "in": "path", "name": "appId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "functionId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "includeOutput", "schema": { "type": "boolean" } }, { "description": "Pagination cursor from previous response", "in": "query", "name": "cursor", "schema": { "type": "string" } }, { "description": "Number of runs to return per page (min: 1, max: 100)", "in": "query", "name": "limit", "schema": { "default": "20", "format": "int32", "type": "integer" } }, { "description": "Inclusive start of the run time range", "in": "query", "name": "from", "schema": { "format": "date-time", "type": "string" } }, { "description": "Inclusive end of the run time range", "in": "query", "name": "until", "schema": { "format": "date-time", "type": "string" } }, { "description": "Run timestamp field used for filtering and ordering. Accepts queuedAt, startedAt, or endedAt. Snake case aliases such as QUEUED_AT, STARTED_AT, and ENDED_AT are also accepted.", "in": "query", "name": "timeField", "schema": { "default": "queuedAt", "type": "string" } }, { "description": "Statuses to include, using response status values such as COMPLETED, FAILED, RUNNING, QUEUED, CANCELLED, SKIPPED, or PAUSED", "in": "query", "name": "status", "schema": { "items": { "type": "string" }, "type": "array" } }, { "description": "Whether to include only deferred or non-deferred runs", "in": "query", "name": "isDeferred", "schema": { "type": "boolean" } }, { "description": "Sort direction. Accepts ASC or DESC.", "in": "query", "name": "order", "schema": { "default": "DESC", "type": "string" } }, { "description": "CEL expression used to filter runs by event, output, or error data", "in": "query", "name": "query", "schema": { "type": "string" } }, { "description": "Optional run expansions. Supported values: deferred_from.", "in": "query", "name": "include", "schema": { "items": { "type": "string" }, "type": "array" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ListFunctionRunsResponse" } } }, "description": "A successful response." } }, "security": [ { "BearerAuth": [] } ], "summary": "List runs for a function", "tags": [ "Runs" ], "x-beta": true } }, "/apps/{appId}/syncs": { "post": { "description": "Sync an app at the provided URL.", "operationId": "V2_SyncApp", "parameters": [ { "description": "App ID", "in": "path", "name": "appId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2SyncAppBody" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2SyncAppResponse" } } }, "description": "App sync completed successfully or the app was already up to date" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ErrorResponse" } } }, "description": "Bad Request - invalid input data" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ErrorResponse" } } }, "description": "Unauthorized - authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ErrorResponse" } } }, "description": "Forbidden - insufficient permissions" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ErrorResponse" } } }, "description": "Not Found - environment not found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2SyncAppResponse" } } }, "description": "Unprocessable Entity - sync failed. The response body is still SyncAppResponse and includes the persisted deploy plus a coded error under data.latestSync.error." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "BearerAuth": [] } ], "summary": "Sync app", "tags": [ "Apps" ], "x-beta": true } }, "/env/webhooks": { "get": { "description": "Lists all webhooks in the specified environment", "operationId": "V2_ListWebhooks", "parameters": [ { "description": "Pagination cursor from previous response", "in": "query", "name": "cursor", "schema": { "type": "string" } }, { "description": "Number of webhooks to return per page (min: 1, max: 100)", "in": "query", "name": "limit", "schema": { "default": "20", "format": "int32", "type": "integer" } }, { "description": "Target environment for the webhooks (e.g., 'production', 'staging', 'development')", "in": "header", "name": "X-Inngest-Env", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ListWebhooksResponse" } } }, "description": "List of webhooks" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ErrorResponse" } } }, "description": "Bad Request - invalid query parameters" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ErrorResponse" } } }, "description": "Unauthorized - authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ErrorResponse" } } }, "description": "Forbidden - insufficient permissions" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "BearerAuth": [] } ], "summary": "List webhooks", "tags": [ "Webhooks" ] }, "post": { "description": "Creates a new webhook for receiving events", "operationId": "V2_CreateWebhook", "parameters": [ { "description": "Target environment for the webhook (e.g., 'production', 'staging', 'development')", "in": "header", "name": "X-Inngest-Env", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2CreateWebhookRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2CreateWebhookResponse" } } }, "description": "Webhook successfully created" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ErrorResponse" } } }, "description": "Bad Request - invalid input data" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ErrorResponse" } } }, "description": "Unauthorized - authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ErrorResponse" } } }, "description": "Forbidden - insufficient permissions" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ErrorResponse" } } }, "description": "Conflict - webhook with same URL already exists" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ErrorResponse" } } }, "description": "Unprocessable Entity - business logic validation failed" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "BearerAuth": [] } ], "summary": "Create webhook", "tags": [ "Webhooks" ] } }, "/envs": { "get": { "description": "List of all custom environments.", "operationId": "V2_FetchAccountEnvs", "parameters": [ { "description": "Pagination cursor from previous response", "in": "query", "name": "cursor", "schema": { "type": "string" } }, { "description": "Number of environments to return per page (min: 1, max: 250)", "in": "query", "name": "limit", "schema": { "default": "50", "format": "int32", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "default": { "value": { "data": [ { "createdAt": "2024-01-10T09:15:00Z", "id": "a1b2c3d4-e5f6-4789-abc1-234567890def", "name": "production", "type": "PRODUCTION" }, { "createdAt": "2024-01-12T11:30:00Z", "id": "b2c3d4e5-f6a7-4890-bcd2-34567890abef", "name": "staging", "type": "TEST" } ], "metadata": { "cachedUntil": null, "fetchedAt": "2024-01-20T14:22:33Z" }, "page": { "hasMore": false, "limit": 50 } } } }, "schema": { "$ref": "#/components/schemas/v2FetchAccountEnvsResponse" } } }, "description": "List of account environments" }, "400": { "content": { "application/json": { "examples": { "default": { "value": { "errors": [ { "code": "missing_field", "message": "Environment name is required" } ] } } }, "schema": { "$ref": "#/components/schemas/v2ErrorResponse" } } }, "description": "Bad Request - invalid query parameters" }, "401": { "content": { "application/json": { "examples": { "default": { "value": "Authentication failed" } }, "schema": { "$ref": "#/components/schemas/v2ErrorResponse" } } }, "description": "Unauthorized - authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ErrorResponse" } } }, "description": "Forbidden - insufficient permissions" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ErrorResponse" } } }, "description": "Not Found - account not found" }, "500": { "content": { "application/json": { "examples": { "default": { "value": { "errors": [ { "code": "internal_error", "message": "Something went wrong" } ] } } }, "schema": { "$ref": "#/components/schemas/v2ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "BearerAuth": [] } ], "summary": "List environments", "tags": [ "Environments" ] }, "post": { "description": "Create custom environment", "operationId": "V2_CreateEnv", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2CreateEnvRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "201": { "content": { "application/json": { "examples": { "default": { "value": { "data": { "createdAt": "2024-01-20T14:22:33Z", "id": "c3d4e5f6-a7b8-4901-cde3-4567890bcfa0", "name": "development", "type": "BRANCH" }, "metadata": { "cachedUntil": null, "fetchedAt": "2024-01-20T14:22:33Z" } } } }, "schema": { "$ref": "#/components/schemas/v2CreateEnvResponse" } } }, "description": "Env successfully created" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ErrorResponse" } } }, "description": "Bad Request - invalid input data" }, "401": { "content": { "application/json": { "examples": { "default": { "value": "Authentication failed" } }, "schema": { "$ref": "#/components/schemas/v2ErrorResponse" } } }, "description": "Unauthorized - authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ErrorResponse" } } }, "description": "Forbidden - Insufficient permissions" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ErrorResponse" } } }, "description": "Conflict - account already exists" }, "500": { "content": { "application/json": { "examples": { "default": { "value": { "errors": [ { "code": "internal_error", "message": "Something went wrong" } ] } } }, "schema": { "$ref": "#/components/schemas/v2ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "BearerAuth": [] } ], "summary": "Create environment", "tags": [ "Environments" ] } }, "/envs/{id}": { "patch": { "description": "Partially updates an environment. Only the provided fields will be modified.", "operationId": "V2_PatchEnv", "parameters": [ { "description": "The ID of the environment to update", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2PatchEnvBody" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2PatchEnvsResponse" } } }, "description": "Environment successfully updated" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ErrorResponse" } } }, "description": "Bad Request - invalid input data" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ErrorResponse" } } }, "description": "Unauthorized - authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ErrorResponse" } } }, "description": "Forbidden - insufficient permissions" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ErrorResponse" } } }, "description": "Not Found - environment not found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ErrorResponse" } } }, "description": "Unprocessable Entity - business logic validation failed" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "BearerAuth": [] } ], "summary": "Update environment", "tags": [ "Environments" ] } }, "/events": { "post": { "description": "Sends one event for testing and debugging. The request accepts the name, data, user, id, and ts fields; send batches and other Event API fields through an Inngest SDK or the Event API. This endpoint uses REST API rate limits and is not intended for high-volume ingestion. Use the returned event ID with the event runs endpoint to inspect any function runs triggered by the event.", "operationId": "V2_SendEvent", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2SendEventRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "examples": { "default": { "value": { "data": { "eventId": "01K1QQ3VQ8R3M8QX4D51J8G7XH" }, "metadata": { "fetchedAt": "2026-08-06T16:00:00Z" } } } }, "schema": { "$ref": "#/components/schemas/v2SendEventResponse" } } }, "description": "Event accepted" }, "400": { "content": { "application/json": { "examples": { "default": { "value": { "errors": [ { "code": "validation_error", "message": "timestamp is before Jan 1, 1980" } ] } } }, "schema": { "$ref": "#/components/schemas/v2ErrorResponse" } } }, "description": "Bad Request - invalid event data" }, "401": { "content": { "application/json": { "examples": { "default": { "value": { "errors": [ { "code": "authorization_header_missing", "message": "authorization header missing or invalid" } ] } } }, "schema": { "$ref": "#/components/schemas/v2ErrorResponse" } } }, "description": "Unauthorized - authentication required" }, "403": { "content": { "application/json": { "examples": { "default": { "value": { "errors": [ { "code": "access_denied", "message": "Cannot send events to an archived environment" } ] } } }, "schema": { "$ref": "#/components/schemas/v2ErrorResponse" } } }, "description": "Forbidden - events cannot be sent to the selected environment" }, "413": { "content": { "application/json": { "examples": { "default": { "value": { "errors": [ { "code": "invalid_request", "message": "Request body cannot exceed 3145728 bytes" } ] } } }, "schema": { "$ref": "#/components/schemas/v2ErrorResponse" } } }, "description": "Payload Too Large - request body exceeds the endpoint limit" }, "429": { "content": { "application/json": { "examples": { "default": { "value": { "errors": [ { "code": "rate_limited", "message": "API rate limit exceeded. The request was rejected and no event was sent." } ] } } }, "schema": { "$ref": "#/components/schemas/v2ErrorResponse" } } }, "description": "Too Many Requests - API rate limit exceeded. The request was rejected and no event was sent." }, "500": { "content": { "application/json": { "examples": { "default": { "value": { "errors": [ { "code": "internal_error", "message": "Unable to send event" } ] } } }, "schema": { "$ref": "#/components/schemas/v2ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "BearerAuth": [] } ], "summary": "Send event", "tags": [ "Events" ] } }, "/events/{eventId}/runs": { "get": { "description": "Lists function runs triggered by a specific event", "operationId": "V2_GetEventRuns", "parameters": [ { "in": "path", "name": "eventId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "includeOutput", "schema": { "type": "boolean" } }, { "description": "Pagination cursor from previous response", "in": "query", "name": "cursor", "schema": { "type": "string" } }, { "description": "Number of runs to return per page (min: 1, max: 40)", "in": "query", "name": "limit", "schema": { "default": "20", "format": "int32", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2GetEventRunsResponse" } } }, "description": "A successful response." } }, "security": [ { "BearerAuth": [] } ], "summary": "Get event runs", "tags": [ "Runs" ], "x-beta": true } }, "/experiments": { "get": { "description": "Lists observed experiments in the authenticated environment. Use the nested app and function route to scope results to one function.", "operationId": "V2_ListExperiments", "parameters": [ { "description": "Pagination cursor from previous response", "in": "query", "name": "cursor", "schema": { "type": "string" } }, { "description": "Number of experiments to return per page (min: 1, max: 100)", "in": "query", "name": "limit", "schema": { "default": "20", "format": "int32", "type": "integer" } }, { "in": "query", "name": "appId", "schema": { "type": "string" } }, { "in": "query", "name": "functionId", "schema": { "type": "string" } }, { "in": "query", "name": "from", "schema": { "format": "date-time", "type": "string" } }, { "in": "query", "name": "until", "schema": { "format": "date-time", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ListExperimentsResponse" } } }, "description": "A successful response." } }, "security": [ { "BearerAuth": [] } ], "summary": "List experiments", "tags": [ "Experiments" ], "x-beta": true } }, "/insights/events/schemas": { "get": { "description": "Returns a paginated list of event type schemas, where each schema describes the shape of a specific event's data as nested JSON.", "operationId": "V2_ListInsightsEventSchemas", "parameters": [ { "description": "Pagination cursor from previous response", "in": "query", "name": "cursor", "schema": { "type": "string" } }, { "description": "Number of event schemas to return per page (min: 1, max: 100)", "in": "query", "name": "limit", "schema": { "default": "20", "format": "int32", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ListInsightsEventSchemasResponse" } } }, "description": "Paginated list of event type schemas" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ErrorResponse" } } }, "description": "Bad Request - invalid query parameters" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ErrorResponse" } } }, "description": "Unauthorized - authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ErrorResponse" } } }, "description": "Forbidden - insufficient permissions" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "BearerAuth": [] } ], "summary": "List event type schemas", "tags": [ "Insights" ], "x-beta": true } }, "/insights/query": { "post": { "description": "Query Insights using the provided SQL query.", "operationId": "V2_QueryInsights", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2QueryInsightsRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2QueryInsightsResponse" } } }, "description": "Query executed successfully" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ErrorResponse" } } }, "description": "Bad Request - invalid input data" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ErrorResponse" } } }, "description": "Unauthorized - authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ErrorResponse" } } }, "description": "Forbidden - insufficient permissions" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ErrorResponse" } } }, "description": "Not Found - environment not found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ErrorResponse" } } }, "description": "Unprocessable Entity - Query validation or execution failed." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "BearerAuth": [] } ], "summary": "Query insights", "tags": [ "Insights" ], "x-beta": true } }, "/insights/query/prompt": { "post": { "description": "Translates a natural language prompt into an Insights SQL query.", "operationId": "V2_QueryInsightsPrompt", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2QueryInsightsPromptRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2QueryInsightsPromptResponse" } } }, "description": "Query generated successfully" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ErrorResponse" } } }, "description": "Bad Request - invalid input data" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ErrorResponse" } } }, "description": "Unauthorized - authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ErrorResponse" } } }, "description": "Forbidden - insufficient permissions" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ErrorResponse" } } }, "description": "Unprocessable Entity - prompt could not be translated into a valid query" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "BearerAuth": [] } ], "summary": "Generate insights query from prompt", "tags": [ "Insights" ], "x-beta": true } }, "/insights/tables": { "get": { "description": "Lists the available tables that can be queried via the Insights query endpoint.", "operationId": "V2_ListInsightsTables", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ListInsightsTablesResponse" } } }, "description": "List of available insights tables" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ErrorResponse" } } }, "description": "Unauthorized - authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ErrorResponse" } } }, "description": "Forbidden - insufficient permissions" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "BearerAuth": [] } ], "summary": "List insights tables", "tags": [ "Insights" ], "x-beta": true } }, "/keys/events": { "get": { "description": "Lists event keys for a specific account, optionally filtered by environment. If the environment header isn't specified, this returns the default production environment's keys.", "operationId": "V2_FetchAccountEventKeys", "parameters": [ { "description": "Pagination cursor from previous response", "in": "query", "name": "cursor", "schema": { "type": "string" } }, { "description": "Number of event keys to return per page (min: 1, max: 100)", "in": "query", "name": "limit", "schema": { "default": "20", "format": "int32", "type": "integer" } }, { "description": "Filter event keys by environment (e.g., 'production', 'staging', 'development')", "in": "header", "name": "X-Inngest-Env", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "default": { "value": { "data": [ { "createdAt": "2024-01-15T10:30:00Z", "environment": "production", "id": "d4e5f6a7-b8c9-4012-def4-567890cdab12", "key": "inngest-event-key-prod-abc123", "name": "Production Event Key" }, { "createdAt": "2024-01-18T14:22:33Z", "environment": "staging", "id": "e5f6a7b8-c9d0-4123-efa5-67890dbc1234", "key": "inngest-event-key-stage-def456", "name": "Staging Event Key" } ], "metadata": { "cachedUntil": null, "fetchedAt": "2024-01-20T14:22:33Z" }, "page": { "cursor": "01K3SB60E36ZMPEV43BG0H20MW", "hasMore": true, "limit": 20 } } } }, "schema": { "$ref": "#/components/schemas/v2FetchAccountEventKeysResponse" } } }, "description": "List of account event keys" }, "400": { "content": { "application/json": { "examples": { "default": { "value": { "errors": [ { "code": "invalid_field_format", "message": "Limit must be at least 1" } ] } } }, "schema": { "$ref": "#/components/schemas/v2ErrorResponse" } } }, "description": "Bad Request - invalid query parameters" }, "401": { "content": { "application/json": { "examples": { "default": { "value": "Authentication failed" } }, "schema": { "$ref": "#/components/schemas/v2ErrorResponse" } } }, "description": "Unauthorized - authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ErrorResponse" } } }, "description": "Forbidden - insufficient permissions" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ErrorResponse" } } }, "description": "Not Found - account not found" }, "500": { "content": { "application/json": { "examples": { "default": { "value": { "errors": [ { "code": "internal_error", "message": "Something went wrong" } ] } } }, "schema": { "$ref": "#/components/schemas/v2ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "BearerAuth": [] } ], "summary": "List account event keys", "tags": [ "Keys" ] } }, "/keys/signing": { "get": { "description": "Lists signing keys for a specific account, optionally filtered by environment. If the environment header isn't specified, this returns the default production environment's keys.", "operationId": "V2_FetchAccountSigningKeys", "parameters": [ { "description": "Pagination cursor from previous response", "in": "query", "name": "cursor", "schema": { "type": "string" } }, { "description": "Number of signing keys to return per page (min: 1, max: 100)", "in": "query", "name": "limit", "schema": { "default": "20", "format": "int32", "type": "integer" } }, { "description": "Filter signing keys by environment (e.g., 'production', 'staging', 'development')", "in": "header", "name": "X-Inngest-Env", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "default": { "value": { "data": [ { "createdAt": "2024-01-15T10:30:00Z", "environment": "production", "id": "f6a7b8c9-d0e1-4234-fab6-7890ecd23456", "key": "signkey-prod-abc123def456", "name": "" } ], "metadata": { "cachedUntil": null, "fetchedAt": "2024-01-20T14:22:33Z" }, "page": { "cursor": null, "hasMore": false, "limit": 20 } } } }, "schema": { "$ref": "#/components/schemas/v2FetchAccountSigningKeysResponse" } } }, "description": "List of account signing keys" }, "400": { "content": { "application/json": { "examples": { "default": { "value": { "errors": [ { "code": "invalid_field_format", "message": "Limit must be at least 1" } ] } } }, "schema": { "$ref": "#/components/schemas/v2ErrorResponse" } } }, "description": "Bad Request - invalid query parameters" }, "401": { "content": { "application/json": { "examples": { "default": { "value": "Authentication failed" } }, "schema": { "$ref": "#/components/schemas/v2ErrorResponse" } } }, "description": "Unauthorized - authentication required" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ErrorResponse" } } }, "description": "Forbidden - insufficient permissions" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ErrorResponse" } } }, "description": "Not Found - account not found" }, "500": { "content": { "application/json": { "examples": { "default": { "value": { "errors": [ { "code": "internal_error", "message": "Something went wrong" } ] } } }, "schema": { "$ref": "#/components/schemas/v2ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "BearerAuth": [] } ], "summary": "List account signing keys", "tags": [ "Keys" ] } }, "/partner/accounts": { "get": { "description": "Lists sub-accounts (if you have partner access)", "operationId": "V2_FetchPartnerAccounts", "parameters": [ { "description": "Pagination cursor from previous response", "in": "query", "name": "cursor", "schema": { "type": "string" } }, { "description": "Number of accounts to return per page (min: 1, max: 1000)", "in": "query", "name": "limit", "schema": { "default": "20", "format": "int32", "maximum": 1000, "minimum": 1, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "default": { "value": { "data": [ { "createdAt": "2024-01-15T10:30:00Z", "email": "partner1@company.com", "id": "a7b8c9d0-e1f2-4345-abc7-890fed345678", "name": "Partner Account 1", "updatedAt": "2024-01-15T10:30:00Z" }, { "createdAt": "2024-01-18T14:22:33Z", "email": "partner2@company.com", "id": "b8c9d0e1-f2a3-4456-bcd8-90aef4567890", "name": "Partner Account 2", "updatedAt": "2024-01-18T14:22:33Z" } ], "metadata": { "cachedUntil": null, "fetchedAt": "2024-01-20T14:22:33Z" }, "page": { "cursor": "01K3SB60E36ZMPEV43BG0H20MW", "hasMore": true, "limit": 2 } } } }, "schema": { "$ref": "#/components/schemas/v2FetchAccountsResponse" } } }, "description": "List of accounts" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ErrorResponse" } } }, "description": "Bad Request - invalid query parameters" }, "401": { "content": { "application/json": { "examples": { "default": { "value": { "errors": [ { "code": "access_denied", "message": "You do not have access to the partner API. Please reach out to sales@inngest.com to gain access." } ] } } }, "schema": { "$ref": "#/components/schemas/v2ErrorResponse" } } }, "description": "Unauthorized - authentication required" }, "403": { "content": { "application/json": { "examples": { "default": { "value": { "errors": [ { "code": "access_denied", "message": "You do not have access to the partner API. Please reach out to sales@inngest.com to gain access." } ] } } }, "schema": { "$ref": "#/components/schemas/v2ErrorResponse" } } }, "description": "Forbidden - insufficient permissions" }, "500": { "content": { "application/json": { "examples": { "default": { "value": { "errors": [ { "code": "internal_error", "message": "Something went wrong" } ] } } }, "schema": { "$ref": "#/components/schemas/v2ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "BearerAuth": [] } ], "summary": "List partner accounts", "tags": [ "Partner API" ] }, "post": { "description": "Creates a sub-account (if you have partner access)", "operationId": "V2_CreatePartnerAccount", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2CreateAccountRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "201": { "content": { "application/json": { "examples": { "default": { "value": { "data": { "apiKey": "api-abcdef1234567890", "createdAt": "2024-01-20T14:22:33Z", "email": "user@example.com", "id": "c9d0e1f2-a3b4-4567-cde9-01bfa5678901", "name": "Jane Smith", "updatedAt": "2024-01-20T14:22:33Z" }, "metadata": { "cachedUntil": null, "fetchedAt": "2024-01-20T14:22:33Z" } } } }, "schema": { "$ref": "#/components/schemas/v2CreateAccountResponse" } } }, "description": "Account successfully created" }, "400": { "content": { "application/json": { "examples": { "default": { "value": { "errors": [ { "code": "validation_error", "message": "Email is required" } ] } } }, "schema": { "$ref": "#/components/schemas/v2ErrorResponse" } } }, "description": "Bad Request - invalid input data" }, "401": { "content": { "application/json": { "examples": { "default": { "value": { "errors": [ { "code": "access_denied", "message": "You do not have access to the partner API. Please reach out to sales@inngest.com to gain access." } ] } } }, "schema": { "$ref": "#/components/schemas/v2ErrorResponse" } } }, "description": "Unauthorized - authentication required" }, "403": { "content": { "application/json": { "examples": { "default": { "value": { "errors": [ { "code": "access_denied", "message": "You do not have access to the partner API. Please reach out to sales@inngest.com to gain access." } ] } } }, "schema": { "$ref": "#/components/schemas/v2ErrorResponse" } } }, "description": "Forbidden - Insufficient permissions" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ErrorResponse" } } }, "description": "Conflict - account already exists" }, "500": { "content": { "application/json": { "examples": { "default": { "value": { "errors": [ { "code": "internal_error", "message": "Something went wrong" } ] } } }, "schema": { "$ref": "#/components/schemas/v2ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "BearerAuth": [] } ], "summary": "Create partner account", "tags": [ "Partner API" ] } }, "/runs": { "get": { "description": "Lists runs in the authenticated environment, optionally filtered by app and function IDs", "operationId": "V2_ListRuns", "parameters": [ { "in": "query", "name": "includeOutput", "schema": { "type": "boolean" } }, { "description": "Pagination cursor from previous response", "in": "query", "name": "cursor", "schema": { "type": "string" } }, { "description": "Number of runs to return per page (min: 1, max: 100)", "in": "query", "name": "limit", "schema": { "default": "20", "format": "int32", "type": "integer" } }, { "description": "Inclusive start of the run time range", "in": "query", "name": "from", "schema": { "format": "date-time", "type": "string" } }, { "description": "Inclusive end of the run time range", "in": "query", "name": "until", "schema": { "format": "date-time", "type": "string" } }, { "description": "Run timestamp field used for filtering and ordering. Accepts queuedAt, startedAt, or endedAt. Snake case aliases such as QUEUED_AT, STARTED_AT, and ENDED_AT are also accepted.", "in": "query", "name": "timeField", "schema": { "default": "queuedAt", "type": "string" } }, { "description": "Statuses to include, using response status values such as COMPLETED, FAILED, RUNNING, QUEUED, CANCELLED, SKIPPED, or PAUSED", "in": "query", "name": "status", "schema": { "items": { "type": "string" }, "type": "array" } }, { "description": "App IDs to include", "in": "query", "name": "appId", "schema": { "items": { "type": "string" }, "type": "array" } }, { "description": "Function IDs to include", "in": "query", "name": "functionId", "schema": { "items": { "type": "string" }, "type": "array" } }, { "description": "Whether to include only deferred or non-deferred runs", "in": "query", "name": "isDeferred", "schema": { "type": "boolean" } }, { "description": "Sort direction. Accepts ASC or DESC.", "in": "query", "name": "order", "schema": { "default": "DESC", "type": "string" } }, { "description": "CEL expression used to filter runs by event, output, or error data", "in": "query", "name": "query", "schema": { "type": "string" } }, { "description": "Optional run expansions. Supported values: deferred_from.", "in": "query", "name": "include", "schema": { "items": { "type": "string" }, "type": "array" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ListRunsResponse" } } }, "description": "A successful response." } }, "security": [ { "BearerAuth": [] } ], "summary": "List runs", "tags": [ "Runs" ], "x-beta": true } }, "/runs/{runId}": { "get": { "description": "Fetches the canonical run summary for a single function run", "operationId": "V2_GetFunctionRun", "parameters": [ { "in": "path", "name": "runId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "includeOutput", "schema": { "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2GetFunctionRunResponse" } } }, "description": "A successful response." } }, "security": [ { "BearerAuth": [] } ], "summary": "Get function run", "tags": [ "Runs" ], "x-beta": true } }, "/runs/{runId}/cancel": { "post": { "description": "Cancels an in-progress function run", "operationId": "V2_CancelRun", "parameters": [ { "in": "path", "name": "runId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2CancelRunBody" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2CancelRunResponse" } } }, "description": "A successful response." } }, "security": [ { "BearerAuth": [] } ], "summary": "Cancel function run", "tags": [ "Runs" ], "x-beta": true } }, "/runs/{runId}/rerun": { "post": { "description": "Creates a new run using the original run's triggering event data", "operationId": "V2_Rerun", "parameters": [ { "in": "path", "name": "runId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2RerunBody" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2RerunResponse" } } }, "description": "A successful response." } }, "security": [ { "BearerAuth": [] } ], "summary": "Rerun function run", "tags": [ "Runs" ], "x-beta": true } }, "/runs/{runId}/scores": { "post": { "description": "Submits one or more named scores for a function run, or for specific steps when step IDs are provided. Scores are recorded as run metadata and aggregated for experiments.", "operationId": "V2_CreateScore", "parameters": [ { "description": "Run ID (ULID) of the function run to score", "in": "path", "name": "runId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/v2CreateScoreInput" }, "type": "array" } } }, "required": true, "x-originalParamName": "scores" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2CreateScoreResponse" } } }, "description": "A successful response." } }, "security": [ { "BearerAuth": [] } ], "summary": "Create score", "tags": [ "Runs" ], "x-beta": true } }, "/runs/{runId}/trace": { "get": { "description": "Fetches the trace tree for a single function run", "operationId": "V2_GetFunctionTrace", "parameters": [ { "in": "path", "name": "runId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "includeOutput", "schema": { "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2GetFunctionTraceResponse" } } }, "description": "A successful response." } }, "security": [ { "BearerAuth": [] } ], "summary": "Get function trace", "tags": [ "Runs" ], "x-beta": true } }, "/sandboxes": { "get": { "operationId": "V2_ListSandboxes", "parameters": [ { "in": "query", "name": "cursor", "schema": { "type": "string" } }, { "in": "query", "name": "limit", "schema": { "format": "int32", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ListSandboxesResponse" } } }, "description": "A successful response." } }, "security": [ { "BearerAuth": [] } ], "summary": "List sandboxes", "tags": [ "Sandboxes" ], "x-beta": true }, "post": { "operationId": "V2_CreateSandbox", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2CreateSandboxRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2CreateSandboxResponse" } } }, "description": "A successful response." } }, "security": [ { "BearerAuth": [] } ], "summary": "Create a sandbox", "tags": [ "Sandboxes" ], "x-beta": true } }, "/sandboxes/{sandboxId}": { "delete": { "operationId": "V2_DestroySandbox", "parameters": [ { "in": "path", "name": "sandboxId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2DestroySandboxResponse" } } }, "description": "A successful response." } }, "security": [ { "BearerAuth": [] } ], "summary": "Destroy a sandbox", "tags": [ "Sandboxes" ], "x-beta": true }, "get": { "operationId": "V2_GetSandbox", "parameters": [ { "in": "path", "name": "sandboxId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2GetSandboxResponse" } } }, "description": "A successful response." } }, "security": [ { "BearerAuth": [] } ], "summary": "Get a sandbox", "tags": [ "Sandboxes" ], "x-beta": true } }, "/sandboxes/{sandboxId}/exec": { "post": { "operationId": "V2_ExecSandbox", "parameters": [ { "in": "path", "name": "sandboxId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2ExecSandboxBody" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ExecSandboxResponse" } } }, "description": "A successful response." } }, "security": [ { "BearerAuth": [] } ], "summary": "Execute a command in a sandbox", "tags": [ "Sandboxes" ], "x-beta": true } }, "/sandboxes/{sandboxId}/files": { "get": { "operationId": "V2_ReadSandboxFile", "parameters": [ { "in": "path", "name": "sandboxId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "path", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "format": "binary", "title": "Free form byte stream", "type": "string" } } }, "description": "A successful response.(streaming responses)" } }, "security": [ { "BearerAuth": [] } ], "summary": "Read a sandbox file", "tags": [ "Sandboxes" ], "x-beta": true }, "put": { "operationId": "V2_WriteSandboxFile", "parameters": [ { "in": "path", "name": "sandboxId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "path", "schema": { "type": "string" } }, { "in": "query", "name": "mode", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/apiHttpBody" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2WriteSandboxFileResponse" } } }, "description": "A successful response." } }, "security": [ { "BearerAuth": [] } ], "summary": "Write a sandbox file", "tags": [ "Sandboxes" ], "x-beta": true } }, "/sandboxes/{sandboxId}/logs": { "get": { "operationId": "V2_StreamSandboxLogs", "parameters": [ { "in": "path", "name": "sandboxId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "follow", "schema": { "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "error": { "$ref": "#/components/schemas/rpcStatus" }, "result": { "$ref": "#/components/schemas/v2StreamSandboxLogsResponse" } }, "title": "Stream result of v2StreamSandboxLogsResponse", "type": "object" } } }, "description": "A successful response.(streaming responses)" } }, "security": [ { "BearerAuth": [] } ], "summary": "Stream sandbox logs", "tags": [ "Sandboxes" ], "x-beta": true } }, "/sandboxes/{sandboxId}/pause": { "post": { "operationId": "V2_PauseSandbox", "parameters": [ { "in": "path", "name": "sandboxId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2PauseSandboxResponse" } } }, "description": "A successful response." } }, "security": [ { "BearerAuth": [] } ], "summary": "Pause a sandbox", "tags": [ "Sandboxes" ], "x-beta": true } }, "/sandboxes/{sandboxId}/processes": { "get": { "operationId": "V2_ListSandboxProcesses", "parameters": [ { "in": "path", "name": "sandboxId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "cursor", "schema": { "type": "string" } }, { "in": "query", "name": "limit", "schema": { "format": "int32", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ListSandboxProcessesResponse" } } }, "description": "A successful response." } }, "security": [ { "BearerAuth": [] } ], "summary": "List sandbox processes", "tags": [ "Sandboxes" ], "x-beta": true }, "post": { "operationId": "V2_StartSandboxProcess", "parameters": [ { "in": "path", "name": "sandboxId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2StartSandboxProcessBody" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2StartSandboxProcessResponse" } } }, "description": "A successful response." } }, "security": [ { "BearerAuth": [] } ], "summary": "Start a sandbox process", "tags": [ "Sandboxes" ], "x-beta": true } }, "/sandboxes/{sandboxId}/processes/{processId}": { "get": { "operationId": "V2_GetSandboxProcess", "parameters": [ { "in": "path", "name": "sandboxId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "processId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2GetSandboxProcessResponse" } } }, "description": "A successful response." } }, "security": [ { "BearerAuth": [] } ], "summary": "Get a sandbox process", "tags": [ "Sandboxes" ], "x-beta": true } }, "/sandboxes/{sandboxId}/processes/{processId}/output": { "get": { "operationId": "V2_GetSandboxProcessOutput", "parameters": [ { "in": "path", "name": "sandboxId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "processId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "tailBytes", "schema": { "format": "int64", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2GetSandboxProcessOutputResponse" } } }, "description": "A successful response." } }, "security": [ { "BearerAuth": [] } ], "summary": "Get sandbox process output", "tags": [ "Sandboxes" ], "x-beta": true } }, "/sandboxes/{sandboxId}/processes/{processId}/output/stream": { "get": { "operationId": "V2_StreamSandboxProcessOutput", "parameters": [ { "in": "path", "name": "sandboxId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "processId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "tailBytes", "schema": { "format": "int64", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "error": { "$ref": "#/components/schemas/rpcStatus" }, "result": { "$ref": "#/components/schemas/v2StreamSandboxProcessOutputResponse" } }, "title": "Stream result of v2StreamSandboxProcessOutputResponse", "type": "object" } } }, "description": "A successful response.(streaming responses)" } }, "security": [ { "BearerAuth": [] } ], "summary": "Stream sandbox process output", "tags": [ "Sandboxes" ], "x-beta": true } }, "/sandboxes/{sandboxId}/processes/{processId}/signals": { "post": { "operationId": "V2_SignalSandboxProcess", "parameters": [ { "in": "path", "name": "sandboxId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "processId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2SignalSandboxProcessBody" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2SignalSandboxProcessResponse" } } }, "description": "A successful response." } }, "security": [ { "BearerAuth": [] } ], "summary": "Signal a sandbox process", "tags": [ "Sandboxes" ], "x-beta": true } }, "/sandboxes/{sandboxId}/processes/{processId}/wait": { "post": { "operationId": "V2_WaitSandboxProcess", "parameters": [ { "in": "path", "name": "sandboxId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "processId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "timeout", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2WaitSandboxProcessResponse" } } }, "description": "A successful response." } }, "security": [ { "BearerAuth": [] } ], "summary": "Wait for a sandbox process", "tags": [ "Sandboxes" ], "x-beta": true } }, "/sandboxes/{sandboxId}/resume": { "post": { "operationId": "V2_ResumeSandbox", "parameters": [ { "in": "path", "name": "sandboxId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ResumeSandboxResponse" } } }, "description": "A successful response." } }, "security": [ { "BearerAuth": [] } ], "summary": "Resume a sandbox", "tags": [ "Sandboxes" ], "x-beta": true } }, "/sandboxes/{sandboxId}/snapshots": { "post": { "operationId": "V2_CreateSandboxSnapshot", "parameters": [ { "in": "path", "name": "sandboxId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2CreateSandboxSnapshotResponse" } } }, "description": "A successful response." } }, "security": [ { "BearerAuth": [] } ], "summary": "Create a sandbox snapshot", "tags": [ "Sandboxes" ], "x-beta": true } }, "/sessions": { "get": { "description": "Lists session keys observed in the authenticated environment.", "operationId": "V2_ListSessionKeys", "parameters": [ { "in": "query", "name": "search", "schema": { "type": "string" } }, { "description": "Pagination cursor from previous response", "in": "query", "name": "cursor", "schema": { "type": "string" } }, { "description": "Number of sessions to return per page (min: 1, max: 100)", "in": "query", "name": "limit", "schema": { "default": "20", "format": "int32", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ListSessionKeysResponse" } } }, "description": "A successful response." } }, "security": [ { "BearerAuth": [] } ], "summary": "List session keys", "tags": [ "Sessions" ], "x-beta": true } }, "/sessions/{sessionKey}": { "get": { "description": "Lists session IDs for one session key in the authenticated environment.", "operationId": "V2_ListSessions", "parameters": [ { "in": "path", "name": "sessionKey", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "search", "schema": { "type": "string" } }, { "description": "Pagination cursor from previous response", "in": "query", "name": "cursor", "schema": { "type": "string" } }, { "description": "Number of sessions to return per page (min: 1, max: 100)", "in": "query", "name": "limit", "schema": { "default": "20", "format": "int32", "type": "integer" } }, { "in": "query", "name": "from", "schema": { "format": "date-time", "type": "string" } }, { "in": "query", "name": "until", "schema": { "format": "date-time", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ListSessionsResponse" } } }, "description": "A successful response." } }, "security": [ { "BearerAuth": [] } ], "summary": "List sessions", "tags": [ "Sessions" ], "x-beta": true } }, "/sessions/{sessionKey}/{sessionId}/runs": { "get": { "description": "Lists runs associated with one session ID in the authenticated environment.", "operationId": "V2_ListSessionRuns", "parameters": [ { "in": "path", "name": "sessionKey", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "sessionId", "required": true, "schema": { "pattern": ".+", "type": "string" } }, { "description": "Pagination cursor from previous response", "in": "query", "name": "cursor", "schema": { "type": "string" } }, { "description": "Number of session runs to return per page (min: 1, max: 100)", "in": "query", "name": "limit", "schema": { "default": "20", "format": "int32", "type": "integer" } }, { "in": "query", "name": "from", "schema": { "format": "date-time", "type": "string" } }, { "in": "query", "name": "until", "schema": { "format": "date-time", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ListSessionRunsResponse" } } }, "description": "A successful response." } }, "security": [ { "BearerAuth": [] } ], "summary": "List session runs", "tags": [ "Sessions" ], "x-beta": true } }, "/snapshots": { "get": { "operationId": "V2_ListSandboxSnapshots", "parameters": [ { "in": "query", "name": "cursor", "schema": { "type": "string" } }, { "in": "query", "name": "limit", "schema": { "format": "int32", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ListSandboxSnapshotsResponse" } } }, "description": "A successful response." } }, "security": [ { "BearerAuth": [] } ], "summary": "List sandbox snapshots", "tags": [ "Sandboxes" ], "x-beta": true } }, "/snapshots/{snapshotId}": { "delete": { "operationId": "V2_DeleteSandboxSnapshot", "parameters": [ { "in": "path", "name": "snapshotId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2DeleteSandboxSnapshotResponse" } } }, "description": "A successful response." } }, "security": [ { "BearerAuth": [] } ], "summary": "Delete a sandbox snapshot", "tags": [ "Sandboxes" ], "x-beta": true }, "get": { "operationId": "V2_GetSandboxSnapshot", "parameters": [ { "in": "path", "name": "snapshotId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2GetSandboxSnapshotResponse" } } }, "description": "A successful response." } }, "security": [ { "BearerAuth": [] } ], "summary": "Get a sandbox snapshot", "tags": [ "Sandboxes" ], "x-beta": true } } }, "components": { "schemas": { "V2CancelRunBody": { "type": "object" }, "V2ExecSandboxBody": { "properties": { "command": { "items": { "type": "string" }, "type": "array" }, "cwd": { "type": "string" }, "environment": { "additionalProperties": { "type": "string" }, "type": "object" }, "timeout": { "type": "string" } }, "type": "object" }, "V2InvokeFunctionBody": { "properties": { "data": { "description": "JSON object containing the input data for the function", "example": { "message": "Hello, World!" }, "type": "object" }, "idempotencyKey": { "description": "Optional idempotency key to handle duplicate requests within a given idempotency period.", "example": "user-action-123", "type": "string" } }, "type": "object" }, "V2PatchEnvBody": { "properties": { "isArchived": { "description": "Updates the archived status of the environment. Set to true to archive the environment or false to unarchive it.", "type": "boolean" } }, "type": "object" }, "V2RerunBody": { "properties": { "fromStep": { "$ref": "#/components/schemas/v2RerunFromStep" } }, "type": "object" }, "V2SignalSandboxProcessBody": { "properties": { "includeChildren": { "type": "boolean" }, "signal": { "format": "int32", "type": "integer" } }, "type": "object" }, "V2StartSandboxProcessBody": { "properties": { "command": { "items": { "type": "string" }, "type": "array" }, "cwd": { "type": "string" }, "environment": { "additionalProperties": { "type": "string" }, "type": "object" } }, "type": "object" }, "V2SyncAppBody": { "properties": { "url": { "description": "URL for the Inngest endpoint in the app", "example": "https://example.com/api/inngest", "type": "string" } }, "type": "object" }, "apiHttpBody": { "description": "A message that represents an arbitrary HTTP body.", "properties": { "contentType": { "description": "The HTTP Content-Type header value specifying the content type of the body.", "type": "string" }, "data": { "description": "The HTTP request/response body as raw binary.", "format": "byte", "type": "string" }, "extensions": { "description": "Application specific response metadata. Must be set in the first response\nfor streaming APIs.", "items": { "$ref": "#/components/schemas/protobufAny" }, "type": "array" } }, "type": "object" }, "protobufAny": { "additionalProperties": {}, "description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(&foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n // or ...\n if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n foo = any.unpack(Foo.getDefaultInstance());\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := &pb.Foo{...}\n any, err := anypb.New(foo)\n if err != nil {\n ...\n }\n ...\n foo := &pb.Foo{}\n if err := any.UnmarshalTo(foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": ,\n \"lastName\": \n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }", "properties": { "@type": { "description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com. As of May 2023, there are no widely used type server\nimplementations and no plans to implement one.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics.", "type": "string" } }, "type": "object" }, "protobufNullValue": { "default": "NULL_VALUE", "description": "`NullValue` is a singleton enumeration to represent the null value for the\n`Value` type union.\n\nThe JSON representation for `NullValue` is JSON `null`.\n\n - NULL_VALUE: Null value.", "enum": [ "NULL_VALUE" ], "type": "string" }, "rpcStatus": { "properties": { "code": { "format": "int32", "type": "integer" }, "details": { "items": { "$ref": "#/components/schemas/protobufAny" }, "type": "array" }, "message": { "type": "string" } }, "type": "object" }, "v2Account": { "properties": { "createdAt": { "format": "date-time", "type": "string" }, "email": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" } }, "type": "object" }, "v2App": { "properties": { "appVersion": { "description": "User-defined app version, if set", "type": "string" }, "archivedAt": { "description": "Timestamp when the app was archived (if archived)", "format": "date-time", "type": "string" }, "createdAt": { "description": "Timestamp when the app was first synced", "format": "date-time", "type": "string" }, "functionCount": { "description": "Number of functions in the app", "format": "int32", "type": "integer" }, "id": { "description": "The user-defined app ID", "example": "my-app", "type": "string" }, "isArchived": { "description": "Whether the app is archived", "type": "boolean" }, "latestSync": { "$ref": "#/components/schemas/v2AppSync" }, "method": { "$ref": "#/components/schemas/v2AppMethod" }, "name": { "description": "App name", "example": "my-app", "type": "string" } }, "type": "object" }, "v2AppMethod": { "default": "UNSPECIFIED", "enum": [ "UNSPECIFIED", "SERVE", "CONNECT", "API" ], "type": "string" }, "v2AppRef": { "properties": { "id": { "type": "string" } }, "type": "object" }, "v2AppSync": { "properties": { "appVersion": { "description": "App version reported by the latest sync, if set", "type": "string" }, "error": { "description": "Most recent sync or connectivity error for the app, if any", "type": "string" }, "framework": { "description": "Framework used by the app, if reported by the SDK", "example": "nextjs", "type": "string" }, "sdkLanguage": { "description": "Language of the SDK that synced the app", "example": "typescript", "type": "string" }, "sdkVersion": { "description": "Version of the SDK that synced the app", "example": "3.22.0", "type": "string" }, "status": { "description": "Status of the latest sync. `success` and `duplicate` are successful terminal states. `duplicate` means the sync payload matched the previous successful sync, so no function configuration changes were applied. `error` is a failed terminal state, and `pending` means the sync is still in progress.", "enum": [ "pending", "success", "error", "duplicate" ], "type": "string" }, "syncedAt": { "description": "Timestamp for the latest sync, if available", "format": "date-time", "type": "string" }, "url": { "description": "URL of the Inngest endpoint in the app, if synced via URL", "example": "https://example.com/api/inngest", "type": "string" } }, "type": "object" }, "v2CancelRunData": { "properties": { "runId": { "description": "Cancelled run ID", "example": "01hp1zx8m3ng9vp6qn0xk7j4cy", "type": "string" } }, "type": "object" }, "v2CancelRunResponse": { "properties": { "data": { "$ref": "#/components/schemas/v2CancelRunData" }, "metadata": { "$ref": "#/components/schemas/v2ResponseMetadata" } }, "type": "object" }, "v2CreateAccountData": { "properties": { "apiKey": { "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "email": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" } }, "type": "object" }, "v2CreateAccountRequest": { "properties": { "email": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "v2CreateAccountResponse": { "properties": { "data": { "$ref": "#/components/schemas/v2CreateAccountData" }, "metadata": { "$ref": "#/components/schemas/v2ResponseMetadata" } }, "type": "object" }, "v2CreateEnvRequest": { "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "v2CreateEnvResponse": { "properties": { "data": { "$ref": "#/components/schemas/v2Env" }, "metadata": { "$ref": "#/components/schemas/v2ResponseMetadata" } }, "type": "object" }, "v2CreateSandboxRequest": { "properties": { "environment": { "additionalProperties": { "type": "string" }, "type": "object" }, "memoryMb": { "format": "int64", "type": "integer" }, "name": { "type": "string" }, "secrets": { "description": "Exact workspace secret names, each injected under that same environment\nvariable name. Names must be unique, valid environment keys, and must not\noverlap with environment. Names resolve to UUID bindings when creating the\nworkload; create recovery retains those bindings even if a secret is archived\nand its name reused. Values are fetched at launch and may remain in the guest\nand its snapshots. Cannot be supplied with snapshot_id.", "items": { "type": "string" }, "type": "array" }, "snapshotId": { "type": "string" }, "vcpu": { "format": "int64", "type": "integer" } }, "type": "object" }, "v2CreateSandboxResponse": { "properties": { "data": { "$ref": "#/components/schemas/v2Sandbox" }, "metadata": { "$ref": "#/components/schemas/v2SandboxResponseMetadata" } }, "type": "object" }, "v2CreateSandboxSnapshotResponse": { "properties": { "data": { "$ref": "#/components/schemas/v2SandboxSnapshot" }, "metadata": { "$ref": "#/components/schemas/v2SandboxResponseMetadata" } }, "type": "object" }, "v2CreateScoreInput": { "properties": { "experiment": { "$ref": "#/components/schemas/v2ScoreExperiment" }, "name": { "description": "Score name; must be at most 128 UTF-8 bytes", "example": "accuracy", "type": "string" }, "stepId": { "description": "Optional SDK step ID; attaches the score to a specific step instead of the run. Step targets are recorded best-effort and are not validated before writing.", "example": "generate-summary", "type": "string" }, "value": { "description": "Score value; must be a finite number or a boolean", "example": 0.95 } }, "type": "object" }, "v2CreateScoreResponse": { "properties": { "data": { "items": { "$ref": "#/components/schemas/v2Score" }, "type": "array" }, "metadata": { "$ref": "#/components/schemas/v2ResponseMetadata" } }, "type": "object" }, "v2CreateWebhookRequest": { "properties": { "eventFilter": { "$ref": "#/components/schemas/v2EventFilter" }, "name": { "description": "Descriptive name for the webhook", "example": "Payment Processing Webhook", "type": "string" }, "response": { "description": "Optional inline JS function which is called to respond to GET requests", "example": "function respond(body, headers) { return { status: 200, headers: {}, body: JSON.parse(body)?.challenge } };", "type": "string" }, "transform": { "description": "The inline JS transform function for incoming events", "example": "function transform(evt, headers = {}, queryParams = {}, raw = '') { return { name: 'webhook/request.received', data: evt }; }", "type": "string" } }, "type": "object" }, "v2CreateWebhookResponse": { "properties": { "data": { "$ref": "#/components/schemas/v2Webhook" }, "metadata": { "$ref": "#/components/schemas/v2ResponseMetadata" } }, "type": "object" }, "v2DeleteSandboxSnapshotResponse": { "type": "object" }, "v2DestroySandboxResponse": { "properties": { "data": { "$ref": "#/components/schemas/v2Sandbox" }, "metadata": { "$ref": "#/components/schemas/v2SandboxResponseMetadata" } }, "type": "object" }, "v2Env": { "properties": { "createdAt": { "format": "date-time", "type": "string" }, "id": { "type": "string" }, "isArchived": { "type": "boolean" }, "name": { "type": "string" }, "type": { "$ref": "#/components/schemas/v2EnvType" } }, "type": "object" }, "v2EnvType": { "default": "PRODUCTION", "enum": [ "PRODUCTION", "TEST", "BRANCH" ], "type": "string" }, "v2Error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "type": "object" }, "v2ErrorResponse": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/v2Error" }, "type": "array" } }, "type": "object" }, "v2EventFilter": { "properties": { "events": { "description": "Allow or deny specific events, e.g. 'orders/payment.created', or 'orders/*' for all orders. Only events in this list will be either allowed or denied.", "example": [ "orders/payment.created", "orders/*" ], "items": { "type": "string" }, "type": "array" }, "filter": { "$ref": "#/components/schemas/v2FilterType" } }, "type": "object" }, "v2EventKey": { "properties": { "createdAt": { "format": "date-time", "type": "string" }, "environment": { "type": "string" }, "id": { "type": "string" }, "key": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "v2ExecSandboxData": { "properties": { "encoding": { "type": "string" }, "exitCode": { "format": "int32", "type": "integer" }, "stderr": { "format": "byte", "type": "string" }, "stdout": { "format": "byte", "type": "string" } }, "type": "object" }, "v2ExecSandboxResponse": { "properties": { "data": { "$ref": "#/components/schemas/v2ExecSandboxData" }, "metadata": { "$ref": "#/components/schemas/v2SandboxResponseMetadata" } }, "type": "object" }, "v2Experiment": { "properties": { "firstSeen": { "format": "date-time", "type": "string" }, "function": { "$ref": "#/components/schemas/v2FunctionRef" }, "id": { "type": "string" }, "lastSeen": { "format": "date-time", "type": "string" }, "selectionStrategy": { "type": "string" }, "totalRuns": { "format": "int32", "type": "integer" }, "variantCount": { "format": "int32", "type": "integer" }, "variants": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "v2ExperimentDetail": { "properties": { "firstSeen": { "format": "date-time", "type": "string" }, "id": { "type": "string" }, "lastSeen": { "format": "date-time", "type": "string" }, "selectionStrategy": { "type": "string" }, "variantWeights": { "items": { "$ref": "#/components/schemas/v2ExperimentVariantWeight" }, "type": "array" }, "variants": { "items": { "$ref": "#/components/schemas/v2ExperimentVariantMetrics" }, "type": "array" } }, "type": "object" }, "v2ExperimentVariantMetric": { "properties": { "avg": { "format": "double", "type": "number" }, "key": { "type": "string" }, "max": { "format": "double", "type": "number" }, "min": { "format": "double", "type": "number" } }, "type": "object" }, "v2ExperimentVariantMetrics": { "properties": { "metrics": { "items": { "$ref": "#/components/schemas/v2ExperimentVariantMetric" }, "type": "array" }, "runCount": { "format": "int32", "type": "integer" }, "variantName": { "type": "string" } }, "type": "object" }, "v2ExperimentVariantWeight": { "properties": { "variantName": { "type": "string" }, "weight": { "format": "double", "type": "number" } }, "type": "object" }, "v2FetchAccountEnvsResponse": { "properties": { "data": { "items": { "$ref": "#/components/schemas/v2Env" }, "type": "array" }, "metadata": { "$ref": "#/components/schemas/v2ResponseMetadata" }, "page": { "$ref": "#/components/schemas/v2Page" } }, "type": "object" }, "v2FetchAccountEventKeysResponse": { "properties": { "data": { "items": { "$ref": "#/components/schemas/v2EventKey" }, "type": "array" }, "metadata": { "$ref": "#/components/schemas/v2ResponseMetadata" }, "page": { "$ref": "#/components/schemas/v2Page" } }, "type": "object" }, "v2FetchAccountResponse": { "properties": { "data": { "$ref": "#/components/schemas/v2Account" }, "metadata": { "$ref": "#/components/schemas/v2ResponseMetadata" } }, "type": "object" }, "v2FetchAccountSigningKeysResponse": { "properties": { "data": { "items": { "$ref": "#/components/schemas/v2SigningKey" }, "type": "array" }, "metadata": { "$ref": "#/components/schemas/v2ResponseMetadata" }, "page": { "$ref": "#/components/schemas/v2Page" } }, "type": "object" }, "v2FetchAccountsResponse": { "properties": { "data": { "items": { "$ref": "#/components/schemas/v2Account" }, "type": "array" }, "metadata": { "$ref": "#/components/schemas/v2ResponseMetadata" }, "page": { "$ref": "#/components/schemas/v2Page" } }, "type": "object" }, "v2FilterType": { "default": "ALLOW", "enum": [ "ALLOW", "DENY" ], "type": "string" }, "v2Function": { "properties": { "app": { "$ref": "#/components/schemas/v2FunctionApp" }, "configuration": { "$ref": "#/components/schemas/v2FunctionConfiguration" }, "failureHandler": { "$ref": "#/components/schemas/v2FunctionFailureHandler" }, "id": { "type": "string" }, "isArchived": { "type": "boolean" }, "isPaused": { "type": "boolean" }, "name": { "type": "string" }, "slug": { "type": "string" }, "triggers": { "items": { "$ref": "#/components/schemas/v2FunctionTrigger" }, "type": "array" } }, "type": "object" }, "v2FunctionApp": { "properties": { "id": { "type": "string" } }, "type": "object" }, "v2FunctionCancellationConfiguration": { "properties": { "condition": { "type": "string" }, "event": { "type": "string" }, "timeout": { "type": "string" } }, "type": "object" }, "v2FunctionConcurrencyConfiguration": { "properties": { "key": { "type": "string" }, "limit": { "$ref": "#/components/schemas/v2FunctionConcurrencyLimitConfiguration" }, "scope": { "$ref": "#/components/schemas/v2FunctionConcurrencyScope" } }, "type": "object" }, "v2FunctionConcurrencyLimitConfiguration": { "properties": { "isPlanLimit": { "type": "boolean" }, "value": { "format": "int32", "type": "integer" } }, "type": "object" }, "v2FunctionConcurrencyScope": { "default": "UNSPECIFIED", "enum": [ "UNSPECIFIED", "ACCOUNT", "ENVIRONMENT", "FUNCTION" ], "type": "string" }, "v2FunctionConfiguration": { "properties": { "cancellations": { "items": { "$ref": "#/components/schemas/v2FunctionCancellationConfiguration" }, "type": "array" }, "concurrency": { "items": { "$ref": "#/components/schemas/v2FunctionConcurrencyConfiguration" }, "type": "array" }, "debounce": { "$ref": "#/components/schemas/v2FunctionDebounceConfiguration" }, "eventsBatch": { "$ref": "#/components/schemas/v2FunctionEventsBatchConfiguration" }, "priority": { "type": "string" }, "rateLimit": { "$ref": "#/components/schemas/v2FunctionRateLimitConfiguration" }, "retries": { "$ref": "#/components/schemas/v2FunctionRetryConfiguration" }, "singleton": { "$ref": "#/components/schemas/v2FunctionSingletonConfiguration" }, "throttle": { "$ref": "#/components/schemas/v2FunctionThrottleConfiguration" } }, "type": "object" }, "v2FunctionDebounceConfiguration": { "properties": { "key": { "type": "string" }, "period": { "type": "string" } }, "type": "object" }, "v2FunctionEventsBatchConfiguration": { "properties": { "key": { "type": "string" }, "maxSize": { "format": "int32", "type": "integer" }, "timeout": { "type": "string" } }, "type": "object" }, "v2FunctionFailureHandler": { "properties": { "name": { "type": "string" }, "slug": { "type": "string" } }, "type": "object" }, "v2FunctionRateLimitConfiguration": { "properties": { "key": { "type": "string" }, "limit": { "format": "int32", "type": "integer" }, "period": { "type": "string" } }, "type": "object" }, "v2FunctionRef": { "properties": { "app": { "$ref": "#/components/schemas/v2AppRef" }, "id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" } }, "type": "object" }, "v2FunctionRetryConfiguration": { "properties": { "isDefault": { "type": "boolean" }, "value": { "format": "int32", "type": "integer" } }, "type": "object" }, "v2FunctionRun": { "properties": { "app": { "$ref": "#/components/schemas/v2AppRef" }, "deferredFrom": { "$ref": "#/components/schemas/v2RunDeferredFrom" }, "durationMs": { "format": "uint64", "type": "string" }, "endedAt": { "format": "date-time", "type": "string" }, "function": { "$ref": "#/components/schemas/v2FunctionRef" }, "id": { "type": "string" }, "isDeferred": { "type": "boolean" }, "output": { "type": "object" }, "queuedAt": { "format": "date-time", "type": "string" }, "startedAt": { "format": "date-time", "type": "string" }, "status": { "$ref": "#/components/schemas/v2FunctionRunStatus" }, "trigger": { "$ref": "#/components/schemas/v2RunTrigger" } }, "type": "object" }, "v2FunctionRunStatus": { "default": "UNSPECIFIED", "description": " - FUNCTION_RUN_STATUS_PAUSED: PAUSED is synthetic: the run is RUNNING, but its function is paused.\n - FUNCTION_RUN_STATUS_UNKNOWN: UNKNOWN is returned when the persisted run status cannot be recognized.", "enum": [ "UNSPECIFIED", "QUEUED", "RUNNING", "COMPLETED", "FAILED", "CANCELLED", "SKIPPED", "PAUSED", "UNKNOWN" ], "type": "string" }, "v2FunctionSingletonConfiguration": { "properties": { "key": { "type": "string" }, "mode": { "$ref": "#/components/schemas/v2FunctionSingletonMode" } }, "type": "object" }, "v2FunctionSingletonMode": { "default": "UNSPECIFIED", "enum": [ "UNSPECIFIED", "SKIP", "CANCEL" ], "type": "string" }, "v2FunctionThrottleConfiguration": { "properties": { "burst": { "format": "int32", "type": "integer" }, "key": { "type": "string" }, "limit": { "format": "int32", "type": "integer" }, "period": { "type": "string" } }, "type": "object" }, "v2FunctionTrace": { "properties": { "rootSpan": { "$ref": "#/components/schemas/v2TraceSpan" }, "runId": { "type": "string" } }, "type": "object" }, "v2FunctionTrigger": { "properties": { "if": { "type": "string" }, "type": { "$ref": "#/components/schemas/v2FunctionTriggerType" }, "value": { "type": "string" } }, "type": "object" }, "v2FunctionTriggerType": { "default": "UNSPECIFIED", "enum": [ "UNSPECIFIED", "EVENT", "CRON" ], "type": "string" }, "v2GetAppResponse": { "properties": { "data": { "$ref": "#/components/schemas/v2App" }, "metadata": { "$ref": "#/components/schemas/v2ResponseMetadata" } }, "type": "object" }, "v2GetAppsResponse": { "properties": { "data": { "items": { "$ref": "#/components/schemas/v2App" }, "type": "array" }, "metadata": { "$ref": "#/components/schemas/v2ResponseMetadata" }, "page": { "$ref": "#/components/schemas/v2Page" } }, "type": "object" }, "v2GetEventRunsResponse": { "properties": { "data": { "items": { "$ref": "#/components/schemas/v2FunctionRun" }, "type": "array" }, "metadata": { "$ref": "#/components/schemas/v2ResponseMetadata" }, "page": { "$ref": "#/components/schemas/v2Page" } }, "type": "object" }, "v2GetExperimentResponse": { "properties": { "data": { "$ref": "#/components/schemas/v2ExperimentDetail" }, "metadata": { "$ref": "#/components/schemas/v2ResponseMetadata" } }, "type": "object" }, "v2GetFunctionResponse": { "properties": { "data": { "$ref": "#/components/schemas/v2Function" }, "metadata": { "$ref": "#/components/schemas/v2ResponseMetadata" } }, "type": "object" }, "v2GetFunctionRunResponse": { "properties": { "data": { "$ref": "#/components/schemas/v2FunctionRun" }, "metadata": { "$ref": "#/components/schemas/v2ResponseMetadata" } }, "type": "object" }, "v2GetFunctionTraceResponse": { "properties": { "data": { "$ref": "#/components/schemas/v2FunctionTrace" }, "metadata": { "$ref": "#/components/schemas/v2ResponseMetadata" } }, "type": "object" }, "v2GetFunctionsResponse": { "properties": { "data": { "items": { "$ref": "#/components/schemas/v2Function" }, "type": "array" }, "metadata": { "$ref": "#/components/schemas/v2ResponseMetadata" }, "page": { "$ref": "#/components/schemas/v2Page" } }, "type": "object" }, "v2GetSandboxProcessOutputData": { "properties": { "chunks": { "items": { "$ref": "#/components/schemas/v2SandboxLogChunk" }, "type": "array" } }, "type": "object" }, "v2GetSandboxProcessOutputResponse": { "properties": { "data": { "$ref": "#/components/schemas/v2GetSandboxProcessOutputData" }, "metadata": { "$ref": "#/components/schemas/v2SandboxResponseMetadata" } }, "type": "object" }, "v2GetSandboxProcessResponse": { "properties": { "data": { "$ref": "#/components/schemas/v2SandboxProcess" }, "metadata": { "$ref": "#/components/schemas/v2SandboxResponseMetadata" } }, "type": "object" }, "v2GetSandboxResponse": { "properties": { "data": { "$ref": "#/components/schemas/v2Sandbox" }, "metadata": { "$ref": "#/components/schemas/v2SandboxResponseMetadata" } }, "type": "object" }, "v2GetSandboxSnapshotResponse": { "properties": { "data": { "$ref": "#/components/schemas/v2SandboxSnapshot" }, "metadata": { "$ref": "#/components/schemas/v2SandboxResponseMetadata" } }, "type": "object" }, "v2HealthData": { "properties": { "status": { "type": "string" } }, "type": "object" }, "v2HealthResponse": { "properties": { "data": { "$ref": "#/components/schemas/v2HealthData" }, "metadata": { "$ref": "#/components/schemas/v2ResponseMetadata" } }, "type": "object" }, "v2InsightsDiagnostic": { "properties": { "code": { "description": "Machine-readable code representing the type of diagnostic", "type": "string" }, "message": { "description": "Human-readable message describing the diagnostic", "type": "string" }, "position": { "$ref": "#/components/schemas/v2InsightsDiagnosticPosition" }, "severity": { "$ref": "#/components/schemas/v2InsightsDiagnosticSeverity" } }, "type": "object" }, "v2InsightsDiagnosticPosition": { "properties": { "context": { "description": "Snippet of the query string around the position to provide context for the diagnostic", "type": "string" }, "end": { "description": "Ending character index in the query string where the diagnostic applies", "format": "int32", "type": "integer" }, "start": { "description": "Starting character index in the query string where the diagnostic applies", "format": "int32", "type": "integer" } }, "type": "object" }, "v2InsightsDiagnosticSeverity": { "default": "SEVERITY_UNSPECIFIED", "enum": [ "SEVERITY_UNSPECIFIED", "ERROR", "WARNING", "INFO" ], "type": "string" }, "v2InsightsEventSchema": { "properties": { "name": { "description": "Event type name", "example": "orders/payment.created", "type": "string" }, "schema": { "description": "JSON Schema describing the shape of this event's data, represented as a nested JSON object", "type": "object" } }, "type": "object" }, "v2InsightsOutputColumn": { "properties": { "name": { "description": "Name of the column in the insights query result", "type": "string" }, "type": { "$ref": "#/components/schemas/v2InsightsOutputColumnType" } }, "type": "object" }, "v2InsightsOutputColumnType": { "default": "VALUE_TYPE_UNSPECIFIED", "enum": [ "VALUE_TYPE_UNSPECIFIED", "STRING", "NUMBER", "BOOLEAN", "DATETIME", "COMPLEX" ], "type": "string" }, "v2InsightsRow": { "properties": { "values": { "description": "Values for a single row of the insights query result, where each value corresponds to a column. The value is represented as a JSON object to allow for flexible typing (e.g., string, number, boolean, etc.)", "items": {}, "type": "array" } }, "type": "object" }, "v2InsightsTable": { "properties": { "columns": { "description": "Columns available in this table", "items": { "$ref": "#/components/schemas/v2InsightsTableColumn" }, "type": "array" }, "description": { "description": "Human-readable description of the table and its contents", "type": "string" }, "name": { "description": "Name of the table, used when writing queries", "example": "function_runs", "type": "string" } }, "type": "object" }, "v2InsightsTableColumn": { "properties": { "description": { "description": "Human-readable description of the column and the data it contains", "type": "string" }, "name": { "description": "Name of the column in the insights table", "type": "string" }, "type": { "description": "Data type of the column (e.g., 'String', 'Int64', 'Array(String)', etc.)", "type": "string" } }, "type": "object" }, "v2InvokeFunctionData": { "properties": { "completedAt": { "description": "Timestamp when the function execution completed (if finished)", "format": "date-time", "type": "string" }, "error": { "description": "Error message if the function execution failed", "type": "string" }, "queuedAt": { "description": "Timestamp when the function execution was enqueued", "format": "date-time", "type": "string" }, "result": { "description": "JSON string containing the function result (only available for completed synchronous invocations)", "example": "{\"success\": true, \"data\": \"Hello, World!\"}", "type": "string" }, "runId": { "description": "Unique identifier for this function execution", "example": "01hp1zx8m3ng9vp6qn0xk7j4cy", "type": "string" }, "startedAt": { "description": "Timestamp when the function execution started (if started)", "format": "date-time", "type": "string" } }, "type": "object" }, "v2InvokeFunctionResponse": { "properties": { "data": { "$ref": "#/components/schemas/v2InvokeFunctionData" }, "metadata": { "$ref": "#/components/schemas/v2ResponseMetadata" } }, "type": "object" }, "v2ListExperimentsResponse": { "properties": { "data": { "items": { "$ref": "#/components/schemas/v2Experiment" }, "type": "array" }, "metadata": { "$ref": "#/components/schemas/v2ResponseMetadata" }, "page": { "$ref": "#/components/schemas/v2Page" } }, "type": "object" }, "v2ListFunctionRunsResponse": { "properties": { "data": { "items": { "$ref": "#/components/schemas/v2FunctionRun" }, "type": "array" }, "metadata": { "$ref": "#/components/schemas/v2ResponseMetadata" }, "page": { "$ref": "#/components/schemas/v2Page" } }, "type": "object" }, "v2ListInsightsEventSchemasResponse": { "properties": { "data": { "description": "Paginated list of event type schemas", "items": { "$ref": "#/components/schemas/v2InsightsEventSchema" }, "type": "array" }, "metadata": { "$ref": "#/components/schemas/v2ResponseMetadata" }, "page": { "$ref": "#/components/schemas/v2Page" } }, "type": "object" }, "v2ListInsightsTablesResponse": { "properties": { "data": { "description": "List of available tables that can be queried via the Insights query endpoint", "items": { "$ref": "#/components/schemas/v2InsightsTable" }, "type": "array" }, "metadata": { "$ref": "#/components/schemas/v2ResponseMetadata" } }, "type": "object" }, "v2ListRunsResponse": { "properties": { "data": { "items": { "$ref": "#/components/schemas/v2FunctionRun" }, "type": "array" }, "metadata": { "$ref": "#/components/schemas/v2ResponseMetadata" }, "page": { "$ref": "#/components/schemas/v2Page" } }, "type": "object" }, "v2ListSandboxProcessesResponse": { "properties": { "data": { "items": { "$ref": "#/components/schemas/v2SandboxProcess" }, "type": "array" }, "metadata": { "$ref": "#/components/schemas/v2SandboxResponseMetadata" }, "page": { "$ref": "#/components/schemas/v2SandboxPage" } }, "type": "object" }, "v2ListSandboxSnapshotsResponse": { "properties": { "data": { "items": { "$ref": "#/components/schemas/v2SandboxSnapshot" }, "type": "array" }, "metadata": { "$ref": "#/components/schemas/v2SandboxResponseMetadata" }, "page": { "$ref": "#/components/schemas/v2SandboxPage" } }, "type": "object" }, "v2ListSandboxesResponse": { "properties": { "data": { "items": { "$ref": "#/components/schemas/v2Sandbox" }, "type": "array" }, "metadata": { "$ref": "#/components/schemas/v2SandboxResponseMetadata" }, "page": { "$ref": "#/components/schemas/v2SandboxPage" } }, "type": "object" }, "v2ListSessionKeysResponse": { "properties": { "data": { "items": { "$ref": "#/components/schemas/v2SessionKey" }, "type": "array" }, "metadata": { "$ref": "#/components/schemas/v2ResponseMetadata" }, "page": { "$ref": "#/components/schemas/v2Page" } }, "type": "object" }, "v2ListSessionRunsResponse": { "properties": { "data": { "items": { "$ref": "#/components/schemas/v2SessionRun" }, "type": "array" }, "metadata": { "$ref": "#/components/schemas/v2ResponseMetadata" }, "page": { "$ref": "#/components/schemas/v2Page" } }, "type": "object" }, "v2ListSessionsResponse": { "properties": { "data": { "items": { "$ref": "#/components/schemas/v2SessionGroup" }, "type": "array" }, "metadata": { "$ref": "#/components/schemas/v2ResponseMetadata" }, "page": { "$ref": "#/components/schemas/v2Page" } }, "type": "object" }, "v2ListWebhooksResponse": { "properties": { "data": { "items": { "$ref": "#/components/schemas/v2Webhook" }, "type": "array" }, "metadata": { "$ref": "#/components/schemas/v2ResponseMetadata" }, "page": { "$ref": "#/components/schemas/v2Page" } }, "type": "object" }, "v2Page": { "properties": { "cursor": { "type": "string" }, "hasMore": { "type": "boolean" }, "limit": { "format": "int32", "type": "integer" } }, "type": "object" }, "v2PatchEnvsResponse": { "properties": { "data": { "$ref": "#/components/schemas/v2Env" }, "metadata": { "$ref": "#/components/schemas/v2ResponseMetadata" } }, "type": "object" }, "v2PauseSandboxResponse": { "properties": { "data": { "$ref": "#/components/schemas/v2Sandbox" }, "metadata": { "$ref": "#/components/schemas/v2SandboxResponseMetadata" } }, "type": "object" }, "v2QueryInsightsData": { "properties": { "columns": { "description": "Column metadata for the insights query result", "items": { "$ref": "#/components/schemas/v2InsightsOutputColumn" }, "type": "array" }, "diagnostics": { "description": "Any non-fatal diagnostics related to the insights query execution", "items": { "$ref": "#/components/schemas/v2InsightsDiagnostic" }, "type": "array" }, "rows": { "description": "Rows of the insights query result, where each row contains a list of values corresponding to the columns", "items": { "$ref": "#/components/schemas/v2InsightsRow" }, "type": "array" } }, "type": "object" }, "v2QueryInsightsPromptData": { "properties": { "sql": { "description": "The generated Insights SQL query", "example": "SELECT function_id, COUNT(*) AS total, countIf(status = 'Failed') AS failures, failures / total AS failure_rate FROM function_runs WHERE started_at >= now() - INTERVAL 7 DAY GROUP BY function_id ORDER BY failure_rate DESC LIMIT 10", "type": "string" }, "summary": { "description": "A natural language summary of the generated query, useful for explaining the query's intent to agents", "example": "This query retrieves the top 10 functions with the highest failure rate over the past week, showing the total number of runs, number of failures, and calculated failure rate for each function.", "type": "string" } }, "type": "object" }, "v2QueryInsightsPromptRequest": { "properties": { "prompt": { "description": "Natural language description of the query to generate", "example": "Show me the top 10 functions by failure rate in the last 7 days", "type": "string" } }, "type": "object" }, "v2QueryInsightsPromptResponse": { "properties": { "data": { "$ref": "#/components/schemas/v2QueryInsightsPromptData" }, "metadata": { "$ref": "#/components/schemas/v2ResponseMetadata" } }, "type": "object" }, "v2QueryInsightsRequest": { "properties": { "query": { "description": "The insights query to execute, written in modified ClickHouse SQL", "type": "string" } }, "type": "object" }, "v2QueryInsightsResponse": { "properties": { "data": { "$ref": "#/components/schemas/v2QueryInsightsData" }, "metadata": { "$ref": "#/components/schemas/v2ResponseMetadata" } }, "type": "object" }, "v2RerunData": { "properties": { "runId": { "description": "New run ID created by the rerun", "example": "01hp1zx8m3ng9vp6qn0xk7j4cy", "type": "string" } }, "type": "object" }, "v2RerunFromStep": { "properties": { "input": { "description": "Optional replacement step input as a JSON array", "example": [ { "foo": "bar" } ], "items": { "type": "object" }, "type": "array" }, "stepId": { "description": "User-defined step name to rerun from", "example": "step-1", "type": "string" } }, "type": "object" }, "v2RerunResponse": { "properties": { "data": { "$ref": "#/components/schemas/v2RerunData" }, "metadata": { "$ref": "#/components/schemas/v2ResponseMetadata" } }, "type": "object" }, "v2ResponseMetadata": { "properties": { "cachedUntil": { "format": "date-time", "type": "string" }, "fetchedAt": { "format": "date-time", "type": "string" }, "timeRange": { "$ref": "#/components/schemas/v2TimeRange" } }, "type": "object" }, "v2ResumeSandboxResponse": { "properties": { "data": { "$ref": "#/components/schemas/v2Sandbox" }, "metadata": { "$ref": "#/components/schemas/v2SandboxResponseMetadata" } }, "type": "object" }, "v2RunDeferredFrom": { "properties": { "functionName": { "type": "string" }, "functionSlug": { "type": "string" } }, "type": "object" }, "v2RunTrigger": { "properties": { "batchId": { "type": "string" }, "cronSchedule": { "type": "string" }, "eventIds": { "items": { "type": "string" }, "type": "array" }, "eventName": { "type": "string" }, "isBatch": { "type": "boolean" } }, "type": "object" }, "v2Sandbox": { "properties": { "createdAt": { "format": "date-time", "type": "string" }, "endedAt": { "format": "date-time", "type": "string" }, "error": { "type": "string" }, "id": { "type": "string" }, "imageRef": { "type": "string" }, "name": { "type": "string" }, "resources": { "$ref": "#/components/schemas/v2SandboxResourceSpec" }, "startedAt": { "format": "date-time", "type": "string" }, "status": { "$ref": "#/components/schemas/v2SandboxStatus" }, "vpcId": { "type": "string" } }, "type": "object" }, "v2SandboxLogChunk": { "properties": { "at": { "format": "date-time", "type": "string" }, "data": { "format": "byte", "type": "string" }, "encoding": { "type": "string" }, "stream": { "$ref": "#/components/schemas/v2SandboxLogStream" } }, "type": "object" }, "v2SandboxLogStream": { "default": "UNSPECIFIED", "enum": [ "UNSPECIFIED", "STDOUT", "STDERR" ], "type": "string" }, "v2SandboxPage": { "properties": { "cursor": { "type": "string" }, "hasMore": { "type": "boolean" }, "limit": { "format": "int32", "type": "integer" } }, "type": "object" }, "v2SandboxProcess": { "properties": { "command": { "items": { "type": "string" }, "type": "array" }, "endedAt": { "format": "date-time", "type": "string" }, "exitCode": { "format": "int32", "type": "integer" }, "id": { "type": "string" }, "pid": { "format": "int32", "type": "integer" }, "startedAt": { "format": "date-time", "type": "string" }, "state": { "$ref": "#/components/schemas/v2SandboxProcessState" }, "terminationSignal": { "format": "int32", "type": "integer" } }, "type": "object" }, "v2SandboxProcessState": { "default": "UNSPECIFIED", "enum": [ "UNSPECIFIED", "STARTING", "RUNNING", "EXITED", "KILLED", "FAILED", "LOST" ], "type": "string" }, "v2SandboxResourceSpec": { "properties": { "memoryMb": { "format": "int64", "type": "integer" }, "vcpu": { "format": "int64", "type": "integer" } }, "type": "object" }, "v2SandboxResponseMetadata": { "properties": { "fetchedAt": { "format": "date-time", "type": "string" } }, "type": "object" }, "v2SandboxSnapshot": { "properties": { "compatibilityId": { "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "diskPackCount": { "format": "int64", "type": "integer" }, "error": { "type": "string" }, "expiresAt": { "format": "date-time", "type": "string" }, "id": { "type": "string" }, "memoryPackCount": { "format": "int64", "type": "integer" }, "resources": { "$ref": "#/components/schemas/v2SandboxResourceSpec" }, "sourceImageId": { "type": "string" }, "status": { "$ref": "#/components/schemas/v2SandboxSnapshotStatus" }, "storedBytes": { "format": "uint64", "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" } }, "type": "object" }, "v2SandboxSnapshotStatus": { "default": "UNSPECIFIED", "enum": [ "UNSPECIFIED", "CREATING", "READY", "DELETING", "DELETED", "FAILED", "LOST" ], "type": "string" }, "v2SandboxStatus": { "default": "UNSPECIFIED", "enum": [ "UNSPECIFIED", "PENDING", "STARTING", "RUNNING", "PAUSED", "TERMINATING", "TERMINATED", "FAILED" ], "type": "string" }, "v2Score": { "properties": { "experiment": { "$ref": "#/components/schemas/v2ScoreExperiment" }, "name": { "description": "Score name", "type": "string" }, "runId": { "description": "Run ID the score was recorded against", "type": "string" }, "stepId": { "description": "Step ID the score was recorded against, if step-scoped", "type": "string" }, "value": { "description": "Score value" } }, "type": "object" }, "v2ScoreExperiment": { "properties": { "id": { "description": "Experiment ID", "example": "model-routing", "type": "string" }, "variant": { "description": "Experiment variant", "example": "baseline", "type": "string" } }, "type": "object" }, "v2SendEventData": { "properties": { "eventId": { "description": "Internal event ID assigned by Inngest", "example": "01K1QQ3VQ8R3M8QX4D51J8G7XH", "type": "string" } }, "type": "object" }, "v2SendEventRequest": { "properties": { "data": { "description": "JSON object containing event data", "example": { "userId": "01H08WQHKQ9H8S7F7NQGQ0M1NZ" }, "type": "object" }, "id": { "description": "Optional event ID used for idempotency when scheduling function runs", "example": "user-created-01H08WQHKQ9H8S7F7NQGQ0M1NZ", "type": "string" }, "name": { "description": "Event name", "example": "app/user.created", "type": "string" }, "ts": { "description": "Optional event timestamp as Unix time in milliseconds. Defaults to the current time.", "example": 1754496000000, "format": "int64", "type": "string" }, "user": { "description": "Deprecated user data. Put user data in the data field instead.", "example": { "email": "ada@example.com", "id": "01H08WQHKQ9H8S7F7NQGQ0M1NZ" }, "type": "object" } }, "required": [ "name" ], "type": "object" }, "v2SendEventResponse": { "properties": { "data": { "$ref": "#/components/schemas/v2SendEventData" }, "metadata": { "$ref": "#/components/schemas/v2ResponseMetadata" } }, "type": "object" }, "v2SessionGroup": { "properties": { "failedRunCount": { "format": "int32", "type": "integer" }, "failureRate": { "format": "double", "type": "number" }, "functions": { "items": { "$ref": "#/components/schemas/v2FunctionRef" }, "type": "array" }, "id": { "type": "string" }, "lastActiveAt": { "format": "date-time", "type": "string" }, "runCount": { "format": "int32", "type": "integer" } }, "type": "object" }, "v2SessionKey": { "properties": { "createdAt": { "format": "date-time", "type": "string" }, "id": { "type": "string" } }, "type": "object" }, "v2SessionRun": { "properties": { "endedAt": { "format": "date-time", "type": "string" }, "eventName": { "type": "string" }, "function": { "$ref": "#/components/schemas/v2FunctionRef" }, "id": { "type": "string" }, "queuedAt": { "format": "date-time", "type": "string" }, "startedAt": { "format": "date-time", "type": "string" }, "status": { "$ref": "#/components/schemas/v2FunctionRunStatus" } }, "type": "object" }, "v2SignalSandboxProcessResponse": { "type": "object" }, "v2SigningKey": { "properties": { "createdAt": { "format": "date-time", "type": "string" }, "environment": { "type": "string" }, "id": { "type": "string" }, "key": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "v2StartSandboxProcessResponse": { "properties": { "data": { "$ref": "#/components/schemas/v2SandboxProcess" }, "metadata": { "$ref": "#/components/schemas/v2SandboxResponseMetadata" } }, "type": "object" }, "v2StreamSandboxLogsResponse": { "properties": { "data": { "$ref": "#/components/schemas/v2SandboxLogChunk" } }, "type": "object" }, "v2StreamSandboxProcessOutputResponse": { "properties": { "data": { "$ref": "#/components/schemas/v2SandboxLogChunk" } }, "type": "object" }, "v2SyncAppData": { "properties": { "appId": { "description": "App ID", "type": "string" }, "error": { "$ref": "#/components/schemas/v2SyncAppError" }, "id": { "description": "ID", "type": "string" }, "status": { "description": "Status of the sync. `success` and `duplicate` are successful terminal states. `duplicate` means the sync payload matched the previous successful sync, so no function configuration changes were applied. `error` is a failed terminal state, and `pending` means the sync is still in progress.", "enum": [ "pending", "success", "error", "duplicate" ], "type": "string" } }, "type": "object" }, "v2SyncAppError": { "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "type": "object" }, "v2SyncAppResponse": { "properties": { "data": { "$ref": "#/components/schemas/v2SyncAppData" }, "metadata": { "$ref": "#/components/schemas/v2ResponseMetadata" } }, "type": "object" }, "v2TimeRange": { "properties": { "from": { "format": "date-time", "type": "string" }, "until": { "format": "date-time", "type": "string" } }, "type": "object" }, "v2TraceSpan": { "properties": { "children": { "items": { "$ref": "#/components/schemas/v2TraceSpan" }, "type": "array" }, "durationMs": { "format": "uint64", "type": "string" }, "endedAt": { "format": "date-time", "type": "string" }, "id": { "type": "string" }, "input": { "type": "object" }, "metadata": { "items": { "$ref": "#/components/schemas/v2TraceSpanMetadata" }, "type": "array" }, "name": { "type": "string" }, "output": { "type": "object" }, "queuedAt": { "format": "date-time", "type": "string" }, "startedAt": { "format": "date-time", "type": "string" }, "status": { "$ref": "#/components/schemas/v2TraceSpanStatus" }, "stepId": { "type": "string" }, "stepOp": { "$ref": "#/components/schemas/v2TraceStepOp" } }, "type": "object" }, "v2TraceSpanMetadata": { "properties": { "kind": { "type": "string" }, "scope": { "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" }, "values": { "additionalProperties": { "type": "string" }, "type": "object" } }, "type": "object" }, "v2TraceSpanStatus": { "default": "UNKNOWN", "enum": [ "UNKNOWN", "RUNNING", "COMPLETED", "FAILED", "WAITING", "CANCELLED", "SKIPPED" ], "type": "string" }, "v2TraceStepOp": { "default": "UNSPECIFIED", "enum": [ "UNSPECIFIED", "RUN", "SLEEP", "WAIT_FOR_EVENT", "INVOKE", "SEND_EVENT", "AI_GATEWAY", "WAIT_FOR_SIGNAL" ], "type": "string" }, "v2WaitSandboxProcessResponse": { "properties": { "data": { "$ref": "#/components/schemas/v2SandboxProcess" }, "metadata": { "$ref": "#/components/schemas/v2SandboxResponseMetadata" } }, "type": "object" }, "v2Webhook": { "properties": { "createdAt": { "format": "date-time", "type": "string" }, "environment": { "type": "string" }, "eventFilter": { "$ref": "#/components/schemas/v2EventFilter" }, "id": { "type": "string" }, "name": { "type": "string" }, "response": { "type": "string" }, "transform": { "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" }, "url": { "type": "string" } }, "type": "object" }, "v2WriteSandboxFileData": { "properties": { "bytesWritten": { "format": "int64", "type": "integer" }, "path": { "type": "string" } }, "type": "object" }, "v2WriteSandboxFileResponse": { "properties": { "data": { "$ref": "#/components/schemas/v2WriteSandboxFileData" }, "metadata": { "$ref": "#/components/schemas/v2SandboxResponseMetadata" } }, "type": "object" } }, "securitySchemes": { "BearerAuth": { "description": "Bearer token authentication. Format: `Bearer {key}`", "in": "header", "name": "Authorization", "type": "apiKey" } } }, "tags": [ { "description": "Manage your account", "name": "Account" }, { "description": "Create and manage environments", "name": "Environments" }, { "description": "Manage event and signing keys", "name": "Keys" }, { "description": "Create and manage inbound webhooks", "name": "Webhooks" }, { "description": "Sync and manage", "name": "Apps" }, { "description": "Send events", "name": "Events" }, { "description": "Invoke and manage functions", "name": "Functions" }, { "description": "Inspect function runs", "name": "Runs" }, { "description": "Query event and function data", "name": "Insights" }, { "description": "Create and manage isolated compute sandboxes", "name": "Sandboxes" }, { "description": "Inspect experiment variants and aggregates", "name": "Experiments" }, { "description": "Inspect session-grouped runs", "name": "Sessions" }, { "description": "Partner account management", "name": "Partner API", "x-displayName": "Partner API" }, { "name": "V2" } ] }