Generated reference · API

Isis Generation API

OpenAPI contract for `@isis/generation-api`.

82endpoints48schemas0.1.0version
Source
On this page

Health (2)#

GET/healthLiveness probe
GET/readyReadiness probe

Jobs (19)#

GET/api/v1/jobsList jobs
POST/api/v1/jobsSubmit generation job
POST/api/v1/jobs/batchSubmit batch jobs
POST/api/v1/jobs/chainAuto-generated POST /api/v1/jobs/chain
GET/api/v1/jobs/{id}Get job
DELETE/api/v1/jobs/{id}Delete job
GET/api/v1/jobs/{id}/audioGet audio parameter and retrieval contracts for a job
POST/api/v1/jobs/{id}/cancelCancel job
GET/api/v1/jobs/{id}/outputGet job output payload
POST/api/v1/jobs/{id}/retryRetry job
GET/api/v1/jobs/{id}/statusGet job status
GET/api/v1/jobs/{id}/three-d-budgetA 3D job's budget reservations, charges and scope usage
GET/api/v1/jobs/{id}/three-d-eventsA 3D job's events as Server-Sent Events, resumable with Last-Event-ID
POST/api/v1/jobs/{id}/three-d-events/{eventId}/redeliverSend a 3D job event again to its webhook subscriptions under its original id
GET/api/v1/jobs/{id}/three-d-stagesA 3D job's stages, their classified errors and the graph revision
POST/api/v1/jobs/{id}/three-d-stages/steerSteer a running 3D job to a changed request
POST/api/v1/jobs/{id}/three-d-stages/{stage}/retryRetry a failed 3D stage once, idempotently
GET/api/v1/outputs/{jobId}/{filename}Auto-generated GET /api/v1/outputs/{jobId}/{filename}
POST/webhooks/runpodAuto-generated POST /webhooks/runpod

Models (11)#

GET/api/v1/modelsList models
POST/api/v1/modelsRegister model
GET/api/v1/models/audit-logsList model audit logs
GET/api/v1/models/by-name/{name}/{version}Get model by name and version
GET/api/v1/models/{id}Get model
PUT/api/v1/models/{id}Update model
DELETE/api/v1/models/{id}Delete model
GET/api/v1/models/{id}/download-urlGenerate model download URL
POST/api/v1/models/{id}/upload-completeComplete model artifact upload
POST/api/v1/models/{id}/upload-urlGenerate upload URL for model artifact
GET/api/v1/models/{id}/versionsList model versions

Queue (23)#

POST/api/v1/jobs/admin/costs/backfillBackfill missing cost data on historical jobs
POST/api/v1/jobs/admin/generation-types/backfillBackfill stale generation types on historical jobs
POST/api/v1/jobs/admin/historical-taxonomy/backfillBackfill historical jobs with unified generation types and workflow IDs
POST/api/v1/jobs/admin/legacy-pending/recoverRecover legacy pending jobs
POST/api/v1/jobs/admin/queue/drainAdmin queue drain
GET/api/v1/jobs/admin/queue/healthAdmin queue health
POST/api/v1/jobs/admin/workflow-ids/backfillBackfill missing workflow IDs on historical jobs
GET/api/v1/jobs/dead-letterList dead-letter entries
POST/api/v1/jobs/dead-letter/{outboxId}/replayReplay dead-letter entry
GET/api/v1/jobs/feature-flagsList feature flags
PATCH/api/v1/jobs/feature-flags/{key}Update feature flag override
GET/api/v1/jobs/providers/compatibilityGeneration-type compatibility matrix by provider and endpoint family
GET/api/v1/jobs/providers/operationsProvider operations status
GET/api/v1/jobs/runpod/budget-guardrailAuto-generated GET /api/v1/jobs/runpod/budget-guardrail
GET/api/v1/jobs/runpod/cost/todayAuto-generated GET /api/v1/jobs/runpod/cost/today
POST/api/v1/jobs/runpod/kill-switchAuto-generated POST /api/v1/jobs/runpod/kill-switch
GET/api/v1/jobs/runpod/operationsRunPod operations status
GET/api/v1/jobs/runpod/volume/modelsAuto-generated GET /api/v1/jobs/runpod/volume/models
GET/api/v1/jobs/statsQueue stats
GET/api/v1/jobs/{id}/queue-positionGet queue-backed job position
GET/api/v1/queue/statsQueue stats compatibility alias
GET/api/v1/runpod/cacheRunPod model cache state
POST/api/v1/runpod/cache/syncPlan or start a RunPod model cache sync

Webhooks (13)#

GET/api/v1/webhook-subscriptionsAuto-generated GET /api/v1/webhook-subscriptions
POST/api/v1/webhook-subscriptionsAuto-generated POST /api/v1/webhook-subscriptions
POST/api/v1/webhook-subscriptions/callback-security/signAuto-generated POST /api/v1/webhook-subscriptions/callback-security/sign
POST/api/v1/webhook-subscriptions/callback-security/verifyAuto-generated POST /api/v1/webhook-subscriptions/callback-security/verify
GET/api/v1/webhook-subscriptions/event-schemasAuto-generated GET /api/v1/webhook-subscriptions/event-schemas
GET/api/v1/webhook-subscriptions/event-schemas/{eventType}Auto-generated GET /api/v1/webhook-subscriptions/event-schemas/{eventType}
GET/api/v1/webhook-subscriptions/event-typesAuto-generated GET /api/v1/webhook-subscriptions/event-types
GET/api/v1/webhook-subscriptions/{subscriptionId}Auto-generated GET /api/v1/webhook-subscriptions/{subscriptionId}
PATCH/api/v1/webhook-subscriptions/{subscriptionId}Auto-generated PATCH /api/v1/webhook-subscriptions/{subscriptionId}
DELETE/api/v1/webhook-subscriptions/{subscriptionId}Auto-generated DELETE /api/v1/webhook-subscriptions/{subscriptionId}
POST/api/v1/webhook-subscriptions/{subscriptionId}/activateAuto-generated POST /api/v1/webhook-subscriptions/{subscriptionId}/activate
POST/api/v1/webhook-subscriptions/{subscriptionId}/pauseAuto-generated POST /api/v1/webhook-subscriptions/{subscriptionId}/pause
POST/api/v1/webhook-subscriptions/{subscriptionId}/rotate-secretAuto-generated POST /api/v1/webhook-subscriptions/{subscriptionId}/rotate-secret

Workflows (14)#

GET/api/v1/workflows/catalogAuto-generated GET /api/v1/workflows/catalog
GET/api/v1/workflows/catalog/3d-capabilities3D capability states
GET/api/v1/workflows/hosted-lanes/meshyAuto-generated GET /api/v1/workflows/hosted-lanes/meshy
GET/api/v1/workflows/hosted-lanes/meshy/animation-libraryAuto-generated GET /api/v1/workflows/hosted-lanes/meshy/animation-library
GET/api/v1/workflows/hosted-lanes/meshy/balanceAuto-generated GET /api/v1/workflows/hosted-lanes/meshy/balance
GET/api/v1/workflows/hosted-lanes/meshy/tasks/{capability}Auto-generated GET /api/v1/workflows/hosted-lanes/meshy/tasks/{capability}
GET/api/v1/workflows/hosted-lanes/meshy/usageAuto-generated GET /api/v1/workflows/hosted-lanes/meshy/usage
GET/api/v1/workflows/hosted-lanes/openrouterAuto-generated GET /api/v1/workflows/hosted-lanes/openrouter
POST/api/v1/workflows/hosted-lanes/openrouter/estimateAuto-generated POST /api/v1/workflows/hosted-lanes/openrouter/estimate
POST/api/v1/workflows/triggers/batchAuto-generated POST /api/v1/workflows/triggers/batch
POST/api/v1/workflows/triggers/chainedAuto-generated POST /api/v1/workflows/triggers/chained
GET/api/v1/workflows/{workflowId}/executionsAuto-generated GET /api/v1/workflows/{workflowId}/executions
GET/api/v1/workflows/{workflowId}/executions/{executionId}Auto-generated GET /api/v1/workflows/{workflowId}/executions/{executionId}
POST/api/v1/workflows/{workflowId}/runAuto-generated POST /api/v1/workflows/{workflowId}/run

Schemas (48)#

CatalogOptionPolicyobjectCatalogWorkflowEntryobjectCatalogWorkflowListingobjectContentPolicyMissingErrorobjectContentPolicyViolationErrorobjectDistributionInternalOnlyErrorobjectErrorResponseobjectJobAudioConditioningContractobjectJobAudioContractOutputobjectJobAudioContractParametersobjectJobAudioContractRetrievalLinksobjectJobAudioContractSnapshotobjectJobOutputobjectJobOutputFileobjectJobOutputFileFactsobjectJobThreeDArtifactFileobjectJobThreeDPackageobjectJobVoiceConsistencyContractobjectJsonObjectobjectModelsNotCachedErrorobjectRunPodCacheSnapshotobjectRunPodCacheSyncConflictobjectRunPodCacheSyncPlanobjectRunPodCacheSyncRequestobjectRunPodCacheSyncResponseobjectRunPodCacheSyncViewobjectRunPodCacheWaitEstimateobjectThreeDArtifactManifestobjectThreeDBudgetSummaryobjectThreeDCapabilityobjectThreeDCapabilityListingobjectThreeDCapabilityRefusalErrorobjectThreeDCapabilityStatestringThreeDCatalogProofReconciliationobjectThreeDClassifiedErrorobjectThreeDEventRedeliveryobjectThreeDEvidenceRefobjectThreeDJobRequestobjectThreeDRequestIssueobjectThreeDRequestRefusalErrorobjectThreeDStageControlRefusalobjectThreeDStageRetryRequestobjectThreeDStageRetryResultobjectThreeDStageStateobjectThreeDStageSteerRefusalobjectThreeDStageSteerRequestobjectThreeDStageSteerResultobjectThreeDStageViewobject