{ "components": { "schemas": { "AgentToolsetListResponse": { "additionalProperties": false, "properties": { "data": { "items": { "$ref": "#/components/schemas/AgentToolsetResponse" }, "title": "Data", "type": "array" } }, "required": [ "data" ], "title": "AgentToolsetListResponse", "type": "object" }, "AgentToolsetResponse": { "additionalProperties": false, "description": "One registry entry, rendered from ``AgentToolsetRegistry.catalog()``.\n\nThe copy lives in the registry and is never restated here.", "properties": { "id": { "title": "Id", "type": "string" }, "label": { "title": "Label", "type": "string" }, "summary": { "title": "Summary", "type": "string" }, "tools": { "items": { "type": "string" }, "title": "Tools", "type": "array" }, "whenNeeded": { "title": "Whenneeded", "type": "string" }, "whenNotNeeded": { "title": "Whennotneeded", "type": "string" } }, "required": [ "id", "label", "summary", "whenNeeded", "whenNotNeeded", "tools" ], "title": "AgentToolsetResponse", "type": "object" }, "AlertDeliveryResponse": { "additionalProperties": false, "properties": { "alertRuleId": { "minLength": 1, "title": "Alertruleid", "type": "string" }, "channel": { "title": "Channel", "type": "string" }, "createdAt": { "description": "UTC RFC 3339 timestamp string.", "examples": [ "2026-06-12T12:00:00Z" ], "title": "Createdat", "type": "string" }, "eventId": { "minLength": 1, "title": "Eventid", "type": "string" }, "failure": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Failure" }, "id": { "minLength": 1, "title": "Id", "type": "string" }, "recipient": { "title": "Recipient", "type": "string" }, "sentAt": { "anyOf": [ { "description": "UTC RFC 3339 timestamp string.", "examples": [ "2026-06-12T12:00:00Z" ], "type": "string" }, { "type": "null" } ], "title": "Sentat" }, "status": { "title": "Status", "type": "string" } }, "required": [ "id", "alertRuleId", "eventId", "channel", "recipient", "status", "failure", "createdAt", "sentAt" ], "title": "AlertDeliveryResponse", "type": "object" }, "AlertRuleCreateRequestBody": { "additionalProperties": false, "properties": { "channels": { "items": { "enum": [ "email" ], "type": "string" }, "title": "Channels", "type": "array" }, "enabled": { "default": true, "title": "Enabled", "type": "boolean" }, "eventTypes": { "items": { "enum": [ "export.failed", "export.ready", "row.failed", "row.flagged", "run.canceled", "run.completed_with_flags", "run.failed", "run.succeeded" ], "type": "string" }, "title": "Eventtypes", "type": "array" }, "name": { "title": "Name", "type": "string" }, "recipients": { "items": { "type": "string" }, "title": "Recipients", "type": "array" } }, "required": [ "name", "eventTypes", "channels", "recipients" ], "title": "AlertRuleCreateRequestBody", "type": "object" }, "AlertRuleResponse": { "additionalProperties": false, "properties": { "channels": { "items": { "type": "string" }, "title": "Channels", "type": "array" }, "createdAt": { "description": "UTC RFC 3339 timestamp string.", "examples": [ "2026-06-12T12:00:00Z" ], "title": "Createdat", "type": "string" }, "enabled": { "title": "Enabled", "type": "boolean" }, "eventTypes": { "items": { "type": "string" }, "title": "Eventtypes", "type": "array" }, "id": { "minLength": 1, "title": "Id", "type": "string" }, "name": { "title": "Name", "type": "string" }, "orgId": { "minLength": 1, "title": "Orgid", "type": "string" }, "recipients": { "items": { "type": "string" }, "title": "Recipients", "type": "array" }, "updatedAt": { "description": "UTC RFC 3339 timestamp string.", "examples": [ "2026-06-12T12:00:00Z" ], "title": "Updatedat", "type": "string" } }, "required": [ "id", "orgId", "name", "enabled", "eventTypes", "channels", "recipients", "createdAt", "updatedAt" ], "title": "AlertRuleResponse", "type": "object" }, "AlertRuleUpdateRequestBody": { "additionalProperties": false, "properties": { "channels": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "items": { "enum": [ "email" ], "type": "string" }, "title": "Channels" }, "enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Enabled" }, "eventTypes": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "items": { "enum": [ "export.failed", "export.ready", "row.failed", "row.flagged", "run.canceled", "run.completed_with_flags", "run.failed", "run.succeeded" ], "type": "string" }, "title": "Eventtypes" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "recipients": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Recipients" } }, "title": "AlertRuleUpdateRequestBody", "type": "object" }, "ApiKeyCreateRequest": { "additionalProperties": false, "properties": { "expiresAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Expiresat" }, "name": { "maxLength": 200, "minLength": 1, "title": "Name", "type": "string" }, "scopeTemplate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Scopetemplate" }, "scopes": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Scopes" } }, "required": [ "name" ], "title": "ApiKeyCreateRequest", "type": "object" }, "ApiKeyPrincipalResponse": { "additionalProperties": false, "properties": { "apiKeyId": { "minLength": 1, "title": "Apikeyid", "type": "string" }, "organizationId": { "minLength": 1, "title": "Organizationid", "type": "string" }, "scopes": { "items": { "type": "string" }, "title": "Scopes", "type": "array" }, "type": { "const": "api_key", "title": "Type", "type": "string" } }, "required": [ "type", "organizationId", "apiKeyId", "scopes" ], "title": "ApiKeyPrincipalResponse", "type": "object" }, "ApiKeyResponse": { "additionalProperties": false, "properties": { "createdAt": { "description": "UTC RFC 3339 timestamp string.", "examples": [ "2026-06-12T12:00:00Z" ], "title": "Createdat", "type": "string" }, "createdByUserId": { "minLength": 1, "title": "Createdbyuserid", "type": "string" }, "expiresAt": { "anyOf": [ { "description": "UTC RFC 3339 timestamp string.", "examples": [ "2026-06-12T12:00:00Z" ], "type": "string" }, { "type": "null" } ], "title": "Expiresat" }, "id": { "minLength": 1, "title": "Id", "type": "string" }, "lastUsedAt": { "anyOf": [ { "description": "UTC RFC 3339 timestamp string.", "examples": [ "2026-06-12T12:00:00Z" ], "type": "string" }, { "type": "null" } ], "title": "Lastusedat" }, "name": { "title": "Name", "type": "string" }, "organizationId": { "minLength": 1, "title": "Organizationid", "type": "string" }, "revokedAt": { "anyOf": [ { "description": "UTC RFC 3339 timestamp string.", "examples": [ "2026-06-12T12:00:00Z" ], "type": "string" }, { "type": "null" } ], "title": "Revokedat" }, "scopes": { "items": { "type": "string" }, "title": "Scopes", "type": "array" }, "status": { "title": "Status", "type": "string" } }, "required": [ "id", "organizationId", "createdByUserId", "name", "status", "scopes", "expiresAt", "revokedAt", "lastUsedAt", "createdAt" ], "title": "ApiKeyResponse", "type": "object" }, "ApiKeyRotateRequest": { "additionalProperties": false, "properties": { "expiresAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Expiresat" }, "name": { "anyOf": [ { "maxLength": 200, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Name" } }, "title": "ApiKeyRotateRequest", "type": "object" }, "AttemptModelUsageSummary": { "additionalProperties": false, "properties": { "inputTokens": { "minimum": 0.0, "title": "Inputtokens", "type": "integer" }, "outputTokens": { "minimum": 0.0, "title": "Outputtokens", "type": "integer" }, "providerAttempts": { "$ref": "#/components/schemas/AttemptProviderAttemptsSummary" }, "totalTokens": { "minimum": 0.0, "title": "Totaltokens", "type": "integer" } }, "required": [ "inputTokens", "outputTokens", "totalTokens", "providerAttempts" ], "title": "AttemptModelUsageSummary", "type": "object" }, "AttemptProviderAttemptsSummary": { "additionalProperties": false, "properties": { "failed": { "minimum": 0.0, "title": "Failed", "type": "integer" }, "succeeded": { "minimum": 0.0, "title": "Succeeded", "type": "integer" }, "total": { "minimum": 0.0, "title": "Total", "type": "integer" } }, "required": [ "total", "succeeded", "failed" ], "title": "AttemptProviderAttemptsSummary", "type": "object" }, "AuditEventResponse": { "additionalProperties": false, "properties": { "actorId": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Actorid" }, "actorType": { "title": "Actortype", "type": "string" }, "apiKeyId": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Apikeyid" }, "createdAt": { "description": "UTC RFC 3339 timestamp string.", "examples": [ "2026-06-12T12:00:00Z" ], "title": "Createdat", "type": "string" }, "id": { "minLength": 1, "title": "Id", "type": "string" }, "metadata": { "additionalProperties": true, "title": "Metadata", "type": "object" }, "organizationId": { "minLength": 1, "title": "Organizationid", "type": "string" }, "type": { "title": "Type", "type": "string" } }, "required": [ "id", "organizationId", "type", "actorType", "actorId", "apiKeyId", "metadata", "createdAt" ], "title": "AuditEventResponse", "type": "object" }, "BidirectionalPage_JobRunHistoryResponse_": { "additionalProperties": false, "properties": { "data": { "items": { "$ref": "#/components/schemas/JobRunHistoryResponse" }, "title": "Data", "type": "array" }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Nextcursor" }, "previousCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Previouscursor" } }, "required": [ "data" ], "title": "BidirectionalPage[JobRunHistoryResponse]", "type": "object" }, "BidirectionalPage_JobSpecVersionResponse_": { "additionalProperties": false, "properties": { "data": { "items": { "$ref": "#/components/schemas/JobSpecVersionResponse" }, "title": "Data", "type": "array" }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Nextcursor" }, "previousCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Previouscursor" } }, "required": [ "data" ], "title": "BidirectionalPage[JobSpecVersionResponse]", "type": "object" }, "BillingAccountResponse": { "additionalProperties": false, "properties": { "contractCurrencyCode": { "anyOf": [ { "maxLength": 3, "minLength": 3, "type": "string" }, { "type": "null" } ], "title": "Contractcurrencycode" }, "id": { "minLength": 1, "title": "Id", "type": "string" }, "organizationId": { "minLength": 1, "title": "Organizationid", "type": "string" } }, "required": [ "id", "organizationId", "contractCurrencyCode" ], "title": "BillingAccountResponse", "type": "object" }, "BillingCapacityBandResponse": { "additionalProperties": false, "properties": { "id": { "minLength": 1, "title": "Id", "type": "string" }, "includedRows": { "minimum": 0.0, "title": "Includedrows", "type": "integer" }, "recurringAi": { "$ref": "#/components/schemas/CustomerMoneyResponse" } }, "required": [ "id", "includedRows", "recurringAi" ], "title": "BillingCapacityBandResponse", "type": "object" }, "BillingCatalogActiveResponse": { "additionalProperties": false, "properties": { "catalogKey": { "title": "Catalogkey", "type": "string" }, "catalogVersion": { "minimum": 1.0, "title": "Catalogversion", "type": "integer" }, "contentSha256": { "pattern": "^[0-9a-f]{64}$", "title": "Contentsha256", "type": "string" }, "offers": { "items": { "$ref": "#/components/schemas/BillingOfferResponse" }, "title": "Offers", "type": "array" }, "status": { "const": "active", "title": "Status", "type": "string" } }, "required": [ "status", "catalogKey", "catalogVersion", "contentSha256", "offers" ], "title": "BillingCatalogActiveResponse", "type": "object" }, "BillingCatalogUnavailableResponse": { "additionalProperties": false, "properties": { "status": { "const": "unavailable", "title": "Status", "type": "string" } }, "required": [ "status" ], "title": "BillingCatalogUnavailableResponse", "type": "object" }, "BillingDebtResolutionResponse": { "additionalProperties": false, "properties": { "amount": { "$ref": "#/components/schemas/CustomerMoneyResponse" }, "disposition": { "enum": [ "payment", "correction", "credit", "void", "write_off" ], "title": "Disposition", "type": "string" }, "id": { "minLength": 1, "title": "Id", "type": "string" }, "providerInvoiceId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Providerinvoiceid" }, "providerPaymentId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Providerpaymentid" }, "resolvedAt": { "description": "UTC RFC 3339 timestamp string.", "examples": [ "2026-06-12T12:00:00Z" ], "title": "Resolvedat", "type": "string" } }, "required": [ "id", "disposition", "amount", "resolvedAt" ], "title": "BillingDebtResolutionResponse", "type": "object" }, "BillingHistoryDetailResponse": { "additionalProperties": false, "properties": { "amount": { "$ref": "#/components/schemas/CustomerMoneyResponse" }, "documentKind": { "enum": [ "invoice", "receipt", "credit", "none" ], "title": "Documentkind", "type": "string" }, "id": { "title": "Id", "type": "string" }, "kind": { "enum": [ "subscription_invoice", "monthly_invoice", "plan_change", "ai_top_up", "refund", "credit" ], "title": "Kind", "type": "string" }, "lineItems": { "items": { "$ref": "#/components/schemas/BillingHistoryLineItemResponse" }, "title": "Lineitems", "type": "array" }, "occurredAt": { "description": "UTC RFC 3339 timestamp string.", "examples": [ "2026-06-12T12:00:00Z" ], "title": "Occurredat", "type": "string" }, "providerReferences": { "anyOf": [ { "$ref": "#/components/schemas/BillingHistoryProviderReferencesResponse" }, { "type": "null" } ] }, "relatedHistoryItem": { "anyOf": [ { "$ref": "#/components/schemas/BillingHistorySummaryResponse" }, { "type": "null" } ] }, "relatedHistoryItemId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Relatedhistoryitemid" }, "status": { "enum": [ "paid", "open", "partial", "refunded", "applied", "void", "written_off", "needs_attention" ], "title": "Status", "type": "string" } }, "required": [ "id", "kind", "occurredAt", "amount", "status", "documentKind" ], "title": "BillingHistoryDetailResponse", "type": "object" }, "BillingHistoryLineItemResponse": { "additionalProperties": false, "properties": { "amount": { "$ref": "#/components/schemas/CustomerMoneyResponse" }, "description": { "title": "Description", "type": "string" }, "id": { "title": "Id", "type": "string" } }, "required": [ "id", "description", "amount" ], "title": "BillingHistoryLineItemResponse", "type": "object" }, "BillingHistoryListResponse": { "additionalProperties": false, "properties": { "items": { "items": { "$ref": "#/components/schemas/BillingHistorySummaryResponse" }, "title": "Items", "type": "array" }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Nextcursor" } }, "required": [ "items" ], "title": "BillingHistoryListResponse", "type": "object" }, "BillingHistoryProviderReferencesResponse": { "additionalProperties": false, "properties": { "creditNotePdfUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Creditnotepdfurl" }, "hostedInvoiceUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Hostedinvoiceurl" }, "invoicePdfUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Invoicepdfurl" }, "stripeCreditNoteId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Stripecreditnoteid" }, "stripeInvoiceId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Stripeinvoiceid" }, "stripePaymentIntentId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Stripepaymentintentid" }, "stripeReceiptUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Stripereceipturl" }, "stripeRefundId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Striperefundid" } }, "title": "BillingHistoryProviderReferencesResponse", "type": "object" }, "BillingHistorySummaryResponse": { "additionalProperties": false, "properties": { "amount": { "$ref": "#/components/schemas/CustomerMoneyResponse" }, "documentKind": { "enum": [ "invoice", "receipt", "credit", "none" ], "title": "Documentkind", "type": "string" }, "id": { "title": "Id", "type": "string" }, "kind": { "enum": [ "subscription_invoice", "monthly_invoice", "plan_change", "ai_top_up", "refund", "credit" ], "title": "Kind", "type": "string" }, "occurredAt": { "description": "UTC RFC 3339 timestamp string.", "examples": [ "2026-06-12T12:00:00Z" ], "title": "Occurredat", "type": "string" }, "relatedHistoryItemId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Relatedhistoryitemid" }, "status": { "enum": [ "paid", "open", "partial", "refunded", "applied", "void", "written_off", "needs_attention" ], "title": "Status", "type": "string" } }, "required": [ "id", "kind", "occurredAt", "amount", "status", "documentKind" ], "title": "BillingHistorySummaryResponse", "type": "object" }, "BillingOfferResponse": { "additionalProperties": false, "properties": { "cadence": { "const": "monthly", "title": "Cadence", "type": "string" }, "capacityBand": { "$ref": "#/components/schemas/BillingCapacityBandResponse" }, "id": { "minLength": 1, "title": "Id", "type": "string" }, "monthlyAmount": { "$ref": "#/components/schemas/CustomerMoneyResponse" }, "rowPayAsYouGoRate": { "$ref": "#/components/schemas/CustomerRateResponse" }, "termsVersion": { "title": "Termsversion", "type": "string" }, "tier": { "$ref": "#/components/schemas/BillingTierResponse" } }, "required": [ "id", "tier", "capacityBand", "monthlyAmount", "rowPayAsYouGoRate", "cadence", "termsVersion" ], "title": "BillingOfferResponse", "type": "object" }, "BillingOverviewResponse": { "additionalProperties": false, "properties": { "acceptedTermsVersions": { "description": "Exact Terms versions this authenticated user has accepted.", "items": { "type": "string" }, "title": "Acceptedtermsversions", "type": "array" }, "activePaidOffer": { "anyOf": [ { "$ref": "#/components/schemas/BillingOfferResponse" }, { "type": "null" } ] }, "billingAccount": { "$ref": "#/components/schemas/BillingAccountResponse" }, "catalog": { "discriminator": { "mapping": { "active": "#/components/schemas/BillingCatalogActiveResponse", "unavailable": "#/components/schemas/BillingCatalogUnavailableResponse" }, "propertyName": "status" }, "oneOf": [ { "$ref": "#/components/schemas/BillingCatalogActiveResponse" }, { "$ref": "#/components/schemas/BillingCatalogUnavailableResponse" } ], "title": "Catalog" }, "onboardingPendingReason": { "anyOf": [ { "enum": [ "plugin_activation", "payment_confirmation" ], "type": "string" }, { "type": "null" } ], "title": "Onboardingpendingreason" }, "onboardingSetupSaved": { "default": false, "title": "Onboardingsetupsaved", "type": "boolean" }, "onboardingSetupState": { "anyOf": [ { "enum": [ "setup_required", "confirmation_pending", "funding_required", "setup_complete", "unavailable" ], "type": "string" }, { "type": "null" } ], "title": "Onboardingsetupstate" }, "paidCheckoutAvailable": { "title": "Paidcheckoutavailable", "type": "boolean" }, "paymentMethod": { "anyOf": [ { "$ref": "#/components/schemas/VerifiedPaymentMethodResponse" }, { "type": "null" } ] }, "portalAvailable": { "title": "Portalavailable", "type": "boolean" }, "promotion": { "anyOf": [ { "$ref": "#/components/schemas/PromotionStatusResponse" }, { "type": "null" } ] }, "rowBudget": { "anyOf": [ { "$ref": "#/components/schemas/CustomerRowBudgetStatusResponse" }, { "type": "null" } ] }, "wallet": { "anyOf": [ { "$ref": "#/components/schemas/WalletBalanceResponse" }, { "type": "null" } ] } }, "required": [ "billingAccount", "catalog", "paidCheckoutAvailable", "portalAvailable", "acceptedTermsVersions" ], "title": "BillingOverviewResponse", "type": "object" }, "BillingPortalSessionResponse": { "additionalProperties": false, "properties": { "portalUrl": { "description": "Validated HTTPS Stripe Customer Portal session capability URL, in path or query session form.", "title": "Portalurl", "type": "string" } }, "required": [ "portalUrl" ], "title": "BillingPortalSessionResponse", "type": "object" }, "BillingReceivableLineageResponse": { "additionalProperties": false, "properties": { "collectionAttemptId": { "minLength": 1, "title": "Collectionattemptid", "type": "string" }, "originalAmount": { "$ref": "#/components/schemas/CustomerMoneyResponse" }, "receivableId": { "minLength": 1, "title": "Receivableid", "type": "string" }, "remainingAmount": { "$ref": "#/components/schemas/CustomerMoneyResponse" }, "resolutions": { "items": { "$ref": "#/components/schemas/BillingDebtResolutionResponse" }, "title": "Resolutions", "type": "array" }, "status": { "enum": [ "open", "partial", "resolved" ], "title": "Status", "type": "string" } }, "required": [ "receivableId", "collectionAttemptId", "originalAmount", "remainingAmount", "status", "resolutions" ], "title": "BillingReceivableLineageResponse", "type": "object" }, "BillingStatementDetailResponse": { "additionalProperties": false, "properties": { "authoritativeTax": { "$ref": "#/components/schemas/CustomerMoneyResponse" }, "coveredPeriodEnd": { "description": "UTC RFC 3339 timestamp string.", "examples": [ "2026-06-12T12:00:00Z" ], "title": "Coveredperiodend", "type": "string" }, "coveredPeriodId": { "minLength": 1, "title": "Coveredperiodid", "type": "string" }, "coveredPeriodStart": { "description": "UTC RFC 3339 timestamp string.", "examples": [ "2026-06-12T12:00:00Z" ], "title": "Coveredperiodstart", "type": "string" }, "id": { "minLength": 1, "title": "Id", "type": "string" }, "issuedAt": { "description": "UTC RFC 3339 timestamp string.", "examples": [ "2026-06-12T12:00:00Z" ], "title": "Issuedat", "type": "string" }, "lines": { "items": { "$ref": "#/components/schemas/BillingStatementLineResponse" }, "title": "Lines", "type": "array" }, "preTaxSubtotal": { "$ref": "#/components/schemas/CustomerMoneyResponse" }, "providerReceipt": { "anyOf": [ { "$ref": "#/components/schemas/BillingStatementProviderReceiptResponse" }, { "type": "null" } ] }, "status": { "enum": [ "issued", "open", "partial", "resolved" ], "title": "Status", "type": "string" }, "total": { "$ref": "#/components/schemas/CustomerMoneyResponse" } }, "required": [ "id", "coveredPeriodId", "coveredPeriodStart", "coveredPeriodEnd", "issuedAt", "preTaxSubtotal", "authoritativeTax", "total", "status", "lines" ], "title": "BillingStatementDetailResponse", "type": "object" }, "BillingStatementLineResponse": { "additionalProperties": false, "properties": { "amount": { "$ref": "#/components/schemas/CustomerMoneyResponse" }, "id": { "minLength": 1, "title": "Id", "type": "string" }, "kind": { "enum": [ "recurring_in_advance", "row_overage_in_arrears" ], "title": "Kind", "type": "string" }, "receivable": { "anyOf": [ { "$ref": "#/components/schemas/BillingReceivableLineageResponse" }, { "type": "null" } ] }, "sourceFactIds": { "items": { "type": "string" }, "title": "Sourcefactids", "type": "array" } }, "required": [ "id", "kind", "amount", "sourceFactIds" ], "title": "BillingStatementLineResponse", "type": "object" }, "BillingStatementListResponse": { "additionalProperties": false, "properties": { "nextCursor": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Nextcursor" }, "statements": { "items": { "$ref": "#/components/schemas/BillingStatementSummaryResponse" }, "title": "Statements", "type": "array" } }, "required": [ "statements" ], "title": "BillingStatementListResponse", "type": "object" }, "BillingStatementProviderReceiptResponse": { "additionalProperties": false, "description": "Authenticated Stripe document references for a verified statement.", "properties": { "hostedInvoiceUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Hostedinvoiceurl" }, "invoicePdfUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Invoicepdfurl" }, "stripeInvoiceId": { "title": "Stripeinvoiceid", "type": "string" }, "stripePaymentId": { "title": "Stripepaymentid", "type": "string" } }, "required": [ "stripeInvoiceId", "stripePaymentId" ], "title": "BillingStatementProviderReceiptResponse", "type": "object" }, "BillingStatementSummaryResponse": { "additionalProperties": false, "properties": { "authoritativeTax": { "$ref": "#/components/schemas/CustomerMoneyResponse" }, "coveredPeriodEnd": { "description": "UTC RFC 3339 timestamp string.", "examples": [ "2026-06-12T12:00:00Z" ], "title": "Coveredperiodend", "type": "string" }, "coveredPeriodId": { "minLength": 1, "title": "Coveredperiodid", "type": "string" }, "coveredPeriodStart": { "description": "UTC RFC 3339 timestamp string.", "examples": [ "2026-06-12T12:00:00Z" ], "title": "Coveredperiodstart", "type": "string" }, "id": { "minLength": 1, "title": "Id", "type": "string" }, "issuedAt": { "description": "UTC RFC 3339 timestamp string.", "examples": [ "2026-06-12T12:00:00Z" ], "title": "Issuedat", "type": "string" }, "preTaxSubtotal": { "$ref": "#/components/schemas/CustomerMoneyResponse" }, "status": { "enum": [ "issued", "open", "partial", "resolved" ], "title": "Status", "type": "string" }, "total": { "$ref": "#/components/schemas/CustomerMoneyResponse" } }, "required": [ "id", "coveredPeriodId", "coveredPeriodStart", "coveredPeriodEnd", "issuedAt", "preTaxSubtotal", "authoritativeTax", "total", "status" ], "title": "BillingStatementSummaryResponse", "type": "object" }, "BillingTierResponse": { "additionalProperties": false, "properties": { "features": { "items": { "type": "string" }, "title": "Features", "type": "array" }, "id": { "minLength": 1, "title": "Id", "type": "string" } }, "required": [ "id", "features" ], "title": "BillingTierResponse", "type": "object" }, "Body_create_dataset_upload_v1_dataset_uploads_post": { "properties": { "file": { "contentMediaType": "application/octet-stream", "title": "File", "type": "string" }, "metadata": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Metadata" }, "sourceName": { "maxLength": 512, "title": "Sourcename", "type": "string" }, "sourceType": { "title": "Sourcetype", "type": "string" } }, "required": [ "file", "sourceType", "sourceName" ], "title": "Body_create_dataset_upload_v1_dataset_uploads_post", "type": "object" }, "CancellationDiscoveryFoundResponse": { "additionalProperties": false, "properties": { "cancellation": { "$ref": "#/components/schemas/CancellationResponse" }, "discoveryStatus": { "const": "found", "title": "Discoverystatus", "type": "string" }, "mayRequest": { "title": "Mayrequest", "type": "boolean" } }, "required": [ "discoveryStatus", "cancellation", "mayRequest" ], "title": "CancellationDiscoveryFoundResponse", "type": "object" }, "CancellationDiscoveryNoneResponse": { "additionalProperties": false, "properties": { "discoveryStatus": { "const": "none", "title": "Discoverystatus", "type": "string" }, "mayRequest": { "title": "Mayrequest", "type": "boolean" } }, "required": [ "discoveryStatus", "mayRequest" ], "title": "CancellationDiscoveryNoneResponse", "type": "object" }, "CancellationRequestBody": { "additionalProperties": false, "properties": { "clientRequestId": { "maxLength": 128, "minLength": 1, "title": "Clientrequestid", "type": "string" }, "expectedAgreementRevision": { "minimum": 1.0, "title": "Expectedagreementrevision", "type": "integer" } }, "required": [ "clientRequestId", "expectedAgreementRevision" ], "title": "CancellationRequestBody", "type": "object" }, "CancellationResponse": { "additionalProperties": false, "properties": { "agreementRevision": { "minimum": 1.0, "title": "Agreementrevision", "type": "integer" }, "boundary": { "description": "UTC RFC 3339 timestamp string.", "examples": [ "2026-06-12T12:00:00Z" ], "title": "Boundary", "type": "string" }, "cancellationId": { "minLength": 1, "title": "Cancellationid", "type": "string" }, "effectedAgreementRevision": { "anyOf": [ { "minimum": 1.0, "type": "integer" }, { "type": "null" } ], "title": "Effectedagreementrevision" }, "mayWithdraw": { "title": "Maywithdraw", "type": "boolean" }, "periodId": { "minLength": 1, "title": "Periodid", "type": "string" }, "requestedAt": { "description": "UTC RFC 3339 timestamp string.", "examples": [ "2026-06-12T12:00:00Z" ], "title": "Requestedat", "type": "string" }, "requiresRepair": { "title": "Requiresrepair", "type": "boolean" }, "rowVersion": { "minimum": 0.0, "title": "Rowversion", "type": "integer" }, "status": { "enum": [ "scheduled", "withdrawn", "effected" ], "title": "Status", "type": "string" }, "supersededPlanTransitionId": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Supersededplantransitionid" }, "terminalAt": { "anyOf": [ { "description": "UTC RFC 3339 timestamp string.", "examples": [ "2026-06-12T12:00:00Z" ], "type": "string" }, { "type": "null" } ], "title": "Terminalat" }, "withdrawalBlocker": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Withdrawalblocker" } }, "required": [ "cancellationId", "status", "boundary", "periodId", "requestedAt", "agreementRevision", "rowVersion", "mayWithdraw", "requiresRepair" ], "title": "CancellationResponse", "type": "object" }, "CancellationWithdrawalRequestBody": { "additionalProperties": false, "properties": { "clientRequestId": { "maxLength": 128, "minLength": 1, "title": "Clientrequestid", "type": "string" }, "expectedRowVersion": { "minimum": 0.0, "title": "Expectedrowversion", "type": "integer" } }, "required": [ "clientRequestId", "expectedRowVersion" ], "title": "CancellationWithdrawalRequestBody", "type": "object" }, "CountedBidirectionalPage_DatasetReadResponse_": { "additionalProperties": false, "properties": { "data": { "items": { "$ref": "#/components/schemas/DatasetReadResponse" }, "title": "Data", "type": "array" }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Nextcursor" }, "previousCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Previouscursor" }, "totalCount": { "minimum": 0.0, "title": "Totalcount", "type": "integer" } }, "required": [ "data", "totalCount" ], "title": "CountedBidirectionalPage[DatasetReadResponse]", "type": "object" }, "CountedBidirectionalPage_JobSpecSummaryResponse_": { "additionalProperties": false, "properties": { "data": { "items": { "$ref": "#/components/schemas/JobSpecSummaryResponse" }, "title": "Data", "type": "array" }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Nextcursor" }, "previousCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Previouscursor" }, "totalCount": { "minimum": 0.0, "title": "Totalcount", "type": "integer" } }, "required": [ "data", "totalCount" ], "title": "CountedBidirectionalPage[JobSpecSummaryResponse]", "type": "object" }, "CreatedApiKeyResponse": { "additionalProperties": false, "properties": { "createdAt": { "description": "UTC RFC 3339 timestamp string.", "examples": [ "2026-06-12T12:00:00Z" ], "title": "Createdat", "type": "string" }, "createdByUserId": { "minLength": 1, "title": "Createdbyuserid", "type": "string" }, "expiresAt": { "anyOf": [ { "description": "UTC RFC 3339 timestamp string.", "examples": [ "2026-06-12T12:00:00Z" ], "type": "string" }, { "type": "null" } ], "title": "Expiresat" }, "id": { "minLength": 1, "title": "Id", "type": "string" }, "lastUsedAt": { "anyOf": [ { "description": "UTC RFC 3339 timestamp string.", "examples": [ "2026-06-12T12:00:00Z" ], "type": "string" }, { "type": "null" } ], "title": "Lastusedat" }, "name": { "title": "Name", "type": "string" }, "organizationId": { "minLength": 1, "title": "Organizationid", "type": "string" }, "revokedAt": { "anyOf": [ { "description": "UTC RFC 3339 timestamp string.", "examples": [ "2026-06-12T12:00:00Z" ], "type": "string" }, { "type": "null" } ], "title": "Revokedat" }, "scopes": { "items": { "type": "string" }, "title": "Scopes", "type": "array" }, "secret": { "minLength": 1, "title": "Secret", "type": "string" }, "status": { "title": "Status", "type": "string" } }, "required": [ "id", "organizationId", "createdByUserId", "name", "status", "scopes", "expiresAt", "revokedAt", "lastUsedAt", "createdAt", "secret" ], "title": "CreatedApiKeyResponse", "type": "object" }, "CreatedOrganizationInvitationResponse": { "additionalProperties": false, "properties": { "acceptedAt": { "anyOf": [ { "description": "UTC RFC 3339 timestamp string.", "examples": [ "2026-06-12T12:00:00Z" ], "type": "string" }, { "type": "null" } ], "title": "Acceptedat" }, "acceptedByUserId": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Acceptedbyuserid" }, "createdAt": { "description": "UTC RFC 3339 timestamp string.", "examples": [ "2026-06-12T12:00:00Z" ], "title": "Createdat", "type": "string" }, "createdByUserId": { "minLength": 1, "title": "Createdbyuserid", "type": "string" }, "email": { "title": "Email", "type": "string" }, "expiresAt": { "anyOf": [ { "description": "UTC RFC 3339 timestamp string.", "examples": [ "2026-06-12T12:00:00Z" ], "type": "string" }, { "type": "null" } ], "title": "Expiresat" }, "id": { "minLength": 1, "title": "Id", "type": "string" }, "invitationToken": { "minLength": 1, "title": "Invitationtoken", "type": "string" }, "organizationId": { "minLength": 1, "title": "Organizationid", "type": "string" }, "revokedAt": { "anyOf": [ { "description": "UTC RFC 3339 timestamp string.", "examples": [ "2026-06-12T12:00:00Z" ], "type": "string" }, { "type": "null" } ], "title": "Revokedat" }, "revokedByUserId": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Revokedbyuserid" }, "role": { "title": "Role", "type": "string" }, "status": { "title": "Status", "type": "string" }, "updatedAt": { "description": "UTC RFC 3339 timestamp string.", "examples": [ "2026-06-12T12:00:00Z" ], "title": "Updatedat", "type": "string" } }, "required": [ "id", "organizationId", "email", "role", "status", "createdByUserId", "revokedByUserId", "acceptedByUserId", "expiresAt", "revokedAt", "acceptedAt", "createdAt", "updatedAt", "invitationToken" ], "title": "CreatedOrganizationInvitationResponse", "type": "object" }, "CustomerMoneyResponse": { "additionalProperties": false, "properties": { "amount": { "description": "Exact base-10 amount serialized without binary floating point or exponent notation.", "examples": [ "20.00" ], "pattern": "^-?(?:0|[1-9][0-9]*)(?:\\.[0-9]+)?$", "title": "Amount", "type": "string" }, "currencyCode": { "maxLength": 3, "minLength": 3, "title": "Currencycode", "type": "string" } }, "required": [ "currencyCode", "amount" ], "title": "CustomerMoneyResponse", "type": "object" }, "CustomerPriceComponentResponse": { "additionalProperties": false, "properties": { "amount": { "title": "Amount", "type": "string" }, "metric": { "title": "Metric", "type": "string" }, "perQuantity": { "title": "Perquantity", "type": "integer" } }, "required": [ "metric", "amount", "perQuantity" ], "title": "CustomerPriceComponentResponse", "type": "object" }, "CustomerPriceResponse": { "additionalProperties": false, "properties": { "components": { "items": { "$ref": "#/components/schemas/CustomerPriceComponentResponse" }, "title": "Components", "type": "array" }, "currencyCode": { "title": "Currencycode", "type": "string" }, "effectiveAt": { "description": "UTC RFC 3339 timestamp string.", "examples": [ "2026-06-12T12:00:00Z" ], "title": "Effectiveat", "type": "string" }, "fingerprint": { "title": "Fingerprint", "type": "string" }, "inputTokenMaximum": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Inputtokenmaximum" }, "maximumDebitAmount": { "title": "Maximumdebitamount", "type": "string" }, "rateBasis": { "title": "Ratebasis", "type": "string" }, "rateId": { "title": "Rateid", "type": "string" }, "retiredAt": { "anyOf": [ { "description": "UTC RFC 3339 timestamp string.", "examples": [ "2026-06-12T12:00:00Z" ], "type": "string" }, { "type": "null" } ], "title": "Retiredat" } }, "required": [ "rateId", "fingerprint", "rateBasis", "currencyCode", "effectiveAt", "retiredAt", "inputTokenMaximum", "maximumDebitAmount", "components" ], "title": "CustomerPriceResponse", "type": "object" }, "CustomerRateResponse": { "additionalProperties": false, "properties": { "amount": { "description": "Exact base-10 amount serialized without binary floating point or exponent notation.", "examples": [ "20.00" ], "pattern": "^-?(?:0|[1-9][0-9]*)(?:\\.[0-9]+)?$", "title": "Amount", "type": "string" }, "currencyCode": { "maxLength": 3, "minLength": 3, "title": "Currencycode", "type": "string" }, "perQuantity": { "minimum": 1.0, "title": "Perquantity", "type": "integer" } }, "required": [ "currencyCode", "amount", "perQuantity" ], "title": "CustomerRateResponse", "type": "object" }, "CustomerRowBudgetStatusResponse": { "additionalProperties": false, "properties": { "acceptedBudget": { "$ref": "#/components/schemas/CustomerMoneyResponse" }, "agreementRevision": { "minimum": 1.0, "title": "Agreementrevision", "type": "integer" }, "budgetRemaining": { "$ref": "#/components/schemas/CustomerMoneyResponse" }, "maximumBudget": { "$ref": "#/components/schemas/CustomerMoneyResponse" }, "mayChange": { "title": "Maychange", "type": "boolean" }, "periodId": { "minLength": 1, "title": "Periodid", "type": "string" } }, "required": [ "periodId", "agreementRevision", "acceptedBudget", "maximumBudget", "budgetRemaining", "mayChange" ], "title": "CustomerRowBudgetStatusResponse", "type": "object" }, "DatasetProfileResponse": { "additionalProperties": false, "properties": { "columns": { "additionalProperties": true, "title": "Columns", "type": "object" }, "datasetId": { "minLength": 1, "title": "Datasetid", "type": "string" }, "profile": { "additionalProperties": true, "title": "Profile", "type": "object" }, "rowCount": { "minimum": 0.0, "title": "Rowcount", "type": "integer" }, "sampleRows": { "items": { "additionalProperties": true, "type": "object" }, "title": "Samplerows", "type": "array" } }, "required": [ "datasetId", "rowCount", "columns", "sampleRows", "profile" ], "title": "DatasetProfileResponse", "type": "object" }, "DatasetQueryAliasResponse": { "additionalProperties": false, "properties": { "alias": { "title": "Alias", "type": "string" }, "columnMap": { "title": "Columnmap" }, "datasetId": { "minLength": 1, "title": "Datasetid", "type": "string" }, "rowCount": { "minimum": 0.0, "title": "Rowcount", "type": "integer" }, "schema": { "items": { "additionalProperties": true, "type": "object" }, "title": "Schema", "type": "array" }, "snapshotId": { "title": "Snapshotid", "type": "string" }, "sourceName": { "title": "Sourcename", "type": "string" } }, "required": [ "alias", "datasetId", "rowCount", "snapshotId", "sourceName" ], "title": "DatasetQueryAliasResponse", "type": "object" }, "DatasetQueryContextResponse": { "additionalProperties": false, "properties": { "aliases": { "items": { "$ref": "#/components/schemas/DatasetQueryAliasResponse" }, "title": "Aliases", "type": "array" } }, "title": "DatasetQueryContextResponse", "type": "object" }, "DatasetReadResponse": { "additionalProperties": false, "properties": { "columns": { "additionalProperties": true, "title": "Columns", "type": "object" }, "createdAt": { "description": "UTC RFC 3339 timestamp string.", "examples": [ "2026-06-12T12:00:00Z" ], "title": "Createdat", "type": "string" }, "id": { "minLength": 1, "title": "Id", "type": "string" }, "mcpCreation": { "anyOf": [ { "$ref": "#/components/schemas/McpCreationResponse" }, { "type": "null" } ] }, "orgId": { "minLength": 1, "title": "Orgid", "type": "string" }, "profile": { "additionalProperties": true, "title": "Profile", "type": "object" }, "rowCount": { "minimum": 0.0, "title": "Rowcount", "type": "integer" }, "sampleRows": { "items": { "additionalProperties": true, "type": "object" }, "title": "Samplerows", "type": "array" }, "sourceName": { "maxLength": 512, "title": "Sourcename", "type": "string" }, "sourceType": { "title": "Sourcetype", "type": "string" } }, "required": [ "id", "orgId", "sourceName", "sourceType", "rowCount", "columns", "sampleRows", "profile", "createdAt" ], "title": "DatasetReadResponse", "type": "object" }, "DatasetReferenceBody": { "additionalProperties": false, "properties": { "alias": { "title": "Alias", "type": "string" }, "datasetId": { "title": "Datasetid", "type": "string" } }, "required": [ "alias", "datasetId" ], "title": "DatasetReferenceBody", "type": "object" }, "DatasetRowResponse": { "additionalProperties": false, "properties": { "datasetId": { "minLength": 1, "title": "Datasetid", "type": "string" }, "id": { "minLength": 1, "title": "Id", "type": "string" }, "rowIndex": { "minimum": 0.0, "title": "Rowindex", "type": "integer" }, "values": { "additionalProperties": true, "title": "Values", "type": "object" } }, "required": [ "id", "datasetId", "rowIndex", "values" ], "title": "DatasetRowResponse", "type": "object" }, "DatasetUploadFailureResponse": { "additionalProperties": false, "properties": { "code": { "title": "Code", "type": "string" }, "docsUrl": { "title": "Docsurl", "type": "string" }, "fieldErrors": { "items": {}, "title": "Fielderrors", "type": "array" }, "message": { "title": "Message", "type": "string" }, "retryable": { "title": "Retryable", "type": "boolean" } }, "required": [ "code", "message", "retryable", "docsUrl", "fieldErrors" ], "title": "DatasetUploadFailureResponse", "type": "object" }, "DatasetUploadResponse": { "additionalProperties": false, "properties": { "bytesReceived": { "minimum": 0.0, "title": "Bytesreceived", "type": "integer" }, "completedAt": { "anyOf": [ { "description": "UTC RFC 3339 timestamp string.", "examples": [ "2026-06-12T12:00:00Z" ], "type": "string" }, { "type": "null" } ], "title": "Completedat" }, "contentType": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Contenttype" }, "createdAt": { "description": "UTC RFC 3339 timestamp string.", "examples": [ "2026-06-12T12:00:00Z" ], "title": "Createdat", "type": "string" }, "datasetId": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Datasetid" }, "expiredAt": { "anyOf": [ { "description": "UTC RFC 3339 timestamp string.", "examples": [ "2026-06-12T12:00:00Z" ], "type": "string" }, { "type": "null" } ], "title": "Expiredat" }, "failedAt": { "anyOf": [ { "description": "UTC RFC 3339 timestamp string.", "examples": [ "2026-06-12T12:00:00Z" ], "type": "string" }, { "type": "null" } ], "title": "Failedat" }, "failure": { "anyOf": [ { "$ref": "#/components/schemas/DatasetUploadFailureResponse" }, { "type": "null" } ] }, "id": { "minLength": 1, "title": "Id", "type": "string" }, "sizeBytes": { "minimum": 0.0, "title": "Sizebytes", "type": "integer" }, "sourceName": { "maxLength": 512, "title": "Sourcename", "type": "string" }, "sourceType": { "title": "Sourcetype", "type": "string" }, "status": { "enum": [ "processing", "completed", "failed", "expired" ], "title": "Status", "type": "string" } }, "required": [ "id", "status", "sourceType", "sourceName", "contentType", "sizeBytes", "bytesReceived", "datasetId", "failure", "createdAt", "completedAt", "failedAt", "expiredAt" ], "title": "DatasetUploadResponse", "type": "object" }, "DurableRowHistoryItemResponse": { "additionalProperties": false, "properties": { "actionAttemptId": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Actionattemptid" }, "actionId": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Actionid" }, "attemptId": { "minLength": 1, "title": "Attemptid", "type": "string" }, "data": { "additionalProperties": true, "title": "Data", "type": "object" }, "eventId": { "minLength": 1, "title": "Eventid", "type": "string" }, "kind": { "minLength": 1, "title": "Kind", "type": "string" }, "observedAt": { "description": "UTC RFC 3339 timestamp string.", "examples": [ "2026-06-12T12:00:00Z" ], "title": "Observedat", "type": "string" }, "sequence": { "minimum": 1.0, "title": "Sequence", "type": "integer" }, "stepId": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Stepid" } }, "required": [ "eventId", "sequence", "attemptId", "kind", "observedAt", "data" ], "title": "DurableRowHistoryItemResponse", "type": "object" }, "ExportCreateRequestBody": { "additionalProperties": false, "properties": { "fileName": { "default": "result.csv", "maxLength": 128, "title": "Filename", "type": "string" }, "format": { "const": "csv", "title": "Format", "type": "string" }, "type": { "enum": [ "all_rows", "successful_rows", "failed_rows", "flagged_rows", "generated_outputs", "resolved_lineage_results" ], "title": "Type", "type": "string" } }, "required": [ "type", "format" ], "title": "ExportCreateRequestBody", "type": "object" }, "ExportResponse": { "additionalProperties": false, "properties": { "completedAt": { "anyOf": [ { "description": "UTC RFC 3339 timestamp string.", "examples": [ "2026-06-12T12:00:00Z" ], "type": "string" }, { "type": "null" } ], "title": "Completedat" }, "createdAt": { "anyOf": [ { "description": "UTC RFC 3339 timestamp string.", "examples": [ "2026-06-12T12:00:00Z" ], "type": "string" }, { "type": "null" } ], "title": "Createdat" }, "downloadReady": { "title": "Downloadready", "type": "boolean" }, "downloadUrl": { "title": "Downloadurl", "type": "string" }, "downloadUrlExpiresAt": { "anyOf": [ { "description": "UTC RFC 3339 timestamp string.", "examples": [ "2026-06-12T12:00:00Z" ], "type": "string" }, { "type": "null" } ], "title": "Downloadurlexpiresat" }, "expiresAt": { "anyOf": [ { "description": "UTC RFC 3339 timestamp string.", "examples": [ "2026-06-12T12:00:00Z" ], "type": "string" }, { "type": "null" } ], "title": "Expiresat" }, "failure": { "anyOf": [ {}, { "type": "null" } ], "title": "Failure" }, "format": { "const": "csv", "title": "Format", "type": "string" }, "id": { "minLength": 1, "title": "Id", "type": "string" }, "mcpCreation": { "anyOf": [ { "$ref": "#/components/schemas/McpCreationResponse" }, { "type": "null" } ] }, "runId": { "minLength": 1, "title": "Runid", "type": "string" }, "status": { "enum": [ "queued", "generating", "ready", "failed", "expired" ], "title": "Status", "type": "string" }, "type": { "enum": [ "all_rows", "successful_rows", "failed_rows", "flagged_rows", "generated_outputs", "resolved_lineage_results" ], "title": "Type", "type": "string" } }, "required": [ "id", "runId", "type", "format", "status", "downloadReady", "downloadUrl", "downloadUrlExpiresAt", "failure", "completedAt", "expiresAt", "createdAt" ], "title": "ExportResponse", "type": "object" }, "FailureAttemptContextResponse": { "additionalProperties": false, "properties": { "attemptNumber": { "anyOf": [ { "minimum": 1.0, "type": "integer" }, { "type": "null" } ], "title": "Attemptnumber" }, "completedAt": { "anyOf": [ { "description": "UTC RFC 3339 timestamp string.", "examples": [ "2026-06-12T12:00:00Z" ], "type": "string" }, { "type": "null" } ], "title": "Completedat" }, "modelUsage": { "$ref": "#/components/schemas/AttemptModelUsageSummary" }, "rowExecutionAttemptId": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Rowexecutionattemptid" }, "startedAt": { "anyOf": [ { "description": "UTC RFC 3339 timestamp string.", "examples": [ "2026-06-12T12:00:00Z" ], "type": "string" }, { "type": "null" } ], "title": "Startedat" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" } }, "required": [ "rowExecutionAttemptId", "modelUsage" ], "title": "FailureAttemptContextResponse", "type": "object" }, "FailurePayloadResponse": { "additionalProperties": false, "properties": { "artifact": { "anyOf": [ {}, { "type": "null" } ], "title": "Artifact" }, "code": { "title": "Code", "type": "string" }, "details": { "additionalProperties": true, "title": "Details", "type": "object" }, "message": { "title": "Message", "type": "string" }, "phase": { "enum": [ "dataset", "job_spec", "run", "row", "model", "tool", "output", "validation", "export", "alert", "system" ], "title": "Phase", "type": "string" }, "recommendedAction": { "enum": [ "retry_run", "edit_job_spec", "check_dataset", "contact_support", "none" ], "title": "Recommendedaction", "type": "string" }, "retryable": { "title": "Retryable", "type": "boolean" }, "severity": { "enum": [ "warning", "error", "fatal" ], "title": "Severity", "type": "string" }, "userActionable": { "title": "Useractionable", "type": "boolean" } }, "required": [ "phase", "code", "message", "severity", "retryable", "userActionable", "recommendedAction", "details" ], "title": "FailurePayloadResponse", "type": "object" }, "FailureResponse": { "additionalProperties": false, "properties": { "attemptContext": { "$ref": "#/components/schemas/FailureAttemptContextResponse" }, "completedAt": { "anyOf": [ { "description": "UTC RFC 3339 timestamp string.", "examples": [ "2026-06-12T12:00:00Z" ], "type": "string" }, { "type": "null" } ], "title": "Completedat" }, "datasetRowId": { "minLength": 1, "title": "Datasetrowid", "type": "string" }, "failure": { "$ref": "#/components/schemas/FailurePayloadResponse" }, "relatedEvents": { "items": { "$ref": "#/components/schemas/RunEventResponse" }, "title": "Relatedevents", "type": "array" }, "rowIndex": { "minimum": 0.0, "title": "Rowindex", "type": "integer" }, "runId": { "minLength": 1, "title": "Runid", "type": "string" }, "runRowId": { "minLength": 1, "title": "Runrowid", "type": "string" }, "sourcePreview": { "additionalProperties": true, "title": "Sourcepreview", "type": "object" }, "state": { "enum": [ "pending", "running", "succeeded", "flagged", "failed", "skipped" ], "title": "State", "type": "string" }, "validationErrors": { "items": {}, "title": "Validationerrors", "type": "array" } }, "required": [ "runId", "runRowId", "datasetRowId", "rowIndex", "state", "failure", "validationErrors", "sourcePreview", "attemptContext", "relatedEvents", "completedAt" ], "title": "FailureResponse", "type": "object" }, "ForkJobSpecRequestBody": { "additionalProperties": false, "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "sourceVersionId": { "minLength": 1, "title": "Sourceversionid", "type": "string" } }, "required": [ "sourceVersionId" ], "title": "ForkJobSpecRequestBody", "type": "object" }, "HumanMembershipResponse": { "additionalProperties": false, "properties": { "createdAt": { "description": "UTC RFC 3339 timestamp string.", "examples": [ "2026-06-12T12:00:00Z" ], "title": "Createdat", "type": "string" }, "id": { "minLength": 1, "title": "Id", "type": "string" }, "organizationId": { "minLength": 1, "title": "Organizationid", "type": "string" }, "organizationName": { "title": "Organizationname", "type": "string" }, "role": { "title": "Role", "type": "string" }, "updatedAt": { "description": "UTC RFC 3339 timestamp string.", "examples": [ "2026-06-12T12:00:00Z" ], "title": "Updatedat", "type": "string" } }, "required": [ "id", "organizationId", "organizationName", "role", "createdAt", "updatedAt" ], "title": "HumanMembershipResponse", "type": "object" }, "HumanPrincipalResponse": { "additionalProperties": false, "properties": { "organizations": { "items": { "$ref": "#/components/schemas/HumanMembershipResponse" }, "title": "Organizations", "type": "array" }, "type": { "const": "human", "title": "Type", "type": "string" }, "user": { "$ref": "#/components/schemas/HumanUserResponse" } }, "required": [ "type", "user", "organizations" ], "title": "HumanPrincipalResponse", "type": "object" }, "HumanUserResponse": { "additionalProperties": false, "properties": { "companyName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Companyname" }, "displayName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Displayname" }, "email": { "title": "Email", "type": "string" }, "id": { "minLength": 1, "title": "Id", "type": "string" } }, "required": [ "id", "email", "displayName", "companyName" ], "title": "HumanUserResponse", "type": "object" }, "InertConnectionRequirementResponse": { "additionalProperties": false, "properties": { "requirementKey": { "title": "Requirementkey", "type": "string" }, "serverLabel": { "title": "Serverlabel", "type": "string" }, "tools": { "items": { "$ref": "#/components/schemas/InertConnectionToolResponse" }, "title": "Tools", "type": "array" } }, "required": [ "requirementKey", "serverLabel", "tools" ], "title": "InertConnectionRequirementResponse", "type": "object" }, "InertConnectionToolResponse": { "additionalProperties": false, "properties": { "name": { "title": "Name", "type": "string" }, "schemaFingerprint": { "title": "Schemafingerprint", "type": "string" } }, "required": [ "name", "schemaFingerprint" ], "title": "InertConnectionToolResponse", "type": "object" }, "JobOwnerResponse": { "additionalProperties": false, "properties": { "userId": { "minLength": 1, "title": "Userid", "type": "string" } }, "required": [ "userId" ], "title": "JobOwnerResponse", "type": "object" }, "JobRunHistoryResponse": { "additionalProperties": false, "properties": { "completedAt": { "anyOf": [ { "description": "UTC RFC 3339 timestamp string.", "examples": [ "2026-06-12T12:00:00Z" ], "type": "string" }, { "type": "null" } ], "title": "Completedat" }, "createdAt": { "description": "UTC RFC 3339 timestamp string.", "examples": [ "2026-06-12T12:00:00Z" ], "title": "Createdat", "type": "string" }, "datasetId": { "minLength": 1, "title": "Datasetid", "type": "string" }, "datasetSourceName": { "title": "Datasetsourcename", "type": "string" }, "id": { "minLength": 1, "title": "Id", "type": "string" }, "jobSpecVersion": { "minimum": 1.0, "title": "Jobspecversion", "type": "integer" }, "jobSpecVersionId": { "minLength": 1, "title": "Jobspecversionid", "type": "string" }, "mode": { "enum": [ "add_columns", "create_rows" ], "title": "Mode", "type": "string" }, "rowCounts": { "$ref": "#/components/schemas/RunRowCountsResponse" }, "startedAt": { "anyOf": [ { "description": "UTC RFC 3339 timestamp string.", "examples": [ "2026-06-12T12:00:00Z" ], "type": "string" }, { "type": "null" } ], "title": "Startedat" }, "state": { "enum": [ "draft", "queued", "running", "paused", "succeeded", "completed_with_flags", "failed", "canceled" ], "title": "State", "type": "string" } }, "required": [ "id", "state", "datasetId", "datasetSourceName", "jobSpecVersionId", "jobSpecVersion", "mode", "rowCounts", "createdAt", "startedAt", "completedAt" ], "title": "JobRunHistoryResponse", "type": "object" }, "JobSpecDetailResponse": { "additionalProperties": false, "properties": { "canEdit": { "title": "Canedit", "type": "boolean" }, "canFork": { "title": "Canfork", "type": "boolean" }, "canRun": { "title": "Canrun", "type": "boolean" }, "connectionRequirements": { "items": { "$ref": "#/components/schemas/InertConnectionRequirementResponse" }, "title": "Connectionrequirements", "type": "array" }, "createdAt": { "description": "UTC RFC 3339 timestamp string.", "examples": [ "2026-06-12T12:00:00Z" ], "title": "Createdat", "type": "string" }, "currentVersionId": { "minLength": 1, "title": "Currentversionid", "type": "string" }, "forkedFromJobSpecVersionId": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Forkedfromjobspecversionid" }, "id": { "minLength": 1, "title": "Id", "type": "string" }, "lastRunAt": { "anyOf": [ { "description": "UTC RFC 3339 timestamp string.", "examples": [ "2026-06-12T12:00:00Z" ], "type": "string" }, { "type": "null" } ], "title": "Lastrunat" }, "lastRunState": { "anyOf": [ { "enum": [ "draft", "queued", "running", "paused", "succeeded", "completed_with_flags", "failed", "canceled" ], "type": "string" }, { "type": "null" } ], "title": "Lastrunstate" }, "name": { "title": "Name", "type": "string" }, "orgId": { "minLength": 1, "title": "Orgid", "type": "string" }, "owner": { "anyOf": [ { "$ref": "#/components/schemas/JobOwnerResponse" }, { "type": "null" } ] }, "runCount": { "minimum": 0.0, "title": "Runcount", "type": "integer" }, "updatedAt": { "anyOf": [ { "description": "UTC RFC 3339 timestamp string.", "examples": [ "2026-06-12T12:00:00Z" ], "type": "string" }, { "type": "null" } ], "title": "Updatedat" }, "version": { "$ref": "#/components/schemas/JobSpecVersionResponse" } }, "required": [ "id", "orgId", "name", "owner", "forkedFromJobSpecVersionId", "canEdit", "canFork", "canRun", "connectionRequirements", "currentVersionId", "version", "createdAt", "updatedAt", "lastRunAt", "lastRunState", "runCount" ], "title": "JobSpecDetailResponse", "type": "object" }, "JobSpecRequestBody": { "additionalProperties": false, "properties": { "description": { "title": "Description", "type": "string" }, "mode": { "title": "Mode", "type": "string" }, "model": { "title": "Model", "type": "string" }, "name": { "title": "Name", "type": "string" }, "outputSchema": { "additionalProperties": true, "title": "Outputschema", "type": "object" }, "prompt": { "title": "Prompt", "type": "string" }, "toolsets": { "items": { "type": "string" }, "title": "Toolsets", "type": "array" } }, "required": [ "name", "description", "mode", "prompt", "model", "outputSchema" ], "title": "JobSpecRequestBody", "type": "object" }, "JobSpecResponse": { "additionalProperties": false, "properties": { "canEdit": { "title": "Canedit", "type": "boolean" }, "canFork": { "title": "Canfork", "type": "boolean" }, "canRun": { "title": "Canrun", "type": "boolean" }, "connectionRequirements": { "items": { "$ref": "#/components/schemas/InertConnectionRequirementResponse" }, "title": "Connectionrequirements", "type": "array" }, "createdAt": { "description": "UTC RFC 3339 timestamp string.", "examples": [ "2026-06-12T12:00:00Z" ], "title": "Createdat", "type": "string" }, "currentVersionId": { "minLength": 1, "title": "Currentversionid", "type": "string" }, "forkedFromJobSpecVersionId": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Forkedfromjobspecversionid" }, "id": { "minLength": 1, "title": "Id", "type": "string" }, "name": { "title": "Name", "type": "string" }, "orgId": { "minLength": 1, "title": "Orgid", "type": "string" }, "owner": { "anyOf": [ { "$ref": "#/components/schemas/JobOwnerResponse" }, { "type": "null" } ] }, "updatedAt": { "anyOf": [ { "description": "UTC RFC 3339 timestamp string.", "examples": [ "2026-06-12T12:00:00Z" ], "type": "string" }, { "type": "null" } ], "title": "Updatedat" }, "version": { "$ref": "#/components/schemas/JobSpecVersionResponse" } }, "required": [ "id", "orgId", "name", "owner", "forkedFromJobSpecVersionId", "canEdit", "canFork", "canRun", "connectionRequirements", "currentVersionId", "version", "createdAt", "updatedAt" ], "title": "JobSpecResponse", "type": "object" }, "JobSpecSummaryResponse": { "additionalProperties": false, "properties": { "canEdit": { "title": "Canedit", "type": "boolean" }, "canFork": { "title": "Canfork", "type": "boolean" }, "canRun": { "title": "Canrun", "type": "boolean" }, "connectionRequirements": { "items": { "$ref": "#/components/schemas/InertConnectionRequirementResponse" }, "title": "Connectionrequirements", "type": "array" }, "createdAt": { "description": "UTC RFC 3339 timestamp string.", "examples": [ "2026-06-12T12:00:00Z" ], "title": "Createdat", "type": "string" }, "currentVersionId": { "minLength": 1, "title": "Currentversionid", "type": "string" }, "forkedFromJobSpecVersionId": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Forkedfromjobspecversionid" }, "id": { "minLength": 1, "title": "Id", "type": "string" }, "lastRunAt": { "anyOf": [ { "description": "UTC RFC 3339 timestamp string.", "examples": [ "2026-06-12T12:00:00Z" ], "type": "string" }, { "type": "null" } ], "title": "Lastrunat" }, "lastRunState": { "anyOf": [ { "enum": [ "draft", "queued", "running", "paused", "succeeded", "completed_with_flags", "failed", "canceled" ], "type": "string" }, { "type": "null" } ], "title": "Lastrunstate" }, "name": { "title": "Name", "type": "string" }, "orgId": { "minLength": 1, "title": "Orgid", "type": "string" }, "owner": { "anyOf": [ { "$ref": "#/components/schemas/JobOwnerResponse" }, { "type": "null" } ] }, "runCount": { "minimum": 0.0, "title": "Runcount", "type": "integer" }, "updatedAt": { "anyOf": [ { "description": "UTC RFC 3339 timestamp string.", "examples": [ "2026-06-12T12:00:00Z" ], "type": "string" }, { "type": "null" } ], "title": "Updatedat" }, "version": { "$ref": "#/components/schemas/JobSpecVersionResponse" } }, "required": [ "id", "orgId", "name", "owner", "forkedFromJobSpecVersionId", "canEdit", "canFork", "canRun", "connectionRequirements", "currentVersionId", "version", "createdAt", "updatedAt", "lastRunAt", "lastRunState", "runCount" ], "title": "JobSpecSummaryResponse", "type": "object" }, "JobSpecUpdateRequestBody": { "additionalProperties": false, "properties": { "description": { "title": "Description", "type": "string" }, "mode": { "title": "Mode", "type": "string" }, "model": { "title": "Model", "type": "string" }, "name": { "title": "Name", "type": "string" }, "outputSchema": { "additionalProperties": true, "title": "Outputschema", "type": "object" }, "prompt": { "title": "Prompt", "type": "string" }, "toolsets": { "items": { "type": "string" }, "title": "Toolsets", "type": "array" } }, "required": [ "name", "description", "mode", "prompt", "model", "outputSchema" ], "title": "JobSpecUpdateRequestBody", "type": "object" }, "JobSpecVersionResponse": { "additionalProperties": false, "properties": { "createdAt": { "description": "UTC RFC 3339 timestamp string.", "examples": [ "2026-06-12T12:00:00Z" ], "title": "Createdat", "type": "string" }, "description": { "title": "Description", "type": "string" }, "id": { "minLength": 1, "title": "Id", "type": "string" }, "jobSpecId": { "minLength": 1, "title": "Jobspecid", "type": "string" }, "mcpCreation": { "anyOf": [ { "$ref": "#/components/schemas/McpCreationResponse" }, { "type": "null" } ] }, "mode": { "title": "Mode", "type": "string" }, "model": { "title": "Model", "type": "string" }, "modelVersionId": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Modelversionid" }, "outputSchema": { "additionalProperties": true, "title": "Outputschema", "type": "object" }, "prompt": { "title": "Prompt", "type": "string" }, "toolsets": { "items": { "type": "string" }, "title": "Toolsets", "type": "array" }, "version": { "title": "Version", "type": "integer" } }, "required": [ "id", "jobSpecId", "version", "description", "mode", "prompt", "model", "modelVersionId", "outputSchema", "toolsets", "createdAt" ], "title": "JobSpecVersionResponse", "type": "object" }, "LegacyRowHistoryItemResponse": { "additionalProperties": false, "properties": { "attemptId": { "title": "Attemptid", "type": "null" }, "data": { "additionalProperties": true, "title": "Data", "type": "object" }, "eventId": { "minLength": 1, "title": "Eventid", "type": "string" }, "kind": { "enum": [ "legacy.message", "legacy.event" ], "title": "Kind", "type": "string" }, "observedAt": { "title": "Observedat", "type": "null" }, "section": { "enum": [ "message", "event" ], "title": "Section", "type": "string" }, "sectionOrdinal": { "minimum": 0.0, "title": "Sectionordinal", "type": "integer" }, "sequence": { "title": "Sequence", "type": "null" } }, "required": [ "eventId", "sequence", "attemptId", "kind", "observedAt", "section", "sectionOrdinal", "data" ], "title": "LegacyRowHistoryItemResponse", "type": "object" }, "ManagedAiBalanceResponse": { "additionalProperties": false, "properties": { "calculatedAt": { "format": "date-time", "title": "Calculatedat", "type": "string" }, "executionSafe": { "anyOf": [ { "$ref": "#/components/schemas/CustomerMoneyResponse" }, { "type": "null" } ], "description": "Execution-safe managed-AI balance at calculatedAt: the value runtime admission would fund new work against, net of open per-action holds. Advisory, not a reservation. Settlement drains the wallet asynchronously after rows complete, so recently finished work may not be reflected yet, and concurrent runs can still exhaust the wallet mid-run. Model-agnostic: admission reserves a per-turn bound that varies by model, so a small positive balance may still be denied as insufficient for a single turn of an expensive model. A run that outspends the wallet pauses with resumeAvailable rather than losing work, its unfunded rows failing as billing.wallet_admission_denied (agent-query runs pause with reason cached_balance_exhausted). Null when no balance can be stated — the organization has never been granted managed-AI value, or its ledger could not currently be read; spendingAllowed is false in both cases, while a drained wallet reads \"0.00\"." }, "spendingAllowed": { "description": "Whether the organization's billing state permits new paid work. False while a financial hold, an unpaid-invoice suspension, or missing paid-period authority stands against the account, regardless of remaining balance. Create, start, and resume refuse those same states; treat false as do-not-start-paid-work. A watcher already draining a running run may still send until its pause-cache snapshot re-reads zero.", "title": "Spendingallowed", "type": "boolean" }, "status": { "enum": [ "available", "low", "unavailable" ], "title": "Status", "type": "string" } }, "required": [ "calculatedAt", "spendingAllowed", "executionSafe", "status" ], "title": "ManagedAiBalanceResponse", "type": "object" }, "ManagedAiUsageComponentResponse": { "additionalProperties": false, "properties": { "activeHoldAmount": { "description": "Decimal amount serialized as a string to preserve precision.", "examples": [ "0.000000000000000000" ], "title": "Activeholdamount", "type": "string" }, "activeHolds": { "minimum": 0.0, "title": "Activeholds", "type": "integer" }, "committedAmount": { "description": "Decimal amount serialized as a string to preserve precision.", "examples": [ "0.000000000000000000" ], "title": "Committedamount", "type": "string" }, "settledActions": { "minimum": 0.0, "title": "Settledactions", "type": "integer" }, "settledAmount": { "description": "Decimal amount serialized as a string to preserve precision.", "examples": [ "0.000000000000000000" ], "title": "Settledamount", "type": "string" } }, "required": [ "settledAmount", "activeHoldAmount", "committedAmount", "settledActions", "activeHolds" ], "title": "ManagedAiUsageComponentResponse", "type": "object" }, "ManagedAiUsageSummaryResponse": { "additionalProperties": false, "description": "Exact customer-wallet value attributable to a run or row.", "properties": { "activeHoldAmount": { "description": "Decimal amount serialized as a string to preserve precision.", "examples": [ "0.000000000000000000" ], "title": "Activeholdamount", "type": "string" }, "committedAmount": { "description": "Decimal amount serialized as a string to preserve precision.", "examples": [ "0.000000000000000000" ], "title": "Committedamount", "type": "string" }, "currencyCode": { "maxLength": 3, "minLength": 3, "title": "Currencycode", "type": "string" }, "model": { "$ref": "#/components/schemas/ManagedAiUsageComponentResponse" }, "paidTools": { "$ref": "#/components/schemas/ManagedAiUsageComponentResponse" }, "settledAmount": { "description": "Decimal amount serialized as a string to preserve precision.", "examples": [ "0.000000000000000000" ], "title": "Settledamount", "type": "string" } }, "required": [ "currencyCode", "settledAmount", "activeHoldAmount", "committedAmount", "model", "paidTools" ], "title": "ManagedAiUsageSummaryResponse", "type": "object" }, "McpCreationResponse": { "additionalProperties": false, "description": "Smallest safe MCP attribution for product reads.\n\nServer-derived only. Omits grant id, actor id, organization id, role,\nscopes, tokens, and raw OAuth identifiers.", "properties": { "channel": { "const": "mcp", "title": "Channel", "type": "string" }, "clientId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Clientid" }, "principalType": { "enum": [ "workos_jwt", "api_key" ], "title": "Principaltype", "type": "string" } }, "required": [ "channel", "principalType" ], "title": "McpCreationResponse", "type": "object" }, "MeResponse": { "additionalProperties": false, "properties": { "principal": { "discriminator": { "mapping": { "api_key": "#/components/schemas/ApiKeyPrincipalResponse", "human": "#/components/schemas/HumanPrincipalResponse" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/HumanPrincipalResponse" }, { "$ref": "#/components/schemas/ApiKeyPrincipalResponse" } ], "title": "Principal" } }, "required": [ "principal" ], "title": "MeResponse", "type": "object" }, "ModelCapabilitiesResponse": { "additionalProperties": false, "properties": { "images": { "title": "Images", "type": "boolean" }, "structuredOutput": { "title": "Structuredoutput", "type": "boolean" }, "text": { "title": "Text", "type": "boolean" }, "tools": { "title": "Tools", "type": "boolean" } }, "required": [ "text", "images", "tools", "structuredOutput" ], "title": "ModelCapabilitiesResponse", "type": "object" }, "ModelDiscoveryStateResponse": { "additionalProperties": false, "properties": { "blockerReasonCodes": { "items": { "type": "string" }, "title": "Blockerreasoncodes", "type": "array" }, "recommended": { "title": "Recommended", "type": "boolean" }, "runnable": { "title": "Runnable", "type": "boolean" }, "warningReasonCodes": { "items": { "type": "string" }, "title": "Warningreasoncodes", "type": "array" } }, "required": [ "runnable", "recommended", "blockerReasonCodes", "warningReasonCodes" ], "title": "ModelDiscoveryStateResponse", "type": "object" }, "ModelObservationResponse": { "additionalProperties": false, "properties": { "accountVisible": { "title": "Accountvisible", "type": "boolean" }, "capabilities": { "additionalProperties": true, "title": "Capabilities", "type": "object" }, "displayName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Displayname" }, "freshness": { "title": "Freshness", "type": "string" }, "maxInputTokens": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Maxinputtokens" }, "maxOutputTokens": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Maxoutputtokens" }, "observedAt": { "description": "UTC RFC 3339 timestamp string.", "examples": [ "2026-06-12T12:00:00Z" ], "title": "Observedat", "type": "string" }, "refreshId": { "minLength": 1, "title": "Refreshid", "type": "string" }, "releaseTime": { "anyOf": [ { "description": "UTC RFC 3339 timestamp string.", "examples": [ "2026-06-12T12:00:00Z" ], "type": "string" }, { "type": "null" } ], "title": "Releasetime" } }, "required": [ "refreshId", "observedAt", "freshness", "accountVisible", "displayName", "releaseTime", "maxInputTokens", "maxOutputTokens", "capabilities" ], "title": "ModelObservationResponse", "type": "object" }, "ModelProviderResponse": { "additionalProperties": false, "properties": { "createdAt": { "description": "UTC RFC 3339 timestamp string.", "examples": [ "2026-06-12T12:00:00Z" ], "title": "Createdat", "type": "string" }, "displayName": { "title": "Displayname", "type": "string" }, "id": { "minLength": 1, "title": "Id", "type": "string" }, "providerKey": { "title": "Providerkey", "type": "string" }, "status": { "title": "Status", "type": "string" }, "updatedAt": { "description": "UTC RFC 3339 timestamp string.", "examples": [ "2026-06-12T12:00:00Z" ], "title": "Updatedat", "type": "string" } }, "required": [ "id", "providerKey", "displayName", "status", "createdAt", "updatedAt" ], "title": "ModelProviderResponse", "type": "object" }, "ModelResponse": { "additionalProperties": false, "properties": { "capabilities": { "$ref": "#/components/schemas/ModelCapabilitiesResponse" }, "contextWindowTokens": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Contextwindowtokens" }, "customerPrice": { "anyOf": [ { "$ref": "#/components/schemas/CustomerPriceResponse" }, { "type": "null" } ] }, "discovery": { "$ref": "#/components/schemas/ModelDiscoveryStateResponse" }, "displayName": { "title": "Displayname", "type": "string" }, "id": { "minLength": 1, "title": "Id", "type": "string" }, "maxOutputTokens": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Maxoutputtokens" }, "model": { "title": "Model", "type": "string" }, "modelVersion": { "title": "Modelversion", "type": "integer" }, "modelVersionId": { "title": "Modelversionid", "type": "string" }, "notBillable": { "title": "Notbillable", "type": "boolean" }, "observation": { "anyOf": [ { "$ref": "#/components/schemas/ModelObservationResponse" }, { "type": "null" } ] }, "pricingStatus": { "title": "Pricingstatus", "type": "string" }, "providerKey": { "title": "Providerkey", "type": "string" }, "providerListPrice": { "anyOf": [ { "$ref": "#/components/schemas/ProviderListPriceResponse" }, { "type": "null" } ] }, "providerModelId": { "title": "Providermodelid", "type": "string" }, "selectionTier": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Selectiontier" }, "status": { "title": "Status", "type": "string" }, "versionStatus": { "title": "Versionstatus", "type": "string" } }, "required": [ "id", "model", "providerKey", "providerModelId", "modelVersionId", "status", "versionStatus", "pricingStatus", "notBillable", "displayName", "selectionTier", "modelVersion", "contextWindowTokens", "maxOutputTokens", "capabilities", "discovery", "observation", "providerListPrice", "customerPrice" ], "title": "ModelResponse", "type": "object" }, "ModelUsageSummary": { "additionalProperties": false, "properties": { "inputTokens": { "minimum": 0.0, "title": "Inputtokens", "type": "integer" }, "outputTokens": { "minimum": 0.0, "title": "Outputtokens", "type": "integer" }, "providerAttempts": { "$ref": "#/components/schemas/ProviderAttemptsSummary" }, "providerCost": { "$ref": "#/components/schemas/ProviderCostSummary" }, "totalTokens": { "minimum": 0.0, "title": "Totaltokens", "type": "integer" } }, "required": [ "inputTokens", "outputTokens", "totalTokens", "providerAttempts", "providerCost" ], "title": "ModelUsageSummary", "type": "object" }, "OrganizationCreateRequest": { "additionalProperties": false, "properties": { "name": { "maxLength": 200, "minLength": 1, "title": "Name", "type": "string" } }, "required": [ "name" ], "title": "OrganizationCreateRequest", "type": "object" }, "OrganizationInvitationCreateRequest": { "additionalProperties": false, "properties": { "email": { "title": "Email", "type": "string" }, "expiresAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Expiresat" }, "role": { "title": "Role", "type": "string" } }, "required": [ "email", "role" ], "title": "OrganizationInvitationCreateRequest", "type": "object" }, "OrganizationInvitationResponse": { "additionalProperties": false, "properties": { "acceptedAt": { "anyOf": [ { "description": "UTC RFC 3339 timestamp string.", "examples": [ "2026-06-12T12:00:00Z" ], "type": "string" }, { "type": "null" } ], "title": "Acceptedat" }, "acceptedByUserId": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Acceptedbyuserid" }, "createdAt": { "description": "UTC RFC 3339 timestamp string.", "examples": [ "2026-06-12T12:00:00Z" ], "title": "Createdat", "type": "string" }, "createdByUserId": { "minLength": 1, "title": "Createdbyuserid", "type": "string" }, "email": { "title": "Email", "type": "string" }, "expiresAt": { "anyOf": [ { "description": "UTC RFC 3339 timestamp string.", "examples": [ "2026-06-12T12:00:00Z" ], "type": "string" }, { "type": "null" } ], "title": "Expiresat" }, "id": { "minLength": 1, "title": "Id", "type": "string" }, "organizationId": { "minLength": 1, "title": "Organizationid", "type": "string" }, "revokedAt": { "anyOf": [ { "description": "UTC RFC 3339 timestamp string.", "examples": [ "2026-06-12T12:00:00Z" ], "type": "string" }, { "type": "null" } ], "title": "Revokedat" }, "revokedByUserId": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Revokedbyuserid" }, "role": { "title": "Role", "type": "string" }, "status": { "title": "Status", "type": "string" }, "updatedAt": { "description": "UTC RFC 3339 timestamp string.", "examples": [ "2026-06-12T12:00:00Z" ], "title": "Updatedat", "type": "string" } }, "required": [ "id", "organizationId", "email", "role", "status", "createdByUserId", "revokedByUserId", "acceptedByUserId", "expiresAt", "revokedAt", "acceptedAt", "createdAt", "updatedAt" ], "title": "OrganizationInvitationResponse", "type": "object" }, "OrganizationMemberResponse": { "additionalProperties": false, "properties": { "createdAt": { "description": "UTC RFC 3339 timestamp string.", "examples": [ "2026-06-12T12:00:00Z" ], "title": "Createdat", "type": "string" }, "displayName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Displayname" }, "email": { "title": "Email", "type": "string" }, "id": { "minLength": 1, "title": "Id", "type": "string" }, "organizationId": { "minLength": 1, "title": "Organizationid", "type": "string" }, "removedAt": { "anyOf": [ { "description": "UTC RFC 3339 timestamp string.", "examples": [ "2026-06-12T12:00:00Z" ], "type": "string" }, { "type": "null" } ], "title": "Removedat" }, "role": { "title": "Role", "type": "string" }, "status": { "title": "Status", "type": "string" }, "updatedAt": { "description": "UTC RFC 3339 timestamp string.", "examples": [ "2026-06-12T12:00:00Z" ], "title": "Updatedat", "type": "string" }, "userId": { "minLength": 1, "title": "Userid", "type": "string" } }, "required": [ "id", "organizationId", "userId", "email", "displayName", "role", "status", "createdAt", "updatedAt", "removedAt" ], "title": "OrganizationMemberResponse", "type": "object" }, "OrganizationMemberUpdateRequest": { "additionalProperties": false, "properties": { "role": { "title": "Role", "type": "string" } }, "required": [ "role" ], "title": "OrganizationMemberUpdateRequest", "type": "object" }, "OrganizationResponse": { "additionalProperties": false, "properties": { "createdAt": { "description": "UTC RFC 3339 timestamp string.", "examples": [ "2026-06-12T12:00:00Z" ], "title": "Createdat", "type": "string" }, "id": { "minLength": 1, "title": "Id", "type": "string" }, "membership": { "anyOf": [ { "$ref": "#/components/schemas/HumanMembershipResponse" }, { "type": "null" } ] }, "name": { "title": "Name", "type": "string" }, "updatedAt": { "description": "UTC RFC 3339 timestamp string.", "examples": [ "2026-06-12T12:00:00Z" ], "title": "Updatedat", "type": "string" } }, "required": [ "id", "name", "createdAt", "updatedAt" ], "title": "OrganizationResponse", "type": "object" }, "OrganizationUpdateRequest": { "additionalProperties": false, "properties": { "name": { "maxLength": 200, "minLength": 1, "title": "Name", "type": "string" } }, "required": [ "name" ], "title": "OrganizationUpdateRequest", "type": "object" }, "OutputDetailResponse": { "additionalProperties": false, "properties": { "createdAt": { "description": "UTC RFC 3339 timestamp string.", "examples": [ "2026-06-12T12:00:00Z" ], "title": "Createdat", "type": "string" }, "datasetRowId": { "minLength": 1, "title": "Datasetrowid", "type": "string" }, "generatedRows": { "items": { "additionalProperties": true, "type": "object" }, "title": "Generatedrows", "type": "array" }, "generatedRowsCount": { "minimum": 0.0, "title": "Generatedrowscount", "type": "integer" }, "id": { "minLength": 1, "title": "Id", "type": "string" }, "mode": { "enum": [ "add_columns", "create_rows" ], "title": "Mode", "type": "string" }, "rowIndex": { "minimum": 0.0, "title": "Rowindex", "type": "integer" }, "runId": { "minLength": 1, "title": "Runid", "type": "string" }, "runRowId": { "minLength": 1, "title": "Runrowid", "type": "string" }, "validation": { "$ref": "#/components/schemas/OutputValidationResponse" }, "values": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Values" } }, "required": [ "id", "runId", "runRowId", "datasetRowId", "rowIndex", "mode", "values", "generatedRows", "generatedRowsCount", "validation", "createdAt" ], "title": "OutputDetailResponse", "type": "object" }, "OutputListItemResponse": { "additionalProperties": false, "properties": { "createdAt": { "description": "UTC RFC 3339 timestamp string.", "examples": [ "2026-06-12T12:00:00Z" ], "title": "Createdat", "type": "string" }, "datasetRowId": { "minLength": 1, "title": "Datasetrowid", "type": "string" }, "generatedRowIndex": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Generatedrowindex" }, "id": { "minLength": 1, "title": "Id", "type": "string" }, "mode": { "enum": [ "add_columns", "create_rows" ], "title": "Mode", "type": "string" }, "rowIndex": { "minimum": 0.0, "title": "Rowindex", "type": "integer" }, "runId": { "minLength": 1, "title": "Runid", "type": "string" }, "runRowId": { "minLength": 1, "title": "Runrowid", "type": "string" }, "validation": { "$ref": "#/components/schemas/OutputValidationResponse" }, "values": { "additionalProperties": true, "title": "Values", "type": "object" } }, "required": [ "id", "runId", "runRowId", "datasetRowId", "rowIndex", "mode", "generatedRowIndex", "values", "validation", "createdAt" ], "title": "OutputListItemResponse", "type": "object" }, "OutputValidationResponse": { "additionalProperties": false, "properties": { "confidence": { "anyOf": [ {}, { "type": "null" } ], "title": "Confidence" }, "errors": { "items": {}, "title": "Errors", "type": "array" }, "status": { "enum": [ "not_checked", "passed", "failed", "flagged" ], "title": "Status", "type": "string" }, "warnings": { "items": {}, "title": "Warnings", "type": "array" } }, "required": [ "status", "errors", "warnings" ], "title": "OutputValidationResponse", "type": "object" }, "Page_AlertDeliveryResponse_": { "additionalProperties": false, "properties": { "data": { "items": { "$ref": "#/components/schemas/AlertDeliveryResponse" }, "title": "Data", "type": "array" }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Nextcursor" } }, "required": [ "data" ], "title": "Page[AlertDeliveryResponse]", "type": "object" }, "Page_AlertRuleResponse_": { "additionalProperties": false, "properties": { "data": { "items": { "$ref": "#/components/schemas/AlertRuleResponse" }, "title": "Data", "type": "array" }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Nextcursor" } }, "required": [ "data" ], "title": "Page[AlertRuleResponse]", "type": "object" }, "Page_ApiKeyResponse_": { "additionalProperties": false, "properties": { "data": { "items": { "$ref": "#/components/schemas/ApiKeyResponse" }, "title": "Data", "type": "array" }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Nextcursor" } }, "required": [ "data" ], "title": "Page[ApiKeyResponse]", "type": "object" }, "Page_AuditEventResponse_": { "additionalProperties": false, "properties": { "data": { "items": { "$ref": "#/components/schemas/AuditEventResponse" }, "title": "Data", "type": "array" }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Nextcursor" } }, "required": [ "data" ], "title": "Page[AuditEventResponse]", "type": "object" }, "Page_DatasetRowResponse_": { "additionalProperties": false, "properties": { "data": { "items": { "$ref": "#/components/schemas/DatasetRowResponse" }, "title": "Data", "type": "array" }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Nextcursor" } }, "required": [ "data" ], "title": "Page[DatasetRowResponse]", "type": "object" }, "Page_DatasetUploadResponse_": { "additionalProperties": false, "properties": { "data": { "items": { "$ref": "#/components/schemas/DatasetUploadResponse" }, "title": "Data", "type": "array" }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Nextcursor" } }, "required": [ "data" ], "title": "Page[DatasetUploadResponse]", "type": "object" }, "Page_ExportResponse_": { "additionalProperties": false, "properties": { "data": { "items": { "$ref": "#/components/schemas/ExportResponse" }, "title": "Data", "type": "array" }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Nextcursor" } }, "required": [ "data" ], "title": "Page[ExportResponse]", "type": "object" }, "Page_FailureResponse_": { "additionalProperties": false, "properties": { "data": { "items": { "$ref": "#/components/schemas/FailureResponse" }, "title": "Data", "type": "array" }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Nextcursor" } }, "required": [ "data" ], "title": "Page[FailureResponse]", "type": "object" }, "Page_JobSpecResponse_": { "additionalProperties": false, "properties": { "data": { "items": { "$ref": "#/components/schemas/JobSpecResponse" }, "title": "Data", "type": "array" }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Nextcursor" } }, "required": [ "data" ], "title": "Page[JobSpecResponse]", "type": "object" }, "Page_ModelProviderResponse_": { "additionalProperties": false, "properties": { "data": { "items": { "$ref": "#/components/schemas/ModelProviderResponse" }, "title": "Data", "type": "array" }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Nextcursor" } }, "required": [ "data" ], "title": "Page[ModelProviderResponse]", "type": "object" }, "Page_ModelResponse_": { "additionalProperties": false, "properties": { "data": { "items": { "$ref": "#/components/schemas/ModelResponse" }, "title": "Data", "type": "array" }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Nextcursor" } }, "required": [ "data" ], "title": "Page[ModelResponse]", "type": "object" }, "Page_OrganizationInvitationResponse_": { "additionalProperties": false, "properties": { "data": { "items": { "$ref": "#/components/schemas/OrganizationInvitationResponse" }, "title": "Data", "type": "array" }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Nextcursor" } }, "required": [ "data" ], "title": "Page[OrganizationInvitationResponse]", "type": "object" }, "Page_OrganizationMemberResponse_": { "additionalProperties": false, "properties": { "data": { "items": { "$ref": "#/components/schemas/OrganizationMemberResponse" }, "title": "Data", "type": "array" }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Nextcursor" } }, "required": [ "data" ], "title": "Page[OrganizationMemberResponse]", "type": "object" }, "Page_OrganizationResponse_": { "additionalProperties": false, "properties": { "data": { "items": { "$ref": "#/components/schemas/OrganizationResponse" }, "title": "Data", "type": "array" }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Nextcursor" } }, "required": [ "data" ], "title": "Page[OrganizationResponse]", "type": "object" }, "Page_OutputListItemResponse_": { "additionalProperties": false, "properties": { "data": { "items": { "$ref": "#/components/schemas/OutputListItemResponse" }, "title": "Data", "type": "array" }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Nextcursor" } }, "required": [ "data" ], "title": "Page[OutputListItemResponse]", "type": "object" }, "Page_RunEventResponse_": { "additionalProperties": false, "properties": { "data": { "items": { "$ref": "#/components/schemas/RunEventResponse" }, "title": "Data", "type": "array" }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Nextcursor" } }, "required": [ "data" ], "title": "Page[RunEventResponse]", "type": "object" }, "Page_RunResponse_": { "additionalProperties": false, "properties": { "data": { "items": { "$ref": "#/components/schemas/RunResponse" }, "title": "Data", "type": "array" }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Nextcursor" } }, "required": [ "data" ], "title": "Page[RunResponse]", "type": "object" }, "Page_RunRowResponse_": { "additionalProperties": false, "properties": { "data": { "items": { "$ref": "#/components/schemas/RunRowResponse" }, "title": "Data", "type": "array" }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Nextcursor" } }, "required": [ "data" ], "title": "Page[RunRowResponse]", "type": "object" }, "Page_WebhookDeliveryResponse_": { "additionalProperties": false, "properties": { "data": { "items": { "$ref": "#/components/schemas/WebhookDeliveryResponse" }, "title": "Data", "type": "array" }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Nextcursor" } }, "required": [ "data" ], "title": "Page[WebhookDeliveryResponse]", "type": "object" }, "Page_WebhookEndpointResponse_": { "additionalProperties": false, "properties": { "data": { "items": { "$ref": "#/components/schemas/WebhookEndpointResponse" }, "title": "Data", "type": "array" }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Nextcursor" } }, "required": [ "data" ], "title": "Page[WebhookEndpointResponse]", "type": "object" }, "PaidCheckoutCompleteReturnRequestBody": { "additionalProperties": false, "properties": { "state": { "minLength": 1, "title": "State", "type": "string" } }, "required": [ "state" ], "title": "PaidCheckoutCompleteReturnRequestBody", "type": "object" }, "PaidCheckoutPreparingResponse": { "additionalProperties": false, "properties": { "recoveryRequired": { "default": false, "title": "Recoveryrequired", "type": "boolean" }, "retryAfterMilliseconds": { "maximum": 5000.0, "minimum": 250.0, "title": "Retryaftermilliseconds", "type": "integer" }, "status": { "const": "preparing", "title": "Status", "type": "string" } }, "required": [ "status", "retryAfterMilliseconds" ], "title": "PaidCheckoutPreparingResponse", "type": "object" }, "PaidCheckoutReconciledResponse": { "additionalProperties": false, "properties": { "paidCheckoutIntentId": { "minLength": 1, "title": "Paidcheckoutintentid", "type": "string" }, "status": { "const": "reconciled", "title": "Status", "type": "string" } }, "required": [ "status", "paidCheckoutIntentId" ], "title": "PaidCheckoutReconciledResponse", "type": "object" }, "PaidCheckoutStartRequestBody": { "additionalProperties": false, "properties": { "acceptedTermsVersion": { "anyOf": [ { "maxLength": 128, "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "Exact offer Terms version explicitly accepted with this purchase command.", "title": "Acceptedtermsversion" }, "clientRequestId": { "maxLength": 128, "minLength": 1, "title": "Clientrequestid", "type": "string" }, "offerId": { "maxLength": 128, "minLength": 1, "title": "Offerid", "type": "string" }, "rowBudgetUsd": { "anyOf": [ { "maximum": 2000.0, "minimum": 0.0, "type": "integer" }, { "type": "null" } ], "title": "Rowbudgetusd" } }, "required": [ "offerId", "clientRequestId" ], "title": "PaidCheckoutStartRequestBody", "type": "object" }, "PaidCheckoutStartResponse": { "additionalProperties": false, "properties": { "checkoutUrl": { "title": "Checkouturl", "type": "string" }, "paidCheckoutIntentId": { "minLength": 1, "title": "Paidcheckoutintentid", "type": "string" }, "stateNonce": { "title": "Statenonce", "type": "string" } }, "required": [ "paidCheckoutIntentId", "checkoutUrl", "stateNonce" ], "title": "PaidCheckoutStartResponse", "type": "object" }, "PaidCheckoutStatusResponse": { "additionalProperties": false, "properties": { "activationId": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Activationid" }, "failureCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Failurecode" }, "offerId": { "title": "Offerid", "type": "string" }, "openedAt": { "description": "UTC RFC 3339 timestamp string.", "examples": [ "2026-06-12T12:00:00Z" ], "title": "Openedat", "type": "string" }, "paidCheckoutIntentId": { "minLength": 1, "title": "Paidcheckoutintentid", "type": "string" }, "repairReason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Repairreason" }, "status": { "enum": [ "pending", "awaiting_refetch", "succeeded", "failed", "abandoned", "repair_required" ], "title": "Status", "type": "string" }, "stripeCheckoutSessionId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Stripecheckoutsessionid" }, "stripePaymentIntentId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Stripepaymentintentid" }, "stripeRefundId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Striperefundid" }, "terminalAt": { "anyOf": [ { "description": "UTC RFC 3339 timestamp string.", "examples": [ "2026-06-12T12:00:00Z" ], "type": "string" }, { "type": "null" } ], "title": "Terminalat" } }, "required": [ "paidCheckoutIntentId", "offerId", "status", "openedAt" ], "title": "PaidCheckoutStatusResponse", "type": "object" }, "PaymentMethodSetupCompleteReturnRequestBody": { "additionalProperties": false, "properties": { "state": { "minLength": 1, "title": "State", "type": "string" } }, "required": [ "state" ], "title": "PaymentMethodSetupCompleteReturnRequestBody", "type": "object" }, "PaymentMethodSetupStartRequestBody": { "additionalProperties": false, "properties": { "acceptedTermsVersion": { "anyOf": [ { "maxLength": 128, "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "Required when the current organization has no receipt for the relevant Terms version in acceptedTermsVersions in the billing overview. Must exactly match that offer's current termsVersion.", "title": "Acceptedtermsversion" }, "offerId": { "default": "setup-only-v1", "maxLength": 128, "minLength": 1, "title": "Offerid", "type": "string" }, "resumeRunId": { "anyOf": [ { "maxLength": 255, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Resumerunid" }, "resumeRunSearch": { "anyOf": [ { "maxLength": 2048, "type": "string" }, { "type": "null" } ], "title": "Resumerunsearch" } }, "title": "PaymentMethodSetupStartRequestBody", "type": "object" }, "PaymentMethodSetupStartResponse": { "additionalProperties": false, "properties": { "checkoutUrl": { "title": "Checkouturl", "type": "string" }, "hostedSetupIntentId": { "minLength": 1, "title": "Hostedsetupintentid", "type": "string" }, "stateNonce": { "title": "Statenonce", "type": "string" } }, "required": [ "hostedSetupIntentId", "checkoutUrl", "stateNonce" ], "title": "PaymentMethodSetupStartResponse", "type": "object" }, "PaymentSetupStatusResponse": { "additionalProperties": false, "properties": { "hostedSetupIntentId": { "minLength": 1, "title": "Hostedsetupintentid", "type": "string" }, "paymentMethod": { "anyOf": [ { "$ref": "#/components/schemas/VerifiedPaymentMethodResponse" }, { "type": "null" } ] }, "promotion": { "$ref": "#/components/schemas/PromotionStatusResponse" }, "status": { "title": "Status", "type": "string" }, "terminalAt": { "anyOf": [ { "description": "UTC RFC 3339 timestamp string.", "examples": [ "2026-06-12T12:00:00Z" ], "type": "string" }, { "type": "null" } ], "title": "Terminalat" } }, "required": [ "hostedSetupIntentId", "status", "promotion" ], "title": "PaymentSetupStatusResponse", "type": "object" }, "PlanTransitionCompleteReturnRequestBody": { "additionalProperties": false, "properties": { "clientRequestId": { "maxLength": 128, "minLength": 1, "title": "Clientrequestid", "type": "string" }, "state": { "minLength": 1, "title": "State", "type": "string" } }, "required": [ "state", "clientRequestId" ], "title": "PlanTransitionCompleteReturnRequestBody", "type": "object" }, "PlanTransitionDiscoveryFoundResponse": { "additionalProperties": false, "properties": { "discoveryStatus": { "const": "found", "title": "Discoverystatus", "type": "string" }, "transition": { "$ref": "#/components/schemas/PlanTransitionResponse" } }, "required": [ "discoveryStatus", "transition" ], "title": "PlanTransitionDiscoveryFoundResponse", "type": "object" }, "PlanTransitionDiscoveryNoneResponse": { "additionalProperties": false, "properties": { "discoveryStatus": { "const": "none", "title": "Discoverystatus", "type": "string" } }, "required": [ "discoveryStatus" ], "title": "PlanTransitionDiscoveryNoneResponse", "type": "object" }, "PlanTransitionQuoteResponse": { "additionalProperties": false, "properties": { "addedFeatures": { "items": { "type": "string" }, "title": "Addedfeatures", "type": "array" }, "agreementRevision": { "minimum": 1.0, "title": "Agreementrevision", "type": "integer" }, "aiReloadDisposition": { "enum": [ "carry", "disable", "fresh_consent_required" ], "title": "Aireloaddisposition", "type": "string" }, "createsExecutionCapacity": { "title": "Createsexecutioncapacity", "type": "boolean" }, "currentFeatures": { "items": { "type": "string" }, "title": "Currentfeatures", "type": "array" }, "currentIncludedRows": { "minimum": 0.0, "title": "Currentincludedrows", "type": "integer" }, "currentMonthlyAmount": { "$ref": "#/components/schemas/CustomerMoneyResponse" }, "currentOfferId": { "title": "Currentofferid", "type": "string" }, "currentRecurringAi": { "$ref": "#/components/schemas/CustomerMoneyResponse" }, "debtBlocked": { "title": "Debtblocked", "type": "boolean" }, "immediatePriceDelta": { "$ref": "#/components/schemas/CustomerMoneyResponse" }, "includedRowDelta": { "title": "Includedrowdelta", "type": "integer" }, "mayRequest": { "title": "Mayrequest", "type": "boolean" }, "periodEnd": { "description": "UTC RFC 3339 timestamp string.", "examples": [ "2026-06-12T12:00:00Z" ], "title": "Periodend", "type": "string" }, "reason": { "title": "Reason", "type": "string" }, "recoveryBlocked": { "title": "Recoveryblocked", "type": "boolean" }, "recurringAiDelta": { "$ref": "#/components/schemas/CustomerMoneyResponse" }, "removedFeatures": { "items": { "type": "string" }, "title": "Removedfeatures", "type": "array" }, "requiresHostedPayment": { "title": "Requireshostedpayment", "type": "boolean" }, "rowBudgetDisposition": { "enum": [ "carry", "disable", "fresh_consent_required" ], "title": "Rowbudgetdisposition", "type": "string" }, "targetFeatures": { "items": { "type": "string" }, "title": "Targetfeatures", "type": "array" }, "targetIncludedRows": { "minimum": 0.0, "title": "Targetincludedrows", "type": "integer" }, "targetMonthlyAmount": { "$ref": "#/components/schemas/CustomerMoneyResponse" }, "targetOfferId": { "title": "Targetofferid", "type": "string" }, "targetRecurringAi": { "$ref": "#/components/schemas/CustomerMoneyResponse" }, "termsAcceptanceRequired": { "title": "Termsacceptancerequired", "type": "boolean" }, "termsVersion": { "title": "Termsversion", "type": "string" }, "timing": { "enum": [ "immediate", "renewal" ], "title": "Timing", "type": "string" } }, "required": [ "currentOfferId", "targetOfferId", "timing", "reason", "currentMonthlyAmount", "targetMonthlyAmount", "immediatePriceDelta", "currentIncludedRows", "targetIncludedRows", "includedRowDelta", "currentRecurringAi", "targetRecurringAi", "recurringAiDelta", "currentFeatures", "targetFeatures", "addedFeatures", "removedFeatures", "createsExecutionCapacity", "periodEnd", "agreementRevision", "rowBudgetDisposition", "aiReloadDisposition", "termsVersion", "termsAcceptanceRequired", "mayRequest", "recoveryBlocked", "debtBlocked", "requiresHostedPayment" ], "title": "PlanTransitionQuoteResponse", "type": "object" }, "PlanTransitionRequestBody": { "additionalProperties": false, "properties": { "acceptedTermsVersion": { "anyOf": [ { "maxLength": 128, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Acceptedtermsversion" }, "clientRequestId": { "maxLength": 128, "minLength": 1, "title": "Clientrequestid", "type": "string" }, "expectedAgreementRevision": { "minimum": 1.0, "title": "Expectedagreementrevision", "type": "integer" }, "targetOfferId": { "maxLength": 128, "minLength": 1, "title": "Targetofferid", "type": "string" } }, "required": [ "targetOfferId", "clientRequestId", "expectedAgreementRevision" ], "title": "PlanTransitionRequestBody", "type": "object" }, "PlanTransitionResponse": { "additionalProperties": false, "properties": { "activatedAgreementRevision": { "anyOf": [ { "minimum": 1.0, "type": "integer" }, { "type": "null" } ], "title": "Activatedagreementrevision" }, "generation": { "minimum": 1.0, "title": "Generation", "type": "integer" }, "openedAt": { "description": "UTC RFC 3339 timestamp string.", "examples": [ "2026-06-12T12:00:00Z" ], "title": "Openedat", "type": "string" }, "planTransitionId": { "minLength": 1, "title": "Plantransitionid", "type": "string" }, "quote": { "$ref": "#/components/schemas/PlanTransitionQuoteResponse" }, "refetchRequired": { "title": "Refetchrequired", "type": "boolean" }, "requiresSupport": { "title": "Requiressupport", "type": "boolean" }, "status": { "enum": [ "pending_payment", "pending_authority", "scheduled", "superseded", "activated", "reconfirmation_required", "repair_required" ], "title": "Status", "type": "string" }, "supersedesPlanTransitionId": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Supersedesplantransitionid" }, "terminalAt": { "anyOf": [ { "description": "UTC RFC 3339 timestamp string.", "examples": [ "2026-06-12T12:00:00Z" ], "type": "string" }, { "type": "null" } ], "title": "Terminalat" }, "updatedAt": { "description": "UTC RFC 3339 timestamp string.", "examples": [ "2026-06-12T12:00:00Z" ], "title": "Updatedat", "type": "string" } }, "required": [ "planTransitionId", "generation", "status", "quote", "refetchRequired", "requiresSupport", "openedAt", "updatedAt" ], "title": "PlanTransitionResponse", "type": "object" }, "PlanTransitionStartResponse": { "additionalProperties": false, "properties": { "hostedActionUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Hostedactionurl" }, "stateNonce": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Statenonce" }, "transition": { "$ref": "#/components/schemas/PlanTransitionResponse" } }, "required": [ "transition" ], "title": "PlanTransitionStartResponse", "type": "object" }, "PromotionStatusResponse": { "additionalProperties": false, "properties": { "activatedAt": { "anyOf": [ { "description": "UTC RFC 3339 timestamp string.", "examples": [ "2026-06-12T12:00:00Z" ], "type": "string" }, { "type": "null" } ], "title": "Activatedat" }, "amountMinorUnits": { "minimum": 0.0, "title": "Amountminorunits", "type": "integer" }, "currencyCode": { "maxLength": 3, "minLength": 3, "title": "Currencycode", "type": "string" }, "expiresAt": { "anyOf": [ { "description": "UTC RFC 3339 timestamp string.", "examples": [ "2026-06-12T12:00:00Z" ], "type": "string" }, { "type": "null" } ], "title": "Expiresat" }, "status": { "enum": [ "locked", "activated", "ineligible", "claimed" ], "title": "Status", "type": "string" } }, "required": [ "status", "currencyCode", "amountMinorUnits" ], "title": "PromotionStatusResponse", "type": "object" }, "ProviderAttemptsSummary": { "additionalProperties": false, "properties": { "failed": { "minimum": 0.0, "title": "Failed", "type": "integer" }, "succeeded": { "minimum": 0.0, "title": "Succeeded", "type": "integer" }, "total": { "minimum": 0.0, "title": "Total", "type": "integer" } }, "required": [ "total", "succeeded", "failed" ], "title": "ProviderAttemptsSummary", "type": "object" }, "ProviderCostSummary": { "additionalProperties": false, "properties": { "currencyCode": { "default": "USD", "maxLength": 3, "minLength": 3, "title": "Currencycode", "type": "string" }, "pricedAmount": { "description": "Decimal amount serialized as a string to preserve precision.", "examples": [ "0.000000000000000000" ], "title": "Pricedamount", "type": "string" }, "status": { "enum": [ "priced", "partially_priced", "pricing_unavailable", "usage_unavailable", "not_billable" ], "title": "Status", "type": "string" }, "totalAmount": { "anyOf": [ { "description": "Decimal amount serialized as a string to preserve precision.", "examples": [ "0.000000000000000000" ], "type": "string" }, { "type": "null" } ], "title": "Totalamount" } }, "required": [ "status", "totalAmount", "pricedAmount" ], "title": "ProviderCostSummary", "type": "object" }, "ProviderListPriceResponse": { "additionalProperties": false, "properties": { "components": { "items": { "$ref": "#/components/schemas/ProviderPriceComponentResponse" }, "title": "Components", "type": "array" }, "currencyCode": { "title": "Currencycode", "type": "string" }, "effectiveAt": { "description": "UTC RFC 3339 timestamp string.", "examples": [ "2026-06-12T12:00:00Z" ], "title": "Effectiveat", "type": "string" }, "id": { "minLength": 1, "title": "Id", "type": "string" }, "pricingProfile": { "title": "Pricingprofile", "type": "string" }, "retiredAt": { "anyOf": [ { "description": "UTC RFC 3339 timestamp string.", "examples": [ "2026-06-12T12:00:00Z" ], "type": "string" }, { "type": "null" } ], "title": "Retiredat" }, "sourceUrl": { "title": "Sourceurl", "type": "string" }, "verifiedAt": { "description": "UTC RFC 3339 timestamp string.", "examples": [ "2026-06-12T12:00:00Z" ], "title": "Verifiedat", "type": "string" } }, "required": [ "id", "currencyCode", "pricingProfile", "sourceUrl", "verifiedAt", "effectiveAt", "retiredAt", "components" ], "title": "ProviderListPriceResponse", "type": "object" }, "ProviderPriceComponentResponse": { "additionalProperties": false, "properties": { "condition": { "additionalProperties": true, "title": "Condition", "type": "object" }, "conditionKey": { "title": "Conditionkey", "type": "string" }, "ratePerUnit": { "title": "Rateperunit", "type": "string" }, "unit": { "title": "Unit", "type": "string" }, "unitQuantity": { "title": "Unitquantity", "type": "integer" }, "usageCategory": { "title": "Usagecategory", "type": "string" } }, "required": [ "usageCategory", "conditionKey", "condition", "unit", "unitQuantity", "ratePerUnit" ], "title": "ProviderPriceComponentResponse", "type": "object" }, "PublicError": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "additionalProperties": true, "type": "object" }, "docsUrl": { "format": "uri", "type": "string" }, "fieldErrors": { "items": { "$ref": "#/components/schemas/PublicFieldError" }, "type": "array" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "status", "code", "message", "requestId", "docsUrl", "fieldErrors" ], "type": "object" }, "PublicErrorEnvelope": { "additionalProperties": false, "properties": { "error": { "$ref": "#/components/schemas/PublicError" } }, "required": [ "error" ], "type": "object" }, "PublicFieldError": { "additionalProperties": false, "properties": { "actual": {}, "code": { "type": "string" }, "expected": {}, "message": { "type": "string" }, "source": { "$ref": "#/components/schemas/PublicFieldErrorSource" } }, "required": [ "source", "code", "message" ], "type": "object" }, "PublicFieldErrorSource": { "additionalProperties": false, "minProperties": 1, "properties": { "formField": { "type": "string" }, "header": { "type": "string" }, "parameter": { "type": "string" }, "pointer": { "type": "string" } }, "type": "object" }, "RenewalRecoveryPeriodResponse": { "additionalProperties": false, "properties": { "end": { "description": "UTC RFC 3339 timestamp string.", "examples": [ "2026-06-12T12:00:00Z" ], "title": "End", "type": "string" }, "id": { "minLength": 1, "title": "Id", "type": "string" }, "start": { "description": "UTC RFC 3339 timestamp string.", "examples": [ "2026-06-12T12:00:00Z" ], "title": "Start", "type": "string" } }, "required": [ "id", "start", "end" ], "title": "RenewalRecoveryPeriodResponse", "type": "object" }, "RenewalRecoveryResponse": { "additionalProperties": false, "properties": { "anchoredPeriod": { "anyOf": [ { "$ref": "#/components/schemas/RenewalRecoveryPeriodResponse" }, { "type": "null" } ] }, "authorityDeadline": { "anyOf": [ { "description": "UTC RFC 3339 timestamp string.", "examples": [ "2026-06-12T12:00:00Z" ], "type": "string" }, { "type": "null" } ], "title": "Authoritydeadline" }, "coveredRowDebt": { "anyOf": [ { "$ref": "#/components/schemas/CustomerMoneyResponse" }, { "type": "null" } ] }, "expectedPayment": { "anyOf": [ { "$ref": "#/components/schemas/CustomerMoneyResponse" }, { "type": "null" } ] }, "mayStopToFree": { "title": "Maystoptofree", "type": "boolean" }, "mayUpdatePaymentMethod": { "title": "Mayupdatepaymentmethod", "type": "boolean" }, "offerId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Offerid" }, "openedAt": { "anyOf": [ { "description": "UTC RFC 3339 timestamp string.", "examples": [ "2026-06-12T12:00:00Z" ], "type": "string" }, { "type": "null" } ], "title": "Openedat" }, "recurringFee": { "anyOf": [ { "$ref": "#/components/schemas/CustomerMoneyResponse" }, { "type": "null" } ] }, "renewalPeriod": { "anyOf": [ { "$ref": "#/components/schemas/RenewalRecoveryPeriodResponse" }, { "type": "null" } ] }, "renewalRecoveryId": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Renewalrecoveryid" }, "status": { "enum": [ "not_required", "payment_required", "stop_pending", "paid", "free_fallback" ], "title": "Status", "type": "string" }, "terminalAt": { "anyOf": [ { "description": "UTC RFC 3339 timestamp string.", "examples": [ "2026-06-12T12:00:00Z" ], "type": "string" }, { "type": "null" } ], "title": "Terminalat" }, "winnerCause": { "anyOf": [ { "enum": [ "paid_original_period", "stop_effective_to_free", "terminal_to_free" ], "type": "string" }, { "type": "null" } ], "title": "Winnercause" } }, "required": [ "status", "mayUpdatePaymentMethod", "mayStopToFree" ], "title": "RenewalRecoveryResponse", "type": "object" }, "RenewalRecoveryStopRequestBody": { "additionalProperties": false, "properties": { "clientRequestId": { "maxLength": 128, "minLength": 1, "title": "Clientrequestid", "type": "string" } }, "required": [ "clientRequestId" ], "title": "RenewalRecoveryStopRequestBody", "type": "object" }, "ResolvedResultProvenanceResponse": { "additionalProperties": false, "properties": { "lineageResolution": { "title": "Lineageresolution", "type": "string" }, "rowExecutionAttemptId": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Rowexecutionattemptid" }, "sourceRunId": { "minLength": 1, "title": "Sourcerunid", "type": "string" }, "sourceRunRowId": { "minLength": 1, "title": "Sourcerunrowid", "type": "string" } }, "required": [ "sourceRunId", "sourceRunRowId", "rowExecutionAttemptId", "lineageResolution" ], "title": "ResolvedResultProvenanceResponse", "type": "object" }, "ResolvedResultRowResponse": { "additionalProperties": false, "properties": { "datasetRowId": { "minLength": 1, "title": "Datasetrowid", "type": "string" }, "failure": { "anyOf": [ { "$ref": "#/components/schemas/FailurePayloadResponse" }, { "type": "null" } ] }, "generatedRows": { "anyOf": [ { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, { "type": "null" } ], "title": "Generatedrows" }, "provenance": { "$ref": "#/components/schemas/ResolvedResultProvenanceResponse" }, "resultState": { "enum": [ "succeeded", "failed", "flagged", "skipped" ], "title": "Resultstate", "type": "string" }, "rowIndex": { "minimum": 0.0, "title": "Rowindex", "type": "integer" }, "source": { "additionalProperties": true, "title": "Source", "type": "object" }, "values": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Values" } }, "required": [ "datasetRowId", "rowIndex", "source", "resultState", "provenance" ], "title": "ResolvedResultRowResponse", "type": "object" }, "ResolvedResultsResponse": { "additionalProperties": false, "properties": { "contributingRunIds": { "items": { "minLength": 1, "type": "string" }, "title": "Contributingrunids", "type": "array" }, "data": { "items": { "$ref": "#/components/schemas/ResolvedResultRowResponse" }, "title": "Data", "type": "array" }, "generatedColumns": { "items": { "type": "string" }, "title": "Generatedcolumns", "type": "array" }, "mode": { "enum": [ "add_columns", "create_rows" ], "title": "Mode", "type": "string" }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Nextcursor" }, "requestedRunId": { "minLength": 1, "title": "Requestedrunid", "type": "string" }, "rootRunId": { "minLength": 1, "title": "Rootrunid", "type": "string" }, "sourceColumns": { "items": { "type": "string" }, "title": "Sourcecolumns", "type": "array" } }, "required": [ "requestedRunId", "rootRunId", "contributingRunIds", "mode", "sourceColumns", "generatedColumns", "data", "nextCursor" ], "title": "ResolvedResultsResponse", "type": "object" }, "RowBudgetChangeRequestBody": { "additionalProperties": false, "properties": { "clientRequestId": { "maxLength": 128, "minLength": 1, "title": "Clientrequestid", "type": "string" }, "expectedAgreementRevision": { "minimum": 1.0, "title": "Expectedagreementrevision", "type": "integer" }, "rowBudgetUsd": { "maximum": 2000.0, "minimum": 0.0, "title": "Rowbudgetusd", "type": "integer" } }, "required": [ "rowBudgetUsd", "clientRequestId", "expectedAgreementRevision" ], "title": "RowBudgetChangeRequestBody", "type": "object" }, "RowBudgetChangeResponse": { "additionalProperties": false, "properties": { "acceptedAt": { "description": "UTC RFC 3339 timestamp string.", "examples": [ "2026-06-12T12:00:00Z" ], "title": "Acceptedat", "type": "string" }, "acceptedBudget": { "$ref": "#/components/schemas/CustomerMoneyResponse" }, "agreementRevision": { "minimum": 1.0, "title": "Agreementrevision", "type": "integer" }, "billingAccountId": { "minLength": 1, "title": "Billingaccountid", "type": "string" }, "budgetRemaining": { "$ref": "#/components/schemas/CustomerMoneyResponse" }, "clientRequestId": { "title": "Clientrequestid", "type": "string" }, "eventId": { "minLength": 1, "title": "Eventid", "type": "string" }, "maximumBudget": { "$ref": "#/components/schemas/CustomerMoneyResponse" }, "organizationId": { "minLength": 1, "title": "Organizationid", "type": "string" }, "periodId": { "minLength": 1, "title": "Periodid", "type": "string" }, "previousBudget": { "$ref": "#/components/schemas/CustomerMoneyResponse" } }, "required": [ "billingAccountId", "organizationId", "periodId", "agreementRevision", "acceptedBudget", "previousBudget", "maximumBudget", "budgetRemaining", "acceptedAt", "eventId", "clientRequestId" ], "title": "RowBudgetChangeResponse", "type": "object" }, "RowHistoryAttemptResponse": { "additionalProperties": false, "properties": { "attemptId": { "minLength": 1, "title": "Attemptid", "type": "string" }, "firstSequence": { "minimum": 1.0, "title": "Firstsequence", "type": "integer" }, "lastSequence": { "minimum": 1.0, "title": "Lastsequence", "type": "integer" } }, "required": [ "attemptId", "firstSequence", "lastSequence" ], "title": "RowHistoryAttemptResponse", "type": "object" }, "RowHistoryContentResponse": { "additionalProperties": false, "properties": { "availability": { "enum": [ "available", "unavailable" ], "title": "Availability", "type": "string" }, "data": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Data" }, "encoding": { "const": "base64", "title": "Encoding", "type": "string" }, "mediaType": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Mediatype" }, "nextOffset": { "anyOf": [ { "minimum": 0.0, "type": "integer" }, { "type": "null" } ], "title": "Nextoffset" }, "offset": { "minimum": 0.0, "title": "Offset", "type": "integer" }, "totalBytes": { "anyOf": [ { "minimum": 0.0, "type": "integer" }, { "type": "null" } ], "title": "Totalbytes" } }, "required": [ "availability", "mediaType", "encoding", "data", "offset", "totalBytes" ], "title": "RowHistoryContentResponse", "type": "object" }, "RowHistoryPageResponse": { "additionalProperties": false, "properties": { "attempts": { "items": { "$ref": "#/components/schemas/RowHistoryAttemptResponse" }, "title": "Attempts", "type": "array" }, "committedThrough": { "anyOf": [ { "minimum": 0.0, "type": "integer" }, { "type": "null" } ], "title": "Committedthrough" }, "coverage": { "enum": [ "durable_v1", "legacy_partial", "unavailable" ], "title": "Coverage", "type": "string" }, "items": { "items": { "anyOf": [ { "$ref": "#/components/schemas/DurableRowHistoryItemResponse" }, { "$ref": "#/components/schemas/LegacyRowHistoryItemResponse" } ] }, "title": "Items", "type": "array" }, "journalId": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Journalid" }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Nextcursor" }, "ordering": { "anyOf": [ { "const": "messages_then_events_not_chronology", "type": "string" }, { "type": "null" } ], "title": "Ordering" }, "tailCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tailcursor" }, "unavailableReason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Unavailablereason" } }, "required": [ "journalId", "coverage", "attempts", "items", "committedThrough", "nextCursor", "tailCursor" ], "title": "RowHistoryPageResponse", "type": "object" }, "RowModelSpendResponse": { "additionalProperties": false, "description": "Per-row model spend (H4S-283).\n\nAbsent entirely for a row with nothing recorded yet. `status` carries the\npricing state, so a run that has spent money the provider has not priced\ncannot be mistaken for a free one; `totalAmount` is null in exactly that\ncase.", "properties": { "currencyCode": { "title": "Currencycode", "type": "string" }, "pricedAmount": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Pricedamount" }, "status": { "title": "Status", "type": "string" }, "totalAmount": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Totalamount" } }, "required": [ "currencyCode", "status" ], "title": "RowModelSpendResponse", "type": "object" }, "RunCreateRequestBody": { "additionalProperties": false, "properties": { "datasetId": { "title": "Datasetid", "type": "string" }, "jobSpecId": { "title": "Jobspecid", "type": "string" }, "referenceDatasets": { "items": { "$ref": "#/components/schemas/DatasetReferenceBody" }, "title": "Referencedatasets", "type": "array" }, "scope": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Scope" } }, "required": [ "datasetId", "jobSpecId" ], "title": "RunCreateRequestBody", "type": "object" }, "RunEventResponse": { "additionalProperties": false, "properties": { "createdAt": { "description": "UTC RFC 3339 timestamp string.", "examples": [ "2026-06-12T12:00:00Z" ], "title": "Createdat", "type": "string" }, "id": { "minLength": 1, "title": "Id", "type": "string" }, "message": { "title": "Message", "type": "string" }, "metadata": { "additionalProperties": true, "title": "Metadata", "type": "object" }, "runId": { "minLength": 1, "title": "Runid", "type": "string" }, "runRowId": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Runrowid" }, "type": { "title": "Type", "type": "string" } }, "required": [ "id", "runId", "runRowId", "type", "message", "metadata", "createdAt" ], "title": "RunEventResponse", "type": "object" }, "RunResponse": { "additionalProperties": false, "properties": { "agentThreadId": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Agentthreadid" }, "billingIngestCompletedAt": { "anyOf": [ { "description": "UTC RFC 3339 timestamp string.", "examples": [ "2026-06-12T12:00:00Z" ], "type": "string" }, { "type": "null" } ], "title": "Billingingestcompletedat" }, "cancelRequestedAt": { "anyOf": [ { "description": "UTC RFC 3339 timestamp string.", "examples": [ "2026-06-12T12:00:00Z" ], "type": "string" }, { "type": "null" } ], "title": "Cancelrequestedat" }, "completedAt": { "anyOf": [ { "description": "UTC RFC 3339 timestamp string.", "examples": [ "2026-06-12T12:00:00Z" ], "type": "string" }, { "type": "null" } ], "title": "Completedat" }, "createdAt": { "description": "UTC RFC 3339 timestamp string.", "examples": [ "2026-06-12T12:00:00Z" ], "title": "Createdat", "type": "string" }, "datasetId": { "minLength": 1, "title": "Datasetid", "type": "string" }, "datasetQueryContext": { "$ref": "#/components/schemas/DatasetQueryContextResponse" }, "executionLane": { "anyOf": [ { "const": "agent_query", "type": "string" }, { "type": "null" } ], "title": "Executionlane" }, "firstStartedAt": { "anyOf": [ { "description": "UTC RFC 3339 timestamp string.", "examples": [ "2026-06-12T12:00:00Z" ], "type": "string" }, { "type": "null" } ], "title": "Firststartedat" }, "id": { "minLength": 1, "title": "Id", "type": "string" }, "idempotencyKey": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotencykey" }, "jobSpecId": { "minLength": 1, "title": "Jobspecid", "type": "string" }, "jobSpecVersionId": { "minLength": 1, "title": "Jobspecversionid", "type": "string" }, "lineageManagedAiUsage": { "anyOf": [ { "$ref": "#/components/schemas/ManagedAiUsageSummaryResponse" }, { "type": "null" } ] }, "lineageModelUsage": { "anyOf": [ { "$ref": "#/components/schemas/RowModelSpendResponse" }, { "type": "null" } ] }, "managedAiUsage": { "anyOf": [ { "$ref": "#/components/schemas/ManagedAiUsageSummaryResponse" }, { "type": "null" } ] }, "mcpCreation": { "anyOf": [ { "$ref": "#/components/schemas/McpCreationResponse" }, { "type": "null" } ] }, "mode": { "enum": [ "add_columns", "create_rows" ], "title": "Mode", "type": "string" }, "modelUsage": { "$ref": "#/components/schemas/ModelUsageSummary" }, "orgId": { "minLength": 1, "title": "Orgid", "type": "string" }, "resumeAvailable": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Resumeavailable" }, "resumeBlockedReason": { "anyOf": [ { "enum": [ "insufficient_ai_balance", "billing_restricted", "billing_unavailable" ], "type": "string" }, { "type": "null" } ], "title": "Resumeblockedreason" }, "retryOfRunId": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Retryofrunid" }, "rowCounts": { "$ref": "#/components/schemas/RunRowCountsResponse" }, "scope": { "additionalProperties": true, "title": "Scope", "type": "object" }, "startedAt": { "anyOf": [ { "description": "UTC RFC 3339 timestamp string.", "examples": [ "2026-06-12T12:00:00Z" ], "type": "string" }, { "type": "null" } ], "title": "Startedat" }, "state": { "enum": [ "draft", "queued", "running", "paused", "succeeded", "completed_with_flags", "failed", "canceled" ], "title": "State", "type": "string" }, "updatedAt": { "anyOf": [ { "description": "UTC RFC 3339 timestamp string.", "examples": [ "2026-06-12T12:00:00Z" ], "type": "string" }, { "type": "null" } ], "title": "Updatedat" } }, "required": [ "id", "orgId", "datasetId", "jobSpecId", "jobSpecVersionId", "retryOfRunId", "agentThreadId", "mode", "scope", "datasetQueryContext", "executionLane", "state", "rowCounts", "modelUsage", "managedAiUsage", "lineageModelUsage", "lineageManagedAiUsage", "idempotencyKey", "createdAt", "updatedAt", "startedAt", "firstStartedAt", "completedAt", "cancelRequestedAt", "billingIngestCompletedAt" ], "title": "RunResponse", "type": "object" }, "RunRowCountsResponse": { "additionalProperties": false, "properties": { "failed": { "minimum": 0.0, "title": "Failed", "type": "integer" }, "flagged": { "minimum": 0.0, "title": "Flagged", "type": "integer" }, "pending": { "minimum": 0.0, "title": "Pending", "type": "integer" }, "processed": { "minimum": 0.0, "title": "Processed", "type": "integer" }, "running": { "minimum": 0.0, "title": "Running", "type": "integer" }, "skipped": { "minimum": 0.0, "title": "Skipped", "type": "integer" }, "succeeded": { "minimum": 0.0, "title": "Succeeded", "type": "integer" }, "total": { "minimum": 0.0, "title": "Total", "type": "integer" } }, "required": [ "total", "processed", "pending", "running", "succeeded", "flagged", "failed", "skipped" ], "title": "RunRowCountsResponse", "type": "object" }, "RunRowDetailResponse": { "additionalProperties": false, "properties": { "completedAt": { "anyOf": [ { "description": "UTC RFC 3339 timestamp string.", "examples": [ "2026-06-12T12:00:00Z" ], "type": "string" }, { "type": "null" } ], "title": "Completedat" }, "createdAt": { "description": "UTC RFC 3339 timestamp string.", "examples": [ "2026-06-12T12:00:00Z" ], "title": "Createdat", "type": "string" }, "datasetRowId": { "minLength": 1, "title": "Datasetrowid", "type": "string" }, "failure": { "anyOf": [ { "$ref": "#/components/schemas/FailurePayloadResponse" }, { "type": "null" } ] }, "id": { "minLength": 1, "title": "Id", "type": "string" }, "modelUsage": { "$ref": "#/components/schemas/ModelUsageSummary" }, "output": { "anyOf": [ { "$ref": "#/components/schemas/RunRowOutputSummaryResponse" }, { "type": "null" } ] }, "rowIndex": { "minimum": 0.0, "title": "Rowindex", "type": "integer" }, "runId": { "minLength": 1, "title": "Runid", "type": "string" }, "source": { "$ref": "#/components/schemas/RunRowSourceResponse" }, "startedAt": { "anyOf": [ { "description": "UTC RFC 3339 timestamp string.", "examples": [ "2026-06-12T12:00:00Z" ], "type": "string" }, { "type": "null" } ], "title": "Startedat" }, "state": { "enum": [ "pending", "running", "succeeded", "flagged", "failed", "skipped" ], "title": "State", "type": "string" }, "updatedAt": { "description": "UTC RFC 3339 timestamp string.", "examples": [ "2026-06-12T12:00:00Z" ], "title": "Updatedat", "type": "string" }, "validation": { "additionalProperties": true, "title": "Validation", "type": "object" } }, "required": [ "id", "runId", "datasetRowId", "rowIndex", "state", "validation", "failure", "modelUsage", "startedAt", "completedAt", "createdAt", "updatedAt", "source", "output" ], "title": "RunRowDetailResponse", "type": "object" }, "RunRowOutputSummaryResponse": { "additionalProperties": false, "properties": { "createdAt": { "description": "UTC RFC 3339 timestamp string.", "examples": [ "2026-06-12T12:00:00Z" ], "title": "Createdat", "type": "string" }, "generatedFields": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Generatedfields" }, "generatedRowsCount": { "minimum": 0.0, "title": "Generatedrowscount", "type": "integer" }, "id": { "minLength": 1, "title": "Id", "type": "string" }, "jobSpecVersionId": { "minLength": 1, "title": "Jobspecversionid", "type": "string" }, "mode": { "enum": [ "add_columns", "create_rows" ], "title": "Mode", "type": "string" }, "model": { "title": "Model", "type": "string" } }, "required": [ "id", "mode", "generatedFields", "generatedRowsCount", "model", "jobSpecVersionId", "createdAt" ], "title": "RunRowOutputSummaryResponse", "type": "object" }, "RunRowResponse": { "additionalProperties": false, "properties": { "completedAt": { "anyOf": [ { "description": "UTC RFC 3339 timestamp string.", "examples": [ "2026-06-12T12:00:00Z" ], "type": "string" }, { "type": "null" } ], "title": "Completedat" }, "createdAt": { "description": "UTC RFC 3339 timestamp string.", "examples": [ "2026-06-12T12:00:00Z" ], "title": "Createdat", "type": "string" }, "datasetRowId": { "minLength": 1, "title": "Datasetrowid", "type": "string" }, "failure": { "anyOf": [ { "$ref": "#/components/schemas/FailurePayloadResponse" }, { "type": "null" } ] }, "id": { "minLength": 1, "title": "Id", "type": "string" }, "modelUsage": { "$ref": "#/components/schemas/ModelUsageSummary" }, "rowIndex": { "minimum": 0.0, "title": "Rowindex", "type": "integer" }, "runId": { "minLength": 1, "title": "Runid", "type": "string" }, "startedAt": { "anyOf": [ { "description": "UTC RFC 3339 timestamp string.", "examples": [ "2026-06-12T12:00:00Z" ], "type": "string" }, { "type": "null" } ], "title": "Startedat" }, "state": { "enum": [ "pending", "running", "succeeded", "flagged", "failed", "skipped" ], "title": "State", "type": "string" }, "updatedAt": { "description": "UTC RFC 3339 timestamp string.", "examples": [ "2026-06-12T12:00:00Z" ], "title": "Updatedat", "type": "string" }, "validation": { "additionalProperties": true, "title": "Validation", "type": "object" } }, "required": [ "id", "runId", "datasetRowId", "rowIndex", "state", "validation", "failure", "modelUsage", "startedAt", "completedAt", "createdAt", "updatedAt" ], "title": "RunRowResponse", "type": "object" }, "RunRowSourceResponse": { "additionalProperties": false, "properties": { "datasetRowId": { "minLength": 1, "title": "Datasetrowid", "type": "string" }, "rowIndex": { "minimum": 0.0, "title": "Rowindex", "type": "integer" }, "values": { "additionalProperties": true, "title": "Values", "type": "object" } }, "required": [ "datasetRowId", "rowIndex", "values" ], "title": "RunRowSourceResponse", "type": "object" }, "SignupProfileCompleteRequest": { "additionalProperties": false, "properties": { "companyName": { "anyOf": [ { "maxLength": 200, "type": "string" }, { "type": "null" } ], "title": "Companyname" }, "displayName": { "anyOf": [ { "maxLength": 200, "type": "string" }, { "type": "null" } ], "title": "Displayname" }, "disposition": { "enum": [ "saved", "skipped" ], "title": "Disposition", "type": "string" } }, "required": [ "disposition" ], "title": "SignupProfileCompleteRequest", "type": "object" }, "SignupProfileResponse": { "additionalProperties": false, "properties": { "companyName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Companyname" }, "continueUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Continueurl" }, "displayName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Displayname" }, "disposition": { "anyOf": [ { "enum": [ "saved", "skipped" ], "type": "string" }, { "type": "null" } ], "title": "Disposition" }, "id": { "title": "Id", "type": "string" } }, "required": [ "id", "displayName", "companyName", "disposition", "continueUrl" ], "title": "SignupProfileResponse", "type": "object" }, "TopUpIntentResponse": { "additionalProperties": false, "properties": { "amountMinorUnits": { "minimum": 1.0, "title": "Amountminorunits", "type": "integer" }, "amountUsd": { "enum": [ 10, 25, 50, 100 ], "title": "Amountusd", "type": "integer" }, "automaticTaxStatus": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Automatictaxstatus" }, "clientRequestId": { "title": "Clientrequestid", "type": "string" }, "currencyCode": { "maxLength": 3, "minLength": 3, "title": "Currencycode", "type": "string" }, "failureCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Failurecode" }, "hostedInvoiceUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Hostedinvoiceurl" }, "openedAt": { "description": "UTC RFC 3339 timestamp string.", "examples": [ "2026-06-12T12:00:00Z" ], "title": "Openedat", "type": "string" }, "repairReason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Repairreason" }, "status": { "enum": [ "pending", "succeeded", "failed", "repair_required" ], "title": "Status", "type": "string" }, "stripeInvoiceId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Stripeinvoiceid" }, "stripePaymentIntentId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Stripepaymentintentid" }, "stripeReceiptUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Stripereceipturl" }, "stripeRefundId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Striperefundid" }, "taxAmountMinorUnits": { "anyOf": [ { "minimum": 0.0, "type": "integer" }, { "type": "null" } ], "title": "Taxamountminorunits" }, "terminalAt": { "anyOf": [ { "description": "UTC RFC 3339 timestamp string.", "examples": [ "2026-06-12T12:00:00Z" ], "type": "string" }, { "type": "null" } ], "title": "Terminalat" }, "topUpIntentId": { "minLength": 1, "title": "Topupintentid", "type": "string" }, "totalAmountMinorUnits": { "anyOf": [ { "minimum": 1.0, "type": "integer" }, { "type": "null" } ], "title": "Totalamountminorunits" }, "walletLotId": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Walletlotid" } }, "required": [ "topUpIntentId", "clientRequestId", "status", "currencyCode", "amountUsd", "amountMinorUnits", "openedAt" ], "title": "TopUpIntentResponse", "type": "object" }, "TopUpReceiptListResponse": { "additionalProperties": false, "properties": { "nextCursor": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Nextcursor" }, "receipts": { "items": { "$ref": "#/components/schemas/TopUpIntentResponse" }, "title": "Receipts", "type": "array" } }, "required": [ "receipts" ], "title": "TopUpReceiptListResponse", "type": "object" }, "TopUpStartRequestBody": { "additionalProperties": false, "properties": { "amountUsd": { "enum": [ 10, 25, 50, 100 ], "title": "Amountusd", "type": "integer" }, "clientRequestId": { "maxLength": 128, "minLength": 1, "title": "Clientrequestid", "type": "string" } }, "required": [ "amountUsd", "clientRequestId" ], "title": "TopUpStartRequestBody", "type": "object" }, "UserProfileUpdateRequest": { "additionalProperties": false, "properties": { "companyName": { "anyOf": [ { "maxLength": 200, "type": "string" }, { "type": "null" } ], "title": "Companyname" }, "displayName": { "anyOf": [ { "maxLength": 200, "type": "string" }, { "type": "null" } ], "title": "Displayname" } }, "title": "UserProfileUpdateRequest", "type": "object" }, "VerifiedPaymentMethodResponse": { "additionalProperties": false, "properties": { "cardBrand": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cardbrand" }, "cardExpMonth": { "anyOf": [ { "maximum": 12.0, "minimum": 1.0, "type": "integer" }, { "type": "null" } ], "title": "Cardexpmonth" }, "cardExpYear": { "anyOf": [ { "minimum": 2000.0, "type": "integer" }, { "type": "null" } ], "title": "Cardexpyear" }, "cardFunding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cardfunding" }, "cardLast4": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cardlast4" }, "paymentMethodType": { "title": "Paymentmethodtype", "type": "string" }, "verifiedAt": { "description": "UTC RFC 3339 timestamp string.", "examples": [ "2026-06-12T12:00:00Z" ], "title": "Verifiedat", "type": "string" } }, "required": [ "paymentMethodType", "verifiedAt" ], "title": "VerifiedPaymentMethodResponse", "type": "object" }, "WalletBalanceResponse": { "additionalProperties": false, "properties": { "available": { "$ref": "#/components/schemas/CustomerMoneyResponse" }, "currencyCode": { "maxLength": 3, "minLength": 3, "title": "Currencycode", "type": "string" }, "executionSafe": { "$ref": "#/components/schemas/CustomerMoneyResponse" }, "reserved": { "$ref": "#/components/schemas/CustomerMoneyResponse" } }, "required": [ "currencyCode", "available", "reserved", "executionSafe" ], "title": "WalletBalanceResponse", "type": "object" }, "WebhookDeliveryDetailResponse": { "additionalProperties": false, "properties": { "attemptCount": { "minimum": 0.0, "title": "Attemptcount", "type": "integer" }, "createdAt": { "anyOf": [ { "description": "UTC RFC 3339 timestamp string.", "examples": [ "2026-06-12T12:00:00Z" ], "type": "string" }, { "type": "null" } ], "title": "Createdat" }, "deliveredAt": { "anyOf": [ { "description": "UTC RFC 3339 timestamp string.", "examples": [ "2026-06-12T12:00:00Z" ], "type": "string" }, { "type": "null" } ], "title": "Deliveredat" }, "error": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Error" }, "event": { "$ref": "#/components/schemas/WebhookEventResponse" }, "eventId": { "minLength": 1, "title": "Eventid", "type": "string" }, "eventType": { "title": "Eventtype", "type": "string" }, "id": { "minLength": 1, "title": "Id", "type": "string" }, "lastAttemptedAt": { "anyOf": [ { "description": "UTC RFC 3339 timestamp string.", "examples": [ "2026-06-12T12:00:00Z" ], "type": "string" }, { "type": "null" } ], "title": "Lastattemptedat" }, "responseBodySummary": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Responsebodysummary" }, "responseStatus": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Responsestatus" }, "status": { "title": "Status", "type": "string" }, "webhookEndpointId": { "minLength": 1, "title": "Webhookendpointid", "type": "string" } }, "required": [ "id", "webhookEndpointId", "eventId", "eventType", "status", "attemptCount", "responseStatus", "responseBodySummary", "error", "lastAttemptedAt", "deliveredAt", "createdAt", "event" ], "title": "WebhookDeliveryDetailResponse", "type": "object" }, "WebhookDeliveryResponse": { "additionalProperties": false, "properties": { "attemptCount": { "minimum": 0.0, "title": "Attemptcount", "type": "integer" }, "createdAt": { "anyOf": [ { "description": "UTC RFC 3339 timestamp string.", "examples": [ "2026-06-12T12:00:00Z" ], "type": "string" }, { "type": "null" } ], "title": "Createdat" }, "deliveredAt": { "anyOf": [ { "description": "UTC RFC 3339 timestamp string.", "examples": [ "2026-06-12T12:00:00Z" ], "type": "string" }, { "type": "null" } ], "title": "Deliveredat" }, "error": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Error" }, "eventId": { "minLength": 1, "title": "Eventid", "type": "string" }, "eventType": { "title": "Eventtype", "type": "string" }, "id": { "minLength": 1, "title": "Id", "type": "string" }, "lastAttemptedAt": { "anyOf": [ { "description": "UTC RFC 3339 timestamp string.", "examples": [ "2026-06-12T12:00:00Z" ], "type": "string" }, { "type": "null" } ], "title": "Lastattemptedat" }, "responseBodySummary": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Responsebodysummary" }, "responseStatus": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Responsestatus" }, "status": { "title": "Status", "type": "string" }, "webhookEndpointId": { "minLength": 1, "title": "Webhookendpointid", "type": "string" } }, "required": [ "id", "webhookEndpointId", "eventId", "eventType", "status", "attemptCount", "responseStatus", "responseBodySummary", "error", "lastAttemptedAt", "deliveredAt", "createdAt" ], "title": "WebhookDeliveryResponse", "type": "object" }, "WebhookEndpointCreateRequestBody": { "additionalProperties": false, "properties": { "description": { "anyOf": [ { "maxLength": 1024, "type": "string" }, { "type": "null" } ], "title": "Description" }, "enabled": { "default": true, "title": "Enabled", "type": "boolean" }, "eventTypes": { "items": { "enum": [ "export.ready", "row.failed", "run.canceled", "run.completed_with_flags", "run.created", "run.failed", "run.succeeded" ], "type": "string" }, "maxItems": 64, "minItems": 1, "title": "Eventtypes", "type": "array" }, "url": { "maxLength": 2048, "minLength": 1, "title": "Url", "type": "string" } }, "required": [ "url", "eventTypes" ], "title": "WebhookEndpointCreateRequestBody", "type": "object" }, "WebhookEndpointResponse": { "additionalProperties": false, "properties": { "createdAt": { "anyOf": [ { "description": "UTC RFC 3339 timestamp string.", "examples": [ "2026-06-12T12:00:00Z" ], "type": "string" }, { "type": "null" } ], "title": "Createdat" }, "deletedAt": { "anyOf": [ { "description": "UTC RFC 3339 timestamp string.", "examples": [ "2026-06-12T12:00:00Z" ], "type": "string" }, { "type": "null" } ], "title": "Deletedat" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "enabled": { "title": "Enabled", "type": "boolean" }, "eventTypes": { "items": { "type": "string" }, "title": "Eventtypes", "type": "array" }, "id": { "minLength": 1, "title": "Id", "type": "string" }, "signingSecretVersion": { "title": "Signingsecretversion", "type": "integer" }, "updatedAt": { "anyOf": [ { "description": "UTC RFC 3339 timestamp string.", "examples": [ "2026-06-12T12:00:00Z" ], "type": "string" }, { "type": "null" } ], "title": "Updatedat" }, "url": { "title": "Url", "type": "string" } }, "required": [ "id", "url", "description", "enabled", "eventTypes", "signingSecretVersion", "deletedAt", "createdAt", "updatedAt" ], "title": "WebhookEndpointResponse", "type": "object" }, "WebhookEndpointSecretResponse": { "additionalProperties": false, "properties": { "createdAt": { "anyOf": [ { "description": "UTC RFC 3339 timestamp string.", "examples": [ "2026-06-12T12:00:00Z" ], "type": "string" }, { "type": "null" } ], "title": "Createdat" }, "deletedAt": { "anyOf": [ { "description": "UTC RFC 3339 timestamp string.", "examples": [ "2026-06-12T12:00:00Z" ], "type": "string" }, { "type": "null" } ], "title": "Deletedat" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "enabled": { "title": "Enabled", "type": "boolean" }, "eventTypes": { "items": { "type": "string" }, "title": "Eventtypes", "type": "array" }, "id": { "minLength": 1, "title": "Id", "type": "string" }, "signingSecret": { "title": "Signingsecret", "type": "string" }, "signingSecretVersion": { "title": "Signingsecretversion", "type": "integer" }, "updatedAt": { "anyOf": [ { "description": "UTC RFC 3339 timestamp string.", "examples": [ "2026-06-12T12:00:00Z" ], "type": "string" }, { "type": "null" } ], "title": "Updatedat" }, "url": { "title": "Url", "type": "string" } }, "required": [ "id", "url", "description", "enabled", "eventTypes", "signingSecretVersion", "deletedAt", "createdAt", "updatedAt", "signingSecret" ], "title": "WebhookEndpointSecretResponse", "type": "object" }, "WebhookEndpointUpdateRequestBody": { "additionalProperties": false, "properties": { "description": { "anyOf": [ { "maxLength": 1024, "type": "string" }, { "type": "null" } ], "title": "Description" }, "enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Enabled" }, "eventTypes": { "anyOf": [ { "items": { "type": "string" }, "maxItems": 64, "minItems": 1, "type": "array" }, { "type": "null" } ], "items": { "enum": [ "export.ready", "row.failed", "run.canceled", "run.completed_with_flags", "run.created", "run.failed", "run.succeeded" ], "type": "string" }, "title": "Eventtypes" }, "url": { "anyOf": [ { "maxLength": 2048, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Url" } }, "title": "WebhookEndpointUpdateRequestBody", "type": "object" }, "WebhookEventResponse": { "additionalProperties": false, "properties": { "createdAt": { "anyOf": [ { "description": "UTC RFC 3339 timestamp string.", "examples": [ "2026-06-12T12:00:00Z" ], "type": "string" }, { "type": "null" } ], "title": "Createdat" }, "data": { "additionalProperties": true, "title": "Data", "type": "object" }, "id": { "minLength": 1, "title": "Id", "type": "string" }, "type": { "title": "Type", "type": "string" } }, "required": [ "id", "type", "createdAt", "data" ], "title": "WebhookEventResponse", "type": "object" }, "WorkspaceIncludedRowsResponse": { "additionalProperties": false, "properties": { "remaining": { "minimum": 0.0, "title": "Remaining", "type": "integer" }, "status": { "enum": [ "available", "low", "exhausted" ], "title": "Status", "type": "string" }, "total": { "minimum": 0.0, "title": "Total", "type": "integer" }, "used": { "minimum": 0.0, "title": "Used", "type": "integer" } }, "required": [ "used", "total", "remaining", "status" ], "title": "WorkspaceIncludedRowsResponse", "type": "object" }, "WorkspaceManagedAiExpirationResponse": { "additionalProperties": false, "properties": { "amount": { "$ref": "#/components/schemas/CustomerMoneyResponse" }, "expiresAt": { "format": "date-time", "title": "Expiresat", "type": "string" } }, "required": [ "expiresAt", "amount" ], "title": "WorkspaceManagedAiExpirationResponse", "type": "object" }, "WorkspaceManagedAiResponse": { "additionalProperties": false, "properties": { "executionSafe": { "$ref": "#/components/schemas/CustomerMoneyResponse" }, "nextExpiration": { "anyOf": [ { "$ref": "#/components/schemas/WorkspaceManagedAiExpirationResponse" }, { "type": "null" } ] }, "settledBalance": { "$ref": "#/components/schemas/CustomerMoneyResponse" }, "sources": { "items": { "$ref": "#/components/schemas/WorkspaceManagedAiSourceResponse" }, "title": "Sources", "type": "array" }, "status": { "enum": [ "available", "low", "unavailable" ], "title": "Status", "type": "string" } }, "required": [ "executionSafe", "settledBalance", "status", "sources", "nextExpiration" ], "title": "WorkspaceManagedAiResponse", "type": "object" }, "WorkspaceManagedAiSourceResponse": { "additionalProperties": false, "properties": { "available": { "$ref": "#/components/schemas/CustomerMoneyResponse" }, "kind": { "enum": [ "cardless_sample", "promotional", "recurring", "purchased", "correction" ], "title": "Kind", "type": "string" } }, "required": [ "kind", "available" ], "title": "WorkspaceManagedAiSourceResponse", "type": "object" }, "WorkspacePaygResponse": { "additionalProperties": false, "properties": { "acceptedBudget": { "$ref": "#/components/schemas/CustomerMoneyResponse" }, "committedBudget": { "$ref": "#/components/schemas/CustomerMoneyResponse" }, "enabled": { "title": "Enabled", "type": "boolean" }, "ratedRows": { "minimum": 0.0, "title": "Ratedrows", "type": "integer" }, "remainingBudget": { "$ref": "#/components/schemas/CustomerMoneyResponse" }, "status": { "enum": [ "off", "available", "low", "exhausted" ], "title": "Status", "type": "string" } }, "required": [ "enabled", "ratedRows", "acceptedBudget", "committedBudget", "remainingBudget", "status" ], "title": "WorkspacePaygResponse", "type": "object" }, "WorkspaceUsagePeriodResponse": { "additionalProperties": false, "properties": { "end": { "format": "date-time", "title": "End", "type": "string" }, "id": { "title": "Id", "type": "string" }, "start": { "format": "date-time", "title": "Start", "type": "string" } }, "required": [ "id", "start", "end" ], "title": "WorkspaceUsagePeriodResponse", "type": "object" }, "WorkspaceUsageResponse": { "additionalProperties": false, "properties": { "availability": { "const": "available", "title": "Availability", "type": "string" }, "billingAccountId": { "title": "Billingaccountid", "type": "string" }, "calculatedAt": { "format": "date-time", "title": "Calculatedat", "type": "string" }, "includedRows": { "$ref": "#/components/schemas/WorkspaceIncludedRowsResponse" }, "managedAi": { "$ref": "#/components/schemas/WorkspaceManagedAiResponse" }, "organizationId": { "title": "Organizationid", "type": "string" }, "payg": { "$ref": "#/components/schemas/WorkspacePaygResponse" }, "period": { "$ref": "#/components/schemas/WorkspaceUsagePeriodResponse" }, "primaryConsequence": { "enum": [ "subscription_hard_stop", "financial_hold", "row_risk_hold", "managed_ai_unavailable", "rows_unavailable", "usage_low", "available" ], "title": "Primaryconsequence", "type": "string" } }, "required": [ "availability", "organizationId", "billingAccountId", "calculatedAt", "period", "includedRows", "payg", "managedAi", "primaryConsequence" ], "title": "WorkspaceUsageResponse", "type": "object" }, "WorkspaceUsageUnavailableResponse": { "additionalProperties": false, "properties": { "availability": { "const": "unavailable", "title": "Availability", "type": "string" }, "billingAccountId": { "title": "Billingaccountid", "type": "string" }, "calculatedAt": { "format": "date-time", "title": "Calculatedat", "type": "string" }, "managedAi": { "anyOf": [ { "$ref": "#/components/schemas/WorkspaceManagedAiResponse" }, { "type": "null" } ] }, "organizationId": { "title": "Organizationid", "type": "string" }, "primaryConsequence": { "enum": [ "subscription_hard_stop", "financial_hold", "rows_unavailable" ], "title": "Primaryconsequence", "type": "string" }, "reason": { "const": "row_period_unavailable", "title": "Reason", "type": "string" } }, "required": [ "organizationId", "billingAccountId", "calculatedAt", "availability", "reason", "managedAi", "primaryConsequence" ], "title": "WorkspaceUsageUnavailableResponse", "type": "object" } }, "securitySchemes": { "BearerAuth": { "scheme": "bearer", "type": "http" }, "BrowserCsrf": { "description": "csrfToken returned by GET /v1/auth/session for the same authenticated browser session.", "in": "header", "name": "X-CSRF-Token", "type": "apiKey" }, "BrowserSession": { "description": "HttpOnly session cookie issued by browser login; deployment may configure its name.", "in": "cookie", "name": "everyn_session", "type": "apiKey" } } }, "info": { "description": "everyn self-serve API for dataset upload sessions, job specs, managed runs, run inspection, retry lineage, exports, alerts, webhooks, model catalog reads, usage and managed-AI balance reads, and organization administration.\n\nAPI routes use the `/v1` prefix. API-key product calls use `Authorization: Bearer sk-everyn-...` and derive organization context from the key. Job creation, editing and forking require a human browser session and CSRF protection; product API keys may read and run saved jobs but cannot author them. Browser-admin organization routes use bearer credentials and organization IDs in the route. Successful list responses use `{ \"data\": [], \"nextCursor\": null }`, and every response includes `X-Request-Id`.", "title": "everyn Public API", "version": "1.0.0" }, "openapi": "3.1.0", "paths": { "/healthz": { "get": { "description": "Healthz. Unauthenticated Everyn operational check. Send the request to the selected server from this document; no credential is required. Parameters and responses are typed in this document.", "operationId": "healthz_healthz_get", "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": { "type": "string" }, "title": "Response Healthz Healthz Get", "type": "object" } } }, "description": "Successful Response", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } } }, "summary": "Healthz", "tags": [ "health" ] } }, "/readyz": { "get": { "description": "Readyz. Unauthenticated Everyn operational check. Send the request to the selected server from this document; no credential is required. Parameters and responses are typed in this document.", "operationId": "readyz_readyz_get", "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": { "type": "string" }, "title": "Response Readyz Readyz Get", "type": "object" } } }, "description": "Successful Response", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } } }, "summary": "Readyz", "tags": [ "health" ] } }, "/v1/alert-deliveries": { "get": { "description": "List Alert Deliveries. Authenticated Everyn public API operation. Send the request to the selected server from this document with a product API key (Authorization: Bearer sk-everyn-...). Parameters and responses are typed in this document.", "operationId": "list_alert_deliveries_v1_alert_deliveries_get", "parameters": [ { "description": "Maximum number of items to return in this page.", "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "title": "Limit", "type": "integer" } }, { "description": "Opaque pagination cursor from the previous page.", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, { "description": "alertRuleId for this Everyn API operation.", "in": "query", "name": "alertRuleId", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Alertruleid" } }, { "description": "status for this Everyn API operation.", "in": "query", "name": "status", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "enum": [ "failed", "queued", "sent", "suppressed" ], "title": "Status" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_AlertDeliveryResponse_" } } }, "description": "Successful Response", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Malformed request, header, cursor, or multipart form field.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Missing, malformed, unknown, revoked, or expired credential.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Authenticated principal lacks the required scope or role.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Resource not found, including cross-organization resources.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Idempotency conflict or invalid resource state.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Public error", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Rate limit exceeded.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } } }, "security": [ { "BearerAuth": [] } ], "summary": "List Alert Deliveries", "tags": [ "alert-rules" ] } }, "/v1/alert-rules": { "get": { "description": "List Alert Rules. Authenticated Everyn public API operation. Send the request to the selected server from this document with a product API key (Authorization: Bearer sk-everyn-...). Parameters and responses are typed in this document.", "operationId": "list_alert_rules_v1_alert_rules_get", "parameters": [ { "description": "Maximum number of items to return in this page.", "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "title": "Limit", "type": "integer" } }, { "description": "Opaque pagination cursor from the previous page.", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, { "description": "enabled for this Everyn API operation.", "in": "query", "name": "enabled", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Enabled" } }, { "description": "eventType for this Everyn API operation.", "in": "query", "name": "eventType", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "enum": [ "export.failed", "export.ready", "row.failed", "row.flagged", "run.canceled", "run.completed_with_flags", "run.failed", "run.succeeded" ], "title": "Eventtype" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_AlertRuleResponse_" } } }, "description": "Successful Response", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Malformed request, header, cursor, or multipart form field.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Missing, malformed, unknown, revoked, or expired credential.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Authenticated principal lacks the required scope or role.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Resource not found, including cross-organization resources.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Idempotency conflict or invalid resource state.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Public error", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Rate limit exceeded.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } } }, "security": [ { "BearerAuth": [] } ], "summary": "List Alert Rules", "tags": [ "alert-rules" ] }, "post": { "description": "Create Alert Rule. Authenticated Everyn public API operation. Send the request to the selected server from this document with a product API key (Authorization: Bearer sk-everyn-...). Parameters and responses are typed in this document.", "operationId": "create_alert_rule_v1_alert_rules_post", "parameters": [ { "description": "Caller-supplied key that makes this write retry-safe.", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency-Key" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertRuleCreateRequestBody" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertRuleResponse" } } }, "description": "Successful Response", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Malformed request, header, cursor, or multipart form field.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Missing, malformed, unknown, revoked, or expired credential.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Authenticated principal lacks the required scope or role.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Resource not found, including cross-organization resources.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Idempotency conflict or invalid resource state.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Public error", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Rate limit exceeded.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Create Alert Rule", "tags": [ "alert-rules" ] } }, "/v1/alert-rules/{alert_rule_id}": { "delete": { "description": "Delete Alert Rule. Authenticated Everyn public API operation. Send the request to the selected server from this document with a product API key (Authorization: Bearer sk-everyn-...). Parameters and responses are typed in this document.", "operationId": "delete_alert_rule_v1_alert_rules__alert_rule_id__delete", "parameters": [ { "description": "Identifier of the alert rule.", "in": "path", "name": "alert_rule_id", "required": true, "schema": { "title": "Alert Rule Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertRuleResponse" } } }, "description": "Successful Response", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Malformed request, header, cursor, or multipart form field.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Missing, malformed, unknown, revoked, or expired credential.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Authenticated principal lacks the required scope or role.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Resource not found, including cross-organization resources.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Idempotency conflict or invalid resource state.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Public error", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Rate limit exceeded.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Delete Alert Rule", "tags": [ "alert-rules" ] }, "get": { "description": "Get Alert Rule. Authenticated Everyn public API operation. Send the request to the selected server from this document with a product API key (Authorization: Bearer sk-everyn-...). Parameters and responses are typed in this document.", "operationId": "get_alert_rule_v1_alert_rules__alert_rule_id__get", "parameters": [ { "description": "Identifier of the alert rule.", "in": "path", "name": "alert_rule_id", "required": true, "schema": { "title": "Alert Rule Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertRuleResponse" } } }, "description": "Successful Response", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Malformed request, header, cursor, or multipart form field.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Missing, malformed, unknown, revoked, or expired credential.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Authenticated principal lacks the required scope or role.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Resource not found, including cross-organization resources.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Idempotency conflict or invalid resource state.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Public error", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Rate limit exceeded.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Get Alert Rule", "tags": [ "alert-rules" ] }, "patch": { "description": "Update Alert Rule. Authenticated Everyn public API operation. Send the request to the selected server from this document with a product API key (Authorization: Bearer sk-everyn-...). Parameters and responses are typed in this document.", "operationId": "update_alert_rule_v1_alert_rules__alert_rule_id__patch", "parameters": [ { "description": "Identifier of the alert rule.", "in": "path", "name": "alert_rule_id", "required": true, "schema": { "title": "Alert Rule Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertRuleUpdateRequestBody" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertRuleResponse" } } }, "description": "Successful Response", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Malformed request, header, cursor, or multipart form field.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Missing, malformed, unknown, revoked, or expired credential.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Authenticated principal lacks the required scope or role.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Resource not found, including cross-organization resources.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Idempotency conflict or invalid resource state.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Public error", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Rate limit exceeded.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Update Alert Rule", "tags": [ "alert-rules" ] } }, "/v1/billing/stripe/webhooks": { "post": { "description": "Authenticate, store, acknowledge. The billing boundary worker converges it.\n\n202 rather than 204 because that is what actually happened: the payload is\ndurable and nothing has acted on it yet. Stripe treats any 2xx as delivered,\nso the distinction is for us — a reader of this route should not think the\nplan is active by the time it returns.", "operationId": "ingest_stripe_billing_webhook_v1_billing_stripe_webhooks_post", "responses": { "202": { "description": "Successful Response", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Malformed request, header, cursor, or multipart form field.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Missing, malformed, unknown, revoked, or expired credential.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Authenticated principal lacks the required scope or role.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Resource not found, including cross-organization resources.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Idempotency conflict or invalid resource state.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Rate limit exceeded.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Ingest Stripe Billing Webhook", "tags": [ "billing" ] } }, "/v1/dataset-uploads": { "get": { "description": "List Dataset Uploads. Authenticated Everyn public API operation. Send the request to the selected server from this document with a product API key (Authorization: Bearer sk-everyn-...). Parameters and responses are typed in this document.", "operationId": "list_dataset_uploads_v1_dataset_uploads_get", "parameters": [ { "description": "Maximum number of items to return in this page.", "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "title": "Limit", "type": "integer" } }, { "description": "Opaque pagination cursor from the previous page.", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_DatasetUploadResponse_" } } }, "description": "Successful Response", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Malformed request, header, cursor, or multipart form field.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Missing, malformed, unknown, revoked, or expired credential.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Authenticated principal lacks the required scope or role.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Resource not found, including cross-organization resources.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Idempotency conflict or invalid resource state.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Public error", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Rate limit exceeded.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } } }, "security": [ { "BearerAuth": [] } ], "summary": "List Dataset Uploads", "tags": [ "dataset-uploads" ] }, "post": { "description": "Create Dataset Upload. Authenticated Everyn public API operation. Send the request to the selected server from this document with a product API key (Authorization: Bearer sk-everyn-...). Parameters and responses are typed in this document.", "operationId": "create_dataset_upload_v1_dataset_uploads_post", "parameters": [ { "description": "Caller-supplied key that makes this write retry-safe.", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency-Key" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_create_dataset_upload_v1_dataset_uploads_post" } } }, "required": true }, "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DatasetUploadResponse" } } }, "description": "Successful Response", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Malformed request, header, cursor, or multipart form field.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Missing, malformed, unknown, revoked, or expired credential.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Authenticated principal lacks the required scope or role.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Resource not found, including cross-organization resources.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Idempotency conflict or invalid resource state.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Multipart CSV exceeds the 25 MiB direct upload limit.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Public error", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Rate limit exceeded.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Create Dataset Upload", "tags": [ "dataset-uploads" ] } }, "/v1/dataset-uploads/{upload_id}": { "get": { "description": "Get Dataset Upload. Authenticated Everyn public API operation. Send the request to the selected server from this document with a product API key (Authorization: Bearer sk-everyn-...). Parameters and responses are typed in this document.", "operationId": "get_dataset_upload_v1_dataset_uploads__upload_id__get", "parameters": [ { "description": "upload_id for this Everyn API operation.", "in": "path", "name": "upload_id", "required": true, "schema": { "title": "Upload Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DatasetUploadResponse" } } }, "description": "Successful Response", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Malformed request, header, cursor, or multipart form field.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Missing, malformed, unknown, revoked, or expired credential.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Authenticated principal lacks the required scope or role.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Resource not found, including cross-organization resources.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Idempotency conflict or invalid resource state.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Public error", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Rate limit exceeded.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Get Dataset Upload", "tags": [ "dataset-uploads" ] } }, "/v1/dataset-uploads/{upload_id}/retry": { "post": { "description": "Retry Dataset Upload. Authenticated Everyn public API operation. Send the request to the selected server from this document with a product API key (Authorization: Bearer sk-everyn-...). Parameters and responses are typed in this document.", "operationId": "retry_dataset_upload_v1_dataset_uploads__upload_id__retry_post", "parameters": [ { "description": "upload_id for this Everyn API operation.", "in": "path", "name": "upload_id", "required": true, "schema": { "title": "Upload Id", "type": "string" } } ], "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DatasetUploadResponse" } } }, "description": "Successful Response", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Malformed request, header, cursor, or multipart form field.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Missing, malformed, unknown, revoked, or expired credential.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Authenticated principal lacks the required scope or role.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Resource not found, including cross-organization resources.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Idempotency conflict or invalid resource state.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Public error", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Rate limit exceeded.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Retry Dataset Upload", "tags": [ "dataset-uploads" ] } }, "/v1/datasets": { "get": { "description": "List Datasets. Authenticated Everyn public API operation. Send the request to the selected server from this document with a product API key (Authorization: Bearer sk-everyn-...). Parameters and responses are typed in this document.", "operationId": "list_datasets_v1_datasets_get", "parameters": [ { "description": "Maximum number of items to return in this page.", "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "title": "Limit", "type": "integer" } }, { "description": "Opaque pagination cursor from the previous page.", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, { "description": "query for this Everyn API operation.", "in": "query", "name": "query", "required": false, "schema": { "anyOf": [ { "maxLength": 200, "type": "string" }, { "type": "null" } ], "title": "Query" } }, { "description": "sort for this Everyn API operation.", "in": "query", "name": "sort", "required": false, "schema": { "default": "createdAt", "enum": [ "createdAt", "sourceName", "rowCount" ], "title": "Sort", "type": "string" } }, { "description": "direction for this Everyn API operation.", "in": "query", "name": "direction", "required": false, "schema": { "default": "desc", "enum": [ "asc", "desc" ], "title": "Direction", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CountedBidirectionalPage_DatasetReadResponse_" } } }, "description": "Successful Response", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Malformed request, header, cursor, or multipart form field.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Missing, malformed, unknown, revoked, or expired credential.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Authenticated principal lacks the required scope or role.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Resource not found, including cross-organization resources.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Idempotency conflict or invalid resource state.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Public error", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Rate limit exceeded.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } } }, "security": [ { "BearerAuth": [] } ], "summary": "List Datasets", "tags": [ "datasets" ] } }, "/v1/datasets/{dataset_id}": { "get": { "description": "Get Dataset. Authenticated Everyn public API operation. Send the request to the selected server from this document with a product API key (Authorization: Bearer sk-everyn-...). Parameters and responses are typed in this document.", "operationId": "get_dataset_v1_datasets__dataset_id__get", "parameters": [ { "description": "Identifier of the dataset.", "in": "path", "name": "dataset_id", "required": true, "schema": { "title": "Dataset Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DatasetReadResponse" } } }, "description": "Successful Response", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Malformed request, header, cursor, or multipart form field.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Missing, malformed, unknown, revoked, or expired credential.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Authenticated principal lacks the required scope or role.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Resource not found, including cross-organization resources.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Idempotency conflict or invalid resource state.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Public error", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Rate limit exceeded.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Get Dataset", "tags": [ "datasets" ] } }, "/v1/datasets/{dataset_id}/profile": { "get": { "description": "Get Dataset Profile. Authenticated Everyn public API operation. Send the request to the selected server from this document with a product API key (Authorization: Bearer sk-everyn-...). Parameters and responses are typed in this document.", "operationId": "get_dataset_profile_v1_datasets__dataset_id__profile_get", "parameters": [ { "description": "Identifier of the dataset.", "in": "path", "name": "dataset_id", "required": true, "schema": { "title": "Dataset Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DatasetProfileResponse" } } }, "description": "Successful Response", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Malformed request, header, cursor, or multipart form field.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Missing, malformed, unknown, revoked, or expired credential.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Authenticated principal lacks the required scope or role.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Resource not found, including cross-organization resources.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Idempotency conflict or invalid resource state.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Public error", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Rate limit exceeded.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Get Dataset Profile", "tags": [ "datasets" ] } }, "/v1/datasets/{dataset_id}/rows": { "get": { "description": "List Dataset Rows. Authenticated Everyn public API operation. Send the request to the selected server from this document with a product API key (Authorization: Bearer sk-everyn-...). Parameters and responses are typed in this document.", "operationId": "list_dataset_rows_v1_datasets__dataset_id__rows_get", "parameters": [ { "description": "Identifier of the dataset.", "in": "path", "name": "dataset_id", "required": true, "schema": { "title": "Dataset Id", "type": "string" } }, { "description": "Maximum number of items to return in this page.", "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "title": "Limit", "type": "integer" } }, { "description": "Opaque pagination cursor from the previous page.", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_DatasetRowResponse_" } } }, "description": "Successful Response", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Malformed request, header, cursor, or multipart form field.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Missing, malformed, unknown, revoked, or expired credential.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Authenticated principal lacks the required scope or role.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Resource not found, including cross-organization resources.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Idempotency conflict or invalid resource state.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Public error", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Rate limit exceeded.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } } }, "security": [ { "BearerAuth": [] } ], "summary": "List Dataset Rows", "tags": [ "datasets" ] } }, "/v1/exports": { "get": { "description": "List Exports. Authenticated Everyn public API operation. Send the request to the selected server from this document with a product API key (Authorization: Bearer sk-everyn-...). Parameters and responses are typed in this document.", "operationId": "list_exports_v1_exports_get", "parameters": [ { "description": "Maximum number of items to return in this page.", "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "title": "Limit", "type": "integer" } }, { "description": "Opaque pagination cursor from the previous page.", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, { "description": "Identifier of the run.", "in": "query", "name": "runId", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Runid" } }, { "description": "status for this Everyn API operation.", "in": "query", "name": "status", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "enum": [ "expired", "failed", "generating", "queued", "ready" ], "title": "Status" } }, { "description": "type for this Everyn API operation.", "in": "query", "name": "type", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "enum": [ "all_rows", "failed_rows", "flagged_rows", "generated_outputs", "resolved_lineage_results", "successful_rows" ], "title": "Type" } }, { "description": "format for this Everyn API operation.", "in": "query", "name": "format", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "enum": [ "csv" ], "title": "Format" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_ExportResponse_" } } }, "description": "Successful Response", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Malformed request, header, cursor, or multipart form field.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Missing, malformed, unknown, revoked, or expired credential.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Authenticated principal lacks the required scope or role.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Resource not found, including cross-organization resources.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Idempotency conflict or invalid resource state.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Public error", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Rate limit exceeded.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } } }, "security": [ { "BearerAuth": [] } ], "summary": "List Exports", "tags": [ "exports" ] } }, "/v1/exports/{export_id}": { "get": { "description": "Get Export. Authenticated Everyn public API operation. Send the request to the selected server from this document with a product API key (Authorization: Bearer sk-everyn-...). Parameters and responses are typed in this document.", "operationId": "get_export_v1_exports__export_id__get", "parameters": [ { "description": "export_id for this Everyn API operation.", "in": "path", "name": "export_id", "required": true, "schema": { "title": "Export Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExportResponse" } } }, "description": "Successful Response", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Malformed request, header, cursor, or multipart form field.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Missing, malformed, unknown, revoked, or expired credential.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Authenticated principal lacks the required scope or role.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Resource not found, including cross-organization resources.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Idempotency conflict or invalid resource state.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Public error", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Rate limit exceeded.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Get Export", "tags": [ "exports" ] } }, "/v1/exports/{export_id}/download": { "get": { "description": "Download Export. Authenticated Everyn public API operation. Send the request to the selected server from this document with a product API key (Authorization: Bearer sk-everyn-...). Parameters and responses are typed in this document.", "operationId": "download_export_v1_exports__export_id__download_get", "parameters": [ { "description": "export_id for this Everyn API operation.", "in": "path", "name": "export_id", "required": true, "schema": { "title": "Export Id", "type": "string" } } ], "responses": { "200": { "content": { "text/csv": { "schema": { "format": "binary", "type": "string" } } }, "description": "CSV export artifact", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Malformed request, header, cursor, or multipart form field.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Missing, malformed, unknown, revoked, or expired credential.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Authenticated principal lacks the required scope or role.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Resource not found, including cross-organization resources.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Idempotency conflict or invalid resource state.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "410": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Export artifact has expired.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Public error", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Rate limit exceeded.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Download Export", "tags": [ "exports" ] } }, "/v1/invitations/{invitation_token}/accept": { "post": { "description": "Accept Organization Invitation. Browser-admin Everyn operation. Send the request to the selected server from this document with a human principal bearer token. Product API keys cannot call this route. Parameters and responses are typed in this document.", "operationId": "accept_organization_invitation_v1_invitations__invitation_token__accept_post", "parameters": [ { "description": "invitation_token for this Everyn API operation.", "in": "path", "name": "invitation_token", "required": true, "schema": { "title": "Invitation Token", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationMemberResponse" } } }, "description": "Successful Response", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Malformed request, header, cursor, or multipart form field.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Missing, malformed, unknown, revoked, or expired credential.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Authenticated principal lacks the required scope or role.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Resource not found, including cross-organization resources.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Idempotency conflict or invalid resource state.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Public error", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Rate limit exceeded.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Accept Organization Invitation", "tags": [ "organization-admin" ] } }, "/v1/job-specs": { "get": { "description": "List Job Specs. Authenticated Everyn public API operation. Send the request to the selected server from this document with a product API key (Authorization: Bearer sk-everyn-...). Parameters and responses are typed in this document.", "operationId": "list_job_specs_v1_job_specs_get", "parameters": [ { "description": "Maximum number of items to return in this page.", "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "title": "Limit", "type": "integer" } }, { "description": "Opaque pagination cursor from the previous page.", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_JobSpecResponse_" } } }, "description": "Successful Response", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Malformed request, header, cursor, or multipart form field.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Missing, malformed, unknown, revoked, or expired credential.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Authenticated principal lacks the required scope or role.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Resource not found, including cross-organization resources.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Idempotency conflict or invalid resource state.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Public error", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Rate limit exceeded.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } } }, "security": [ { "BearerAuth": [] } ], "summary": "List Job Specs", "tags": [ "job-specs" ] }, "post": { "description": "Create Job Spec. Human browser job-authoring operation. Sign in through /auth/login on the configured dashboard origin, then GET /v1/auth/session with the browser session cookie to obtain csrfToken. Send this mutation from that same-origin browser session with the cookie and X-CSRF-Token header; the browser supplies its Origin metadata. Do not send an Authorization bearer header. The session cookie is HttpOnly and must not be copied into a public documentation console. Current workspace write membership is required; editing also requires Job ownership. Product API keys cannot call this route. Parameters and responses are typed in this document.", "operationId": "create_job_spec_v1_job_specs_post", "parameters": [ { "description": "Caller-supplied key that makes this write retry-safe.", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency-Key" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobSpecRequestBody" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobSpecResponse" } } }, "description": "Successful Response", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Malformed request, header, cursor, or multipart form field.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Missing, malformed, unknown, revoked, or expired credential.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Authenticated principal lacks the required scope or role.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Resource not found, including cross-organization resources.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Idempotency conflict or invalid resource state.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Public error", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Rate limit exceeded.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } } }, "security": [ { "BrowserCsrf": [], "BrowserSession": [] } ], "summary": "Create Job Spec", "tags": [ "job-specs" ] } }, "/v1/job-specs/summaries": { "get": { "description": "List Job Spec Summaries. Authenticated Everyn public API operation. Send the request to the selected server from this document with a product API key (Authorization: Bearer sk-everyn-...). Parameters and responses are typed in this document.", "operationId": "list_job_spec_summaries_v1_job_specs_summaries_get", "parameters": [ { "description": "Maximum number of items to return in this page.", "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "title": "Limit", "type": "integer" } }, { "description": "Opaque pagination cursor from the previous page.", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, { "description": "query for this Everyn API operation.", "in": "query", "name": "query", "required": false, "schema": { "anyOf": [ { "maxLength": 200, "type": "string" }, { "type": "null" } ], "title": "Query" } }, { "description": "sort for this Everyn API operation.", "in": "query", "name": "sort", "required": false, "schema": { "default": "createdAt", "enum": [ "createdAt", "lastRunAt" ], "title": "Sort", "type": "string" } }, { "description": "direction for this Everyn API operation.", "in": "query", "name": "direction", "required": false, "schema": { "default": "desc", "enum": [ "asc", "desc" ], "title": "Direction", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CountedBidirectionalPage_JobSpecSummaryResponse_" } } }, "description": "Successful Response", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Malformed request, header, cursor, or multipart form field.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Missing, malformed, unknown, revoked, or expired credential.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Authenticated principal lacks the required scope or role.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Resource not found, including cross-organization resources.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Idempotency conflict or invalid resource state.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Public error", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Rate limit exceeded.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } } }, "security": [ { "BearerAuth": [] } ], "summary": "List Job Spec Summaries", "tags": [ "job-specs" ] } }, "/v1/job-specs/toolsets": { "get": { "description": "List the optional row-agent tool bundles a job spec version may declare.\n\nServed from the closed registry so clients never hardcode the set.", "operationId": "list_row_agent_toolsets_v1_job_specs_toolsets_get", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentToolsetListResponse" } } }, "description": "Successful Response", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Malformed request, header, cursor, or multipart form field.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Missing, malformed, unknown, revoked, or expired credential.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Authenticated principal lacks the required scope or role.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Resource not found, including cross-organization resources.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Idempotency conflict or invalid resource state.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Public error", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Rate limit exceeded.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } } }, "security": [ { "BearerAuth": [] } ], "summary": "List Row Agent Toolsets", "tags": [ "job-specs" ] } }, "/v1/job-specs/{job_spec_id}": { "get": { "description": "Get Job Spec. Authenticated Everyn public API operation. Send the request to the selected server from this document with a product API key (Authorization: Bearer sk-everyn-...). Parameters and responses are typed in this document.", "operationId": "get_job_spec_v1_job_specs__job_spec_id__get", "parameters": [ { "description": "Identifier of the job spec.", "in": "path", "name": "job_spec_id", "required": true, "schema": { "title": "Job Spec Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobSpecDetailResponse" } } }, "description": "Successful Response", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Malformed request, header, cursor, or multipart form field.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Missing, malformed, unknown, revoked, or expired credential.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Authenticated principal lacks the required scope or role.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Resource not found, including cross-organization resources.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Idempotency conflict or invalid resource state.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Public error", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Rate limit exceeded.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Get Job Spec", "tags": [ "job-specs" ] }, "patch": { "description": "Update Job Spec. Human browser job-authoring operation. Sign in through /auth/login on the configured dashboard origin, then GET /v1/auth/session with the browser session cookie to obtain csrfToken. Send this mutation from that same-origin browser session with the cookie and X-CSRF-Token header; the browser supplies its Origin metadata. Do not send an Authorization bearer header. The session cookie is HttpOnly and must not be copied into a public documentation console. Current workspace write membership is required; editing also requires Job ownership. Product API keys cannot call this route. Parameters and responses are typed in this document.", "operationId": "update_job_spec_v1_job_specs__job_spec_id__patch", "parameters": [ { "description": "Identifier of the job spec.", "in": "path", "name": "job_spec_id", "required": true, "schema": { "title": "Job Spec Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobSpecUpdateRequestBody" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobSpecResponse" } } }, "description": "Successful Response", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Malformed request, header, cursor, or multipart form field.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Missing, malformed, unknown, revoked, or expired credential.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Authenticated principal lacks the required scope or role.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Resource not found, including cross-organization resources.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Idempotency conflict or invalid resource state.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Public error", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Rate limit exceeded.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } } }, "security": [ { "BrowserCsrf": [], "BrowserSession": [] } ], "summary": "Update Job Spec", "tags": [ "job-specs" ] } }, "/v1/job-specs/{job_spec_id}/fork": { "post": { "description": "Fork Job Spec. Human browser job-authoring operation. Sign in through /auth/login on the configured dashboard origin, then GET /v1/auth/session with the browser session cookie to obtain csrfToken. Send this mutation from that same-origin browser session with the cookie and X-CSRF-Token header; the browser supplies its Origin metadata. Do not send an Authorization bearer header. The session cookie is HttpOnly and must not be copied into a public documentation console. Current workspace write membership is required; editing also requires Job ownership. Product API keys cannot call this route. Parameters and responses are typed in this document.", "operationId": "fork_job_spec_v1_job_specs__job_spec_id__fork_post", "parameters": [ { "description": "Identifier of the job spec.", "in": "path", "name": "job_spec_id", "required": true, "schema": { "title": "Job Spec Id", "type": "string" } }, { "description": "Caller-supplied key that makes this write retry-safe.", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency-Key" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForkJobSpecRequestBody" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobSpecResponse" } } }, "description": "Successful Response", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Malformed request, header, cursor, or multipart form field.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Missing, malformed, unknown, revoked, or expired credential.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Authenticated principal lacks the required scope or role.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Resource not found, including cross-organization resources.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Idempotency conflict or invalid resource state.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Public error", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Rate limit exceeded.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } } }, "security": [ { "BrowserCsrf": [], "BrowserSession": [] } ], "summary": "Fork Job Spec", "tags": [ "job-specs" ] } }, "/v1/job-specs/{job_spec_id}/runs": { "get": { "description": "List Job Runs. Authenticated Everyn public API operation. Send the request to the selected server from this document with a product API key (Authorization: Bearer sk-everyn-...). Parameters and responses are typed in this document.", "operationId": "list_job_runs_v1_job_specs__job_spec_id__runs_get", "parameters": [ { "description": "Identifier of the job spec.", "in": "path", "name": "job_spec_id", "required": true, "schema": { "title": "Job Spec Id", "type": "string" } }, { "description": "Maximum number of items to return in this page.", "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "title": "Limit", "type": "integer" } }, { "description": "Opaque pagination cursor from the previous page.", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BidirectionalPage_JobRunHistoryResponse_" } } }, "description": "Successful Response", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Malformed request, header, cursor, or multipart form field.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Missing, malformed, unknown, revoked, or expired credential.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Authenticated principal lacks the required scope or role.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Resource not found, including cross-organization resources.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Idempotency conflict or invalid resource state.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Public error", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Rate limit exceeded.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } } }, "security": [ { "BearerAuth": [] } ], "summary": "List Job Runs", "tags": [ "job-specs" ] } }, "/v1/job-specs/{job_spec_id}/versions": { "get": { "description": "List Job Spec Versions. Authenticated Everyn public API operation. Send the request to the selected server from this document with a product API key (Authorization: Bearer sk-everyn-...). Parameters and responses are typed in this document.", "operationId": "list_job_spec_versions_v1_job_specs__job_spec_id__versions_get", "parameters": [ { "description": "Identifier of the job spec.", "in": "path", "name": "job_spec_id", "required": true, "schema": { "title": "Job Spec Id", "type": "string" } }, { "description": "Maximum number of items to return in this page.", "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "title": "Limit", "type": "integer" } }, { "description": "Opaque pagination cursor from the previous page.", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, { "description": "excludeCurrent for this Everyn API operation.", "in": "query", "name": "excludeCurrent", "required": false, "schema": { "default": false, "title": "Excludecurrent", "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BidirectionalPage_JobSpecVersionResponse_" } } }, "description": "Successful Response", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Malformed request, header, cursor, or multipart form field.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Missing, malformed, unknown, revoked, or expired credential.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Authenticated principal lacks the required scope or role.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Resource not found, including cross-organization resources.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Idempotency conflict or invalid resource state.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Public error", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Rate limit exceeded.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } } }, "security": [ { "BearerAuth": [] } ], "summary": "List Job Spec Versions", "tags": [ "job-specs" ] } }, "/v1/job-specs/{job_spec_id}/versions/{version_id}": { "get": { "description": "Get Job Spec Version. Authenticated Everyn public API operation. Send the request to the selected server from this document with a product API key (Authorization: Bearer sk-everyn-...). Parameters and responses are typed in this document.", "operationId": "get_job_spec_version_v1_job_specs__job_spec_id__versions__version_id__get", "parameters": [ { "description": "Identifier of the job spec.", "in": "path", "name": "job_spec_id", "required": true, "schema": { "title": "Job Spec Id", "type": "string" } }, { "description": "version_id for this Everyn API operation.", "in": "path", "name": "version_id", "required": true, "schema": { "title": "Version Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobSpecVersionResponse" } } }, "description": "Successful Response", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Malformed request, header, cursor, or multipart form field.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Missing, malformed, unknown, revoked, or expired credential.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Authenticated principal lacks the required scope or role.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Resource not found, including cross-organization resources.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Idempotency conflict or invalid resource state.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Public error", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Rate limit exceeded.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Get Job Spec Version", "tags": [ "job-specs" ] } }, "/v1/me": { "get": { "description": "Get Me. Browser-admin Everyn operation. Send the request to the selected server from this document with a human principal bearer token. Product API keys cannot call this route. Parameters and responses are typed in this document.", "operationId": "get_me_v1_me_get", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MeResponse" } } }, "description": "Successful Response", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Malformed request, header, cursor, or multipart form field.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Missing, malformed, unknown, revoked, or expired credential.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Authenticated principal lacks the required scope or role.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Resource not found, including cross-organization resources.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Idempotency conflict or invalid resource state.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Public error", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Rate limit exceeded.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Get Me", "tags": [ "organization-admin" ] }, "patch": { "description": "Update Me Profile. Browser-admin Everyn operation. Send the request to the selected server from this document with a human principal bearer token. Product API keys cannot call this route. Parameters and responses are typed in this document.", "operationId": "update_me_profile_v1_me_patch", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserProfileUpdateRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HumanUserResponse" } } }, "description": "Successful Response", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Malformed request, header, cursor, or multipart form field.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Missing, malformed, unknown, revoked, or expired credential.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Authenticated principal lacks the required scope or role.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Resource not found, including cross-organization resources.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Idempotency conflict or invalid resource state.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Public error", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Rate limit exceeded.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Update Me Profile", "tags": [ "organization-admin" ] } }, "/v1/me/signup-profile/{acquisition_id}": { "get": { "description": "Get Signup Profile. Browser-admin Everyn operation. Send the request to the selected server from this document with a human principal bearer token. Product API keys cannot call this route. Parameters and responses are typed in this document.", "operationId": "get_signup_profile_v1_me_signup_profile__acquisition_id__get", "parameters": [ { "description": "acquisition_id for this Everyn API operation.", "in": "path", "name": "acquisition_id", "required": true, "schema": { "title": "Acquisition Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SignupProfileResponse" } } }, "description": "Successful Response", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Malformed request, header, cursor, or multipart form field.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Missing, malformed, unknown, revoked, or expired credential.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Authenticated principal lacks the required scope or role.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Resource not found, including cross-organization resources.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Idempotency conflict or invalid resource state.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Public error", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Rate limit exceeded.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Get Signup Profile", "tags": [ "organization-admin" ] } }, "/v1/me/signup-profile/{acquisition_id}/complete": { "post": { "description": "Complete Signup Profile. Browser-admin Everyn operation. Send the request to the selected server from this document with a human principal bearer token. Product API keys cannot call this route. Parameters and responses are typed in this document.", "operationId": "complete_signup_profile_v1_me_signup_profile__acquisition_id__complete_post", "parameters": [ { "description": "acquisition_id for this Everyn API operation.", "in": "path", "name": "acquisition_id", "required": true, "schema": { "title": "Acquisition Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SignupProfileCompleteRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SignupProfileResponse" } } }, "description": "Successful Response", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Malformed request, header, cursor, or multipart form field.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Missing, malformed, unknown, revoked, or expired credential.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Authenticated principal lacks the required scope or role.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Resource not found, including cross-organization resources.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Idempotency conflict or invalid resource state.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Public error", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Rate limit exceeded.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Complete Signup Profile", "tags": [ "organization-admin" ] } }, "/v1/model-providers": { "get": { "description": "List Model Providers. Authenticated Everyn public API operation. Send the request to the selected server from this document with a product API key (Authorization: Bearer sk-everyn-...). Parameters and responses are typed in this document.", "operationId": "list_model_providers_v1_model_providers_get", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_ModelProviderResponse_" } } }, "description": "Successful Response", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Malformed request, header, cursor, or multipart form field.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Missing, malformed, unknown, revoked, or expired credential.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Authenticated principal lacks the required scope or role.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Resource not found, including cross-organization resources.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Idempotency conflict or invalid resource state.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Public error", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Rate limit exceeded.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } } }, "security": [ { "BearerAuth": [] } ], "summary": "List Model Providers", "tags": [ "models" ] } }, "/v1/models": { "get": { "description": "List Models. Authenticated Everyn public API operation. Send the request to the selected server from this document with a product API key (Authorization: Bearer sk-everyn-...). Parameters and responses are typed in this document.", "operationId": "list_models_v1_models_get", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_ModelResponse_" } } }, "description": "Successful Response", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Malformed request, header, cursor, or multipart form field.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Missing, malformed, unknown, revoked, or expired credential.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Authenticated principal lacks the required scope or role.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Resource not found, including cross-organization resources.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Idempotency conflict or invalid resource state.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Public error", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Rate limit exceeded.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } } }, "security": [ { "BearerAuth": [] } ], "summary": "List Models", "tags": [ "models" ] } }, "/v1/models/{model_id_or_key}": { "get": { "description": "Get Model. Authenticated Everyn public API operation. Send the request to the selected server from this document with a product API key (Authorization: Bearer sk-everyn-...). Parameters and responses are typed in this document.", "operationId": "get_model_v1_models__model_id_or_key__get", "parameters": [ { "description": "model_id_or_key for this Everyn API operation.", "in": "path", "name": "model_id_or_key", "required": true, "schema": { "title": "Model Id Or Key", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModelResponse" } } }, "description": "Successful Response", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Malformed request, header, cursor, or multipart form field.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Missing, malformed, unknown, revoked, or expired credential.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Authenticated principal lacks the required scope or role.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Resource not found, including cross-organization resources.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Idempotency conflict or invalid resource state.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Public error", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Rate limit exceeded.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Get Model", "tags": [ "models" ] } }, "/v1/organizations": { "get": { "description": "List Organizations. Browser-admin Everyn operation. Send the request to the selected server from this document with a human principal bearer token. Product API keys cannot call this route. Parameters and responses are typed in this document.", "operationId": "list_organizations_v1_organizations_get", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_OrganizationResponse_" } } }, "description": "Successful Response", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Malformed request, header, cursor, or multipart form field.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Missing, malformed, unknown, revoked, or expired credential.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Authenticated principal lacks the required scope or role.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Resource not found, including cross-organization resources.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Idempotency conflict or invalid resource state.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Public error", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Rate limit exceeded.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } } }, "security": [ { "BearerAuth": [] } ], "summary": "List Organizations", "tags": [ "organization-admin" ] }, "post": { "description": "Create Organization. Browser-admin Everyn operation. Send the request to the selected server from this document with a human principal bearer token. Product API keys cannot call this route. Parameters and responses are typed in this document.", "operationId": "create_organization_v1_organizations_post", "parameters": [ { "description": "Caller-supplied key that makes this write retry-safe.", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency-Key" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationCreateRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationResponse" } } }, "description": "Successful Response", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Malformed request, header, cursor, or multipart form field.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Missing, malformed, unknown, revoked, or expired credential.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Authenticated principal lacks the required scope or role.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Resource not found, including cross-organization resources.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Idempotency conflict or invalid resource state.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Public error", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Rate limit exceeded.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Create Organization", "tags": [ "organization-admin" ] } }, "/v1/organizations/{organization_id}": { "get": { "description": "Get Organization. Browser-admin Everyn operation. Send the request to the selected server from this document with a human principal bearer token. Product API keys cannot call this route. Parameters and responses are typed in this document.", "operationId": "get_organization_v1_organizations__organization_id__get", "parameters": [ { "description": "Everyn organization that owns this resource.", "in": "path", "name": "organization_id", "required": true, "schema": { "title": "Organization Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationResponse" } } }, "description": "Successful Response", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Malformed request, header, cursor, or multipart form field.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Missing, malformed, unknown, revoked, or expired credential.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Authenticated principal lacks the required scope or role.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Resource not found, including cross-organization resources.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Idempotency conflict or invalid resource state.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Public error", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Rate limit exceeded.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Get Organization", "tags": [ "organization-admin" ] }, "patch": { "description": "Update Organization. Browser-admin Everyn operation. Send the request to the selected server from this document with a human principal bearer token. Product API keys cannot call this route. Parameters and responses are typed in this document.", "operationId": "update_organization_v1_organizations__organization_id__patch", "parameters": [ { "description": "Everyn organization that owns this resource.", "in": "path", "name": "organization_id", "required": true, "schema": { "title": "Organization Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationUpdateRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationResponse" } } }, "description": "Successful Response", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Malformed request, header, cursor, or multipart form field.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Missing, malformed, unknown, revoked, or expired credential.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Authenticated principal lacks the required scope or role.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Resource not found, including cross-organization resources.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Idempotency conflict or invalid resource state.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Public error", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Rate limit exceeded.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Update Organization", "tags": [ "organization-admin" ] } }, "/v1/organizations/{organization_id}/api-keys": { "get": { "description": "List Organization Api Keys. Browser-admin Everyn operation. Send the request to the selected server from this document with a human principal bearer token. Product API keys cannot call this route. Parameters and responses are typed in this document.", "operationId": "list_organization_api_keys_v1_organizations__organization_id__api_keys_get", "parameters": [ { "description": "Everyn organization that owns this resource.", "in": "path", "name": "organization_id", "required": true, "schema": { "title": "Organization Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_ApiKeyResponse_" } } }, "description": "Successful Response", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Malformed request, header, cursor, or multipart form field.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Missing, malformed, unknown, revoked, or expired credential.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Authenticated principal lacks the required scope or role.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Resource not found, including cross-organization resources.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Idempotency conflict or invalid resource state.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Public error", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Rate limit exceeded.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } } }, "security": [ { "BearerAuth": [] } ], "summary": "List Organization Api Keys", "tags": [ "organization-admin" ] }, "post": { "description": "Create Organization Api Key. Browser-admin Everyn operation. Send the request to the selected server from this document with a human principal bearer token. Product API keys cannot call this route. Parameters and responses are typed in this document.", "operationId": "create_organization_api_key_v1_organizations__organization_id__api_keys_post", "parameters": [ { "description": "Everyn organization that owns this resource.", "in": "path", "name": "organization_id", "required": true, "schema": { "title": "Organization Id", "type": "string" } }, { "description": "Caller-supplied key that makes this write retry-safe.", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency-Key" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiKeyCreateRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/CreatedApiKeyResponse" }, { "$ref": "#/components/schemas/ApiKeyResponse" } ], "title": "Response Create Organization Api Key V1 Organizations Organization Id Api Keys Post" } } }, "description": "Successful Response", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Malformed request, header, cursor, or multipart form field.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Missing, malformed, unknown, revoked, or expired credential.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Authenticated principal lacks the required scope or role.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Resource not found, including cross-organization resources.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Idempotency conflict or invalid resource state.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Public error", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Rate limit exceeded.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Create Organization Api Key", "tags": [ "organization-admin" ] } }, "/v1/organizations/{organization_id}/api-keys/{api_key_id}": { "get": { "description": "Get Organization Api Key. Browser-admin Everyn operation. Send the request to the selected server from this document with a human principal bearer token. Product API keys cannot call this route. Parameters and responses are typed in this document.", "operationId": "get_organization_api_key_v1_organizations__organization_id__api_keys__api_key_id__get", "parameters": [ { "description": "Everyn organization that owns this resource.", "in": "path", "name": "organization_id", "required": true, "schema": { "title": "Organization Id", "type": "string" } }, { "description": "Identifier of the API key.", "in": "path", "name": "api_key_id", "required": true, "schema": { "title": "Api Key Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiKeyResponse" } } }, "description": "Successful Response", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Malformed request, header, cursor, or multipart form field.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Missing, malformed, unknown, revoked, or expired credential.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Authenticated principal lacks the required scope or role.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Resource not found, including cross-organization resources.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Idempotency conflict or invalid resource state.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Public error", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Rate limit exceeded.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Get Organization Api Key", "tags": [ "organization-admin" ] } }, "/v1/organizations/{organization_id}/api-keys/{api_key_id}/revoke": { "post": { "description": "Revoke Organization Api Key. Browser-admin Everyn operation. Send the request to the selected server from this document with a human principal bearer token. Product API keys cannot call this route. Parameters and responses are typed in this document.", "operationId": "revoke_organization_api_key_v1_organizations__organization_id__api_keys__api_key_id__revoke_post", "parameters": [ { "description": "Everyn organization that owns this resource.", "in": "path", "name": "organization_id", "required": true, "schema": { "title": "Organization Id", "type": "string" } }, { "description": "Identifier of the API key.", "in": "path", "name": "api_key_id", "required": true, "schema": { "title": "Api Key Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiKeyResponse" } } }, "description": "Successful Response", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Malformed request, header, cursor, or multipart form field.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Missing, malformed, unknown, revoked, or expired credential.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Authenticated principal lacks the required scope or role.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Resource not found, including cross-organization resources.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Idempotency conflict or invalid resource state.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Public error", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Rate limit exceeded.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Revoke Organization Api Key", "tags": [ "organization-admin" ] } }, "/v1/organizations/{organization_id}/api-keys/{api_key_id}/rotate": { "post": { "description": "Rotate Organization Api Key. Browser-admin Everyn operation. Send the request to the selected server from this document with a human principal bearer token. Product API keys cannot call this route. Parameters and responses are typed in this document.", "operationId": "rotate_organization_api_key_v1_organizations__organization_id__api_keys__api_key_id__rotate_post", "parameters": [ { "description": "Everyn organization that owns this resource.", "in": "path", "name": "organization_id", "required": true, "schema": { "title": "Organization Id", "type": "string" } }, { "description": "Identifier of the API key.", "in": "path", "name": "api_key_id", "required": true, "schema": { "title": "Api Key Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ApiKeyRotateRequest" }, { "type": "null" } ], "title": "Request" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatedApiKeyResponse" } } }, "description": "Successful Response", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Malformed request, header, cursor, or multipart form field.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Missing, malformed, unknown, revoked, or expired credential.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Authenticated principal lacks the required scope or role.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Resource not found, including cross-organization resources.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Idempotency conflict or invalid resource state.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Public error", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Rate limit exceeded.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Rotate Organization Api Key", "tags": [ "organization-admin" ] } }, "/v1/organizations/{organization_id}/audit-events": { "get": { "description": "List Organization Audit Events. Browser-admin Everyn operation. Send the request to the selected server from this document with a human principal bearer token. Product API keys cannot call this route. Parameters and responses are typed in this document.", "operationId": "list_organization_audit_events_v1_organizations__organization_id__audit_events_get", "parameters": [ { "description": "Everyn organization that owns this resource.", "in": "path", "name": "organization_id", "required": true, "schema": { "title": "Organization Id", "type": "string" } }, { "description": "Maximum number of items to return in this page.", "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "title": "Limit", "type": "integer" } }, { "description": "Opaque pagination cursor from the previous page.", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, { "description": "type for this Everyn API operation.", "in": "query", "name": "type", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Type" } }, { "description": "actorType for this Everyn API operation.", "in": "query", "name": "actorType", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Actortype" } }, { "description": "apiKeyId for this Everyn API operation.", "in": "query", "name": "apiKeyId", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Apikeyid" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_AuditEventResponse_" } } }, "description": "Successful Response", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Malformed request, header, cursor, or multipart form field.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Missing, malformed, unknown, revoked, or expired credential.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Authenticated principal lacks the required scope or role.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Resource not found, including cross-organization resources.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Idempotency conflict or invalid resource state.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Public error", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Rate limit exceeded.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } } }, "security": [ { "BearerAuth": [] } ], "summary": "List Organization Audit Events", "tags": [ "organization-admin" ] } }, "/v1/organizations/{organization_id}/audit-events/{audit_event_id}": { "get": { "description": "Get Organization Audit Event. Browser-admin Everyn operation. Send the request to the selected server from this document with a human principal bearer token. Product API keys cannot call this route. Parameters and responses are typed in this document.", "operationId": "get_organization_audit_event_v1_organizations__organization_id__audit_events__audit_event_id__get", "parameters": [ { "description": "Everyn organization that owns this resource.", "in": "path", "name": "organization_id", "required": true, "schema": { "title": "Organization Id", "type": "string" } }, { "description": "audit_event_id for this Everyn API operation.", "in": "path", "name": "audit_event_id", "required": true, "schema": { "title": "Audit Event Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuditEventResponse" } } }, "description": "Successful Response", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Malformed request, header, cursor, or multipart form field.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Missing, malformed, unknown, revoked, or expired credential.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Authenticated principal lacks the required scope or role.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Resource not found, including cross-organization resources.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Idempotency conflict or invalid resource state.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Public error", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Rate limit exceeded.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Get Organization Audit Event", "tags": [ "organization-admin" ] } }, "/v1/organizations/{organization_id}/billing": { "get": { "description": "Get Billing Overview. Browser-admin Everyn operation. Send the request to the selected server from this document with a human principal bearer token. Product API keys cannot call this route. Parameters and responses are typed in this document.", "operationId": "get_billing_overview_v1_organizations__organization_id__billing_get", "parameters": [ { "description": "Everyn organization that owns this resource.", "in": "path", "name": "organization_id", "required": true, "schema": { "title": "Organization Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BillingOverviewResponse" } } }, "description": "Successful Response", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Malformed request, header, cursor, or multipart form field.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Missing, malformed, unknown, revoked, or expired credential.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Authenticated principal lacks the required scope or role.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Resource not found, including cross-organization resources.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Idempotency conflict or invalid resource state.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Public error", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Rate limit exceeded.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Get Billing Overview", "tags": [ "billing" ] } }, "/v1/organizations/{organization_id}/billing/cancellation": { "get": { "description": "Read the latest cancellation lifecycle, including terminal outcomes, or explicit none.", "operationId": "discover_agreement_cancellation_v1_organizations__organization_id__billing_cancellation_get", "parameters": [ { "description": "Everyn organization that owns this resource.", "in": "path", "name": "organization_id", "required": true, "schema": { "title": "Organization Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "discriminator": { "mapping": { "found": "#/components/schemas/CancellationDiscoveryFoundResponse", "none": "#/components/schemas/CancellationDiscoveryNoneResponse" }, "propertyName": "discoveryStatus" }, "oneOf": [ { "$ref": "#/components/schemas/CancellationDiscoveryNoneResponse" }, { "$ref": "#/components/schemas/CancellationDiscoveryFoundResponse" } ], "title": "Response Discover Agreement Cancellation V1 Organizations Organization Id Billing Cancellation Get" } } }, "description": "Successful Response", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Malformed request, header, cursor, or multipart form field.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Missing, malformed, unknown, revoked, or expired credential.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Authenticated principal lacks the required scope or role.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Resource not found, including cross-organization resources.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Idempotency conflict or invalid resource state.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Public error", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Rate limit exceeded.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Discover Agreement Cancellation", "tags": [ "billing" ] }, "post": { "description": "Request Agreement Cancellation. Browser-admin Everyn operation. Send the request to the selected server from this document with a human principal bearer token. Product API keys cannot call this route. Parameters and responses are typed in this document.", "operationId": "request_agreement_cancellation_v1_organizations__organization_id__billing_cancellation_post", "parameters": [ { "description": "Everyn organization that owns this resource.", "in": "path", "name": "organization_id", "required": true, "schema": { "title": "Organization Id", "type": "string" } }, { "description": "Caller-supplied key that makes this write retry-safe.", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency-Key" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CancellationRequestBody" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CancellationResponse" } } }, "description": "Successful Response", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Malformed request, header, cursor, or multipart form field.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Missing, malformed, unknown, revoked, or expired credential.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Authenticated principal lacks the required scope or role.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Resource not found, including cross-organization resources.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Idempotency conflict or invalid resource state.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Public error", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Rate limit exceeded.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Request Agreement Cancellation", "tags": [ "billing" ] } }, "/v1/organizations/{organization_id}/billing/cancellation/{cancellation_id}/withdrawal": { "post": { "description": "Withdraw Agreement Cancellation. Browser-admin Everyn operation. Send the request to the selected server from this document with a human principal bearer token. Product API keys cannot call this route. Parameters and responses are typed in this document.", "operationId": "withdraw_agreement_cancellation_v1_organizations__organization_id__billing_cancellation__cancellation_id__withdrawal_post", "parameters": [ { "description": "Everyn organization that owns this resource.", "in": "path", "name": "organization_id", "required": true, "schema": { "title": "Organization Id", "type": "string" } }, { "description": "cancellation_id for this Everyn API operation.", "in": "path", "name": "cancellation_id", "required": true, "schema": { "title": "Cancellation Id", "type": "string" } }, { "description": "Caller-supplied key that makes this write retry-safe.", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency-Key" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CancellationWithdrawalRequestBody" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CancellationResponse" } } }, "description": "Successful Response", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Malformed request, header, cursor, or multipart form field.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Missing, malformed, unknown, revoked, or expired credential.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Authenticated principal lacks the required scope or role.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Resource not found, including cross-organization resources.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Idempotency conflict or invalid resource state.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Public error", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Rate limit exceeded.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Withdraw Agreement Cancellation", "tags": [ "billing" ] } }, "/v1/organizations/{organization_id}/billing/history": { "get": { "description": "List Billing History. Browser-admin Everyn operation. Send the request to the selected server from this document with a human principal bearer token. Product API keys cannot call this route. Parameters and responses are typed in this document.", "operationId": "list_billing_history_v1_organizations__organization_id__billing_history_get", "parameters": [ { "description": "Everyn organization that owns this resource.", "in": "path", "name": "organization_id", "required": true, "schema": { "title": "Organization Id", "type": "string" } }, { "description": "Opaque pagination cursor from the previous page.", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, { "description": "Maximum number of items to return in this page.", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "title": "Limit", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BillingHistoryListResponse" } } }, "description": "Successful Response", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Malformed request, header, cursor, or multipart form field.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Missing, malformed, unknown, revoked, or expired credential.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Authenticated principal lacks the required scope or role.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Resource not found, including cross-organization resources.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Idempotency conflict or invalid resource state.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Public error", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Rate limit exceeded.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } } }, "security": [ { "BearerAuth": [] } ], "summary": "List Billing History", "tags": [ "billing" ] } }, "/v1/organizations/{organization_id}/billing/history/{history_item_id}": { "get": { "description": "Get Billing History Detail. Browser-admin Everyn operation. Send the request to the selected server from this document with a human principal bearer token. Product API keys cannot call this route. Parameters and responses are typed in this document.", "operationId": "get_billing_history_detail_v1_organizations__organization_id__billing_history__history_item_id__get", "parameters": [ { "description": "Everyn organization that owns this resource.", "in": "path", "name": "organization_id", "required": true, "schema": { "title": "Organization Id", "type": "string" } }, { "description": "history_item_id for this Everyn API operation.", "in": "path", "name": "history_item_id", "required": true, "schema": { "title": "History Item Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BillingHistoryDetailResponse" } } }, "description": "Successful Response", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Malformed request, header, cursor, or multipart form field.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Missing, malformed, unknown, revoked, or expired credential.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Authenticated principal lacks the required scope or role.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Resource not found, including cross-organization resources.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Idempotency conflict or invalid resource state.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Public error", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Rate limit exceeded.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Get Billing History Detail", "tags": [ "billing" ] } }, "/v1/organizations/{organization_id}/billing/paid-checkouts": { "post": { "description": "Start Paid Checkout. Browser-admin Everyn operation. Send the request to the selected server from this document with a human principal bearer token. Product API keys cannot call this route. Parameters and responses are typed in this document.", "operationId": "start_paid_checkout_v1_organizations__organization_id__billing_paid_checkouts_post", "parameters": [ { "description": "Everyn organization that owns this resource.", "in": "path", "name": "organization_id", "required": true, "schema": { "title": "Organization Id", "type": "string" } }, { "description": "Set to `202` to opt into non-error readiness responses while provisioning.", "in": "header", "name": "X-Everyn-Checkout-Readiness", "required": false, "schema": { "anyOf": [ { "const": "202", "type": "string" }, { "type": "null" } ], "description": "Set to `202` to opt into non-error readiness responses while provisioning.", "title": "X-Everyn-Checkout-Readiness" } }, { "description": "Caller-supplied key that makes this write retry-safe.", "in": "header", "name": "Idempotency-Key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency-Key" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaidCheckoutStartRequestBody" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaidCheckoutReconciledResponse" } } }, "description": "OK", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaidCheckoutStartResponse" } } }, "description": "Successful Response", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaidCheckoutPreparingResponse" } } }, "description": "Accepted", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Malformed request, header, cursor, or multipart form field.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Missing, malformed, unknown, revoked, or expired credential.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Authenticated principal lacks the required scope or role.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Resource not found, including cross-organization resources.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Idempotency conflict or invalid resource state.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Public error", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Rate limit exceeded.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Start Paid Checkout", "tags": [ "billing" ] } }, "/v1/organizations/{organization_id}/billing/paid-checkouts/complete-return": { "post": { "description": "Complete Paid Checkout Return. Browser-admin Everyn operation. Send the request to the selected server from this document with a human principal bearer token. Product API keys cannot call this route. Parameters and responses are typed in this document.", "operationId": "complete_paid_checkout_return_v1_organizations__organization_id__billing_paid_checkouts_complete_return_post", "parameters": [ { "description": "Everyn organization that owns this resource.", "in": "path", "name": "organization_id", "required": true, "schema": { "title": "Organization Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaidCheckoutCompleteReturnRequestBody" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaidCheckoutStatusResponse" } } }, "description": "Successful Response", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Malformed request, header, cursor, or multipart form field.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Missing, malformed, unknown, revoked, or expired credential.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Authenticated principal lacks the required scope or role.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Resource not found, including cross-organization resources.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Idempotency conflict or invalid resource state.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Public error", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Rate limit exceeded.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Complete Paid Checkout Return", "tags": [ "billing" ] } }, "/v1/organizations/{organization_id}/billing/paid-checkouts/{paid_checkout_intent_id}": { "get": { "description": "Get Paid Checkout Status. Browser-admin Everyn operation. Send the request to the selected server from this document with a human principal bearer token. Product API keys cannot call this route. Parameters and responses are typed in this document.", "operationId": "get_paid_checkout_status_v1_organizations__organization_id__billing_paid_checkouts__paid_checkout_intent_id__get", "parameters": [ { "description": "Everyn organization that owns this resource.", "in": "path", "name": "organization_id", "required": true, "schema": { "title": "Organization Id", "type": "string" } }, { "description": "paid_checkout_intent_id for this Everyn API operation.", "in": "path", "name": "paid_checkout_intent_id", "required": true, "schema": { "title": "Paid Checkout Intent Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaidCheckoutStatusResponse" } } }, "description": "Successful Response", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Malformed request, header, cursor, or multipart form field.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Missing, malformed, unknown, revoked, or expired credential.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Authenticated principal lacks the required scope or role.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Resource not found, including cross-organization resources.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Idempotency conflict or invalid resource state.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Public error", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Rate limit exceeded.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Get Paid Checkout Status", "tags": [ "billing" ] } }, "/v1/organizations/{organization_id}/billing/payment-method-setups": { "post": { "description": "Start Payment Method Setup. Browser-admin Everyn operation. Send the request to the selected server from this document with a human principal bearer token. Product API keys cannot call this route. Parameters and responses are typed in this document.", "operationId": "start_payment_method_setup_v1_organizations__organization_id__billing_payment_method_setups_post", "parameters": [ { "description": "Everyn organization that owns this resource.", "in": "path", "name": "organization_id", "required": true, "schema": { "title": "Organization Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/PaymentMethodSetupStartRequestBody" }, { "type": "null" } ], "title": "Body" } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentMethodSetupStartResponse" } } }, "description": "Successful Response", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Malformed request, header, cursor, or multipart form field.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Missing, malformed, unknown, revoked, or expired credential.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Authenticated principal lacks the required scope or role.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Resource not found, including cross-organization resources.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Idempotency conflict or invalid resource state.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Public error", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Rate limit exceeded.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Start Payment Method Setup", "tags": [ "billing" ] } }, "/v1/organizations/{organization_id}/billing/payment-method-setups/complete-return": { "post": { "description": "Complete Payment Method Setup Return. Browser-admin Everyn operation. Send the request to the selected server from this document with a human principal bearer token. Product API keys cannot call this route. Parameters and responses are typed in this document.", "operationId": "complete_payment_method_setup_return_v1_organizations__organization_id__billing_payment_method_setups_complete_return_post", "parameters": [ { "description": "Everyn organization that owns this resource.", "in": "path", "name": "organization_id", "required": true, "schema": { "title": "Organization Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentMethodSetupCompleteReturnRequestBody" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentSetupStatusResponse" } } }, "description": "Successful Response", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Malformed request, header, cursor, or multipart form field.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Missing, malformed, unknown, revoked, or expired credential.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Authenticated principal lacks the required scope or role.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Resource not found, including cross-organization resources.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Idempotency conflict or invalid resource state.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Public error", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Rate limit exceeded.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Complete Payment Method Setup Return", "tags": [ "billing" ] } }, "/v1/organizations/{organization_id}/billing/payment-method-setups/{hosted_setup_intent_id}": { "get": { "description": "Get Payment Method Setup Status. Browser-admin Everyn operation. Send the request to the selected server from this document with a human principal bearer token. Product API keys cannot call this route. Parameters and responses are typed in this document.", "operationId": "get_payment_method_setup_status_v1_organizations__organization_id__billing_payment_method_setups__hosted_setup_intent_id__get", "parameters": [ { "description": "Everyn organization that owns this resource.", "in": "path", "name": "organization_id", "required": true, "schema": { "title": "Organization Id", "type": "string" } }, { "description": "hosted_setup_intent_id for this Everyn API operation.", "in": "path", "name": "hosted_setup_intent_id", "required": true, "schema": { "title": "Hosted Setup Intent Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentSetupStatusResponse" } } }, "description": "Successful Response", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Malformed request, header, cursor, or multipart form field.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Missing, malformed, unknown, revoked, or expired credential.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Authenticated principal lacks the required scope or role.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Resource not found, including cross-organization resources.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Idempotency conflict or invalid resource state.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Public error", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Rate limit exceeded.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Get Payment Method Setup Status", "tags": [ "billing" ] } }, "/v1/organizations/{organization_id}/billing/plan-transition": { "get": { "description": "Read the latest non-superseded plan transition lifecycle, or explicit none.", "operationId": "discover_plan_transition_v1_organizations__organization_id__billing_plan_transition_get", "parameters": [ { "description": "Everyn organization that owns this resource.", "in": "path", "name": "organization_id", "required": true, "schema": { "title": "Organization Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "discriminator": { "mapping": { "found": "#/components/schemas/PlanTransitionDiscoveryFoundResponse", "none": "#/components/schemas/PlanTransitionDiscoveryNoneResponse" }, "propertyName": "discoveryStatus" }, "oneOf": [ { "$ref": "#/components/schemas/PlanTransitionDiscoveryNoneResponse" }, { "$ref": "#/components/schemas/PlanTransitionDiscoveryFoundResponse" } ], "title": "Response Discover Plan Transition V1 Organizations Organization Id Billing Plan Transition Get" } } }, "description": "Successful Response", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Malformed request, header, cursor, or multipart form field.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Missing, malformed, unknown, revoked, or expired credential.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Authenticated principal lacks the required scope or role.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Resource not found, including cross-organization resources.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Idempotency conflict or invalid resource state.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Public error", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Rate limit exceeded.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Discover Plan Transition", "tags": [ "billing" ] } }, "/v1/organizations/{organization_id}/billing/plan-transition-quote": { "get": { "description": "Get Plan Transition Quote. Browser-admin Everyn operation. Send the request to the selected server from this document with a human principal bearer token. Product API keys cannot call this route. Parameters and responses are typed in this document.", "operationId": "get_plan_transition_quote_v1_organizations__organization_id__billing_plan_transition_quote_get", "parameters": [ { "description": "Everyn organization that owns this resource.", "in": "path", "name": "organization_id", "required": true, "schema": { "title": "Organization Id", "type": "string" } }, { "description": "targetOfferId for this Everyn API operation.", "in": "query", "name": "targetOfferId", "required": true, "schema": { "title": "Targetofferid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlanTransitionQuoteResponse" } } }, "description": "Successful Response", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Malformed request, header, cursor, or multipart form field.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Missing, malformed, unknown, revoked, or expired credential.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Authenticated principal lacks the required scope or role.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Resource not found, including cross-organization resources.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Idempotency conflict or invalid resource state.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Public error", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Rate limit exceeded.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Get Plan Transition Quote", "tags": [ "billing" ] } }, "/v1/organizations/{organization_id}/billing/plan-transitions": { "post": { "description": "Request Plan Transition. Browser-admin Everyn operation. Send the request to the selected server from this document with a human principal bearer token. Product API keys cannot call this route. Parameters and responses are typed in this document.", "operationId": "request_plan_transition_v1_organizations__organization_id__billing_plan_transitions_post", "parameters": [ { "description": "Everyn organization that owns this resource.", "in": "path", "name": "organization_id", "required": true, "schema": { "title": "Organization Id", "type": "string" } }, { "description": "Caller-supplied key that makes this write retry-safe.", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency-Key" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlanTransitionRequestBody" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlanTransitionStartResponse" } } }, "description": "Successful Response", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Malformed request, header, cursor, or multipart form field.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Missing, malformed, unknown, revoked, or expired credential.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Authenticated principal lacks the required scope or role.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Resource not found, including cross-organization resources.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Idempotency conflict or invalid resource state.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Public error", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Rate limit exceeded.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Request Plan Transition", "tags": [ "billing" ] } }, "/v1/organizations/{organization_id}/billing/plan-transitions/complete-return": { "post": { "description": "Complete Plan Transition Return. Browser-admin Everyn operation. Send the request to the selected server from this document with a human principal bearer token. Product API keys cannot call this route. Parameters and responses are typed in this document.", "operationId": "complete_plan_transition_return_v1_organizations__organization_id__billing_plan_transitions_complete_return_post", "parameters": [ { "description": "Everyn organization that owns this resource.", "in": "path", "name": "organization_id", "required": true, "schema": { "title": "Organization Id", "type": "string" } }, { "description": "Caller-supplied key that makes this write retry-safe.", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency-Key" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlanTransitionCompleteReturnRequestBody" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlanTransitionResponse" } } }, "description": "Successful Response", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Malformed request, header, cursor, or multipart form field.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Missing, malformed, unknown, revoked, or expired credential.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Authenticated principal lacks the required scope or role.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Resource not found, including cross-organization resources.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Idempotency conflict or invalid resource state.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Public error", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Rate limit exceeded.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Complete Plan Transition Return", "tags": [ "billing" ] } }, "/v1/organizations/{organization_id}/billing/plan-transitions/{plan_transition_id}": { "get": { "description": "Get Plan Transition Status. Browser-admin Everyn operation. Send the request to the selected server from this document with a human principal bearer token. Product API keys cannot call this route. Parameters and responses are typed in this document.", "operationId": "get_plan_transition_status_v1_organizations__organization_id__billing_plan_transitions__plan_transition_id__get", "parameters": [ { "description": "Everyn organization that owns this resource.", "in": "path", "name": "organization_id", "required": true, "schema": { "title": "Organization Id", "type": "string" } }, { "description": "plan_transition_id for this Everyn API operation.", "in": "path", "name": "plan_transition_id", "required": true, "schema": { "title": "Plan Transition Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlanTransitionResponse" } } }, "description": "Successful Response", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Malformed request, header, cursor, or multipart form field.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Missing, malformed, unknown, revoked, or expired credential.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Authenticated principal lacks the required scope or role.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Resource not found, including cross-organization resources.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Idempotency conflict or invalid resource state.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Public error", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Rate limit exceeded.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Get Plan Transition Status", "tags": [ "billing" ] } }, "/v1/organizations/{organization_id}/billing/portal-sessions": { "post": { "description": "Start Billing Portal Session. Browser-admin Everyn operation. Send the request to the selected server from this document with a human principal bearer token. Product API keys cannot call this route. Parameters and responses are typed in this document.", "operationId": "start_billing_portal_session_v1_organizations__organization_id__billing_portal_sessions_post", "parameters": [ { "description": "Everyn organization that owns this resource.", "in": "path", "name": "organization_id", "required": true, "schema": { "title": "Organization Id", "type": "string" } } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BillingPortalSessionResponse" } } }, "description": "Successful Response", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Malformed request, header, cursor, or multipart form field.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Missing, malformed, unknown, revoked, or expired credential.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Authenticated principal lacks the required scope or role.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Resource not found, including cross-organization resources.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Idempotency conflict or invalid resource state.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Public error", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Rate limit exceeded.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Start Billing Portal Session", "tags": [ "billing" ] } }, "/v1/organizations/{organization_id}/billing/recovery": { "get": { "description": "Get Renewal Recovery. Browser-admin Everyn operation. Send the request to the selected server from this document with a human principal bearer token. Product API keys cannot call this route. Parameters and responses are typed in this document.", "operationId": "get_renewal_recovery_v1_organizations__organization_id__billing_recovery_get", "parameters": [ { "description": "Everyn organization that owns this resource.", "in": "path", "name": "organization_id", "required": true, "schema": { "title": "Organization Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RenewalRecoveryResponse" } } }, "description": "Successful Response", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Malformed request, header, cursor, or multipart form field.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Missing, malformed, unknown, revoked, or expired credential.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Authenticated principal lacks the required scope or role.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Resource not found, including cross-organization resources.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Idempotency conflict or invalid resource state.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Public error", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Rate limit exceeded.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Get Renewal Recovery", "tags": [ "billing" ] } }, "/v1/organizations/{organization_id}/billing/recovery/stop-to-free": { "post": { "description": "Stop Renewal Recovery To Free. Browser-admin Everyn operation. Send the request to the selected server from this document with a human principal bearer token. Product API keys cannot call this route. Parameters and responses are typed in this document.", "operationId": "stop_renewal_recovery_to_free_v1_organizations__organization_id__billing_recovery_stop_to_free_post", "parameters": [ { "description": "Everyn organization that owns this resource.", "in": "path", "name": "organization_id", "required": true, "schema": { "title": "Organization Id", "type": "string" } }, { "description": "Caller-supplied key that makes this write retry-safe.", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency-Key" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RenewalRecoveryStopRequestBody" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RenewalRecoveryResponse" } } }, "description": "Successful Response", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Malformed request, header, cursor, or multipart form field.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Missing, malformed, unknown, revoked, or expired credential.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Authenticated principal lacks the required scope or role.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Resource not found, including cross-organization resources.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Idempotency conflict or invalid resource state.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Public error", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Rate limit exceeded.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Stop Renewal Recovery To Free", "tags": [ "billing" ] } }, "/v1/organizations/{organization_id}/billing/row-budget": { "put": { "description": "Change Row Budget. Browser-admin Everyn operation. Send the request to the selected server from this document with a human principal bearer token. Product API keys cannot call this route. Parameters and responses are typed in this document.", "operationId": "change_row_budget_v1_organizations__organization_id__billing_row_budget_put", "parameters": [ { "description": "Everyn organization that owns this resource.", "in": "path", "name": "organization_id", "required": true, "schema": { "title": "Organization Id", "type": "string" } }, { "description": "Caller-supplied key that makes this write retry-safe.", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency-Key" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RowBudgetChangeRequestBody" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RowBudgetChangeResponse" } } }, "description": "Successful Response", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Malformed request, header, cursor, or multipart form field.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Missing, malformed, unknown, revoked, or expired credential.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Authenticated principal lacks the required scope or role.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Resource not found, including cross-organization resources.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Idempotency conflict or invalid resource state.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Public error", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Rate limit exceeded.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Change Row Budget", "tags": [ "billing" ] } }, "/v1/organizations/{organization_id}/billing/statements": { "get": { "description": "List Billing Statements. Browser-admin Everyn operation. Send the request to the selected server from this document with a human principal bearer token. Product API keys cannot call this route. Parameters and responses are typed in this document.", "operationId": "list_billing_statements_v1_organizations__organization_id__billing_statements_get", "parameters": [ { "description": "Everyn organization that owns this resource.", "in": "path", "name": "organization_id", "required": true, "schema": { "title": "Organization Id", "type": "string" } }, { "description": "Opaque pagination cursor from the previous page.", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, { "description": "Maximum number of items to return in this page.", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "title": "Limit", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BillingStatementListResponse" } } }, "description": "Successful Response", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Malformed request, header, cursor, or multipart form field.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Missing, malformed, unknown, revoked, or expired credential.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Authenticated principal lacks the required scope or role.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Resource not found, including cross-organization resources.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Idempotency conflict or invalid resource state.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Public error", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Rate limit exceeded.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } } }, "security": [ { "BearerAuth": [] } ], "summary": "List Billing Statements", "tags": [ "billing" ] } }, "/v1/organizations/{organization_id}/billing/statements/{statement_id}": { "get": { "description": "Get Billing Statement. Browser-admin Everyn operation. Send the request to the selected server from this document with a human principal bearer token. Product API keys cannot call this route. Parameters and responses are typed in this document.", "operationId": "get_billing_statement_v1_organizations__organization_id__billing_statements__statement_id__get", "parameters": [ { "description": "Everyn organization that owns this resource.", "in": "path", "name": "organization_id", "required": true, "schema": { "title": "Organization Id", "type": "string" } }, { "description": "statement_id for this Everyn API operation.", "in": "path", "name": "statement_id", "required": true, "schema": { "title": "Statement Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BillingStatementDetailResponse" } } }, "description": "Successful Response", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Malformed request, header, cursor, or multipart form field.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Missing, malformed, unknown, revoked, or expired credential.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Authenticated principal lacks the required scope or role.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Resource not found, including cross-organization resources.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Idempotency conflict or invalid resource state.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Public error", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Rate limit exceeded.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Get Billing Statement", "tags": [ "billing" ] } }, "/v1/organizations/{organization_id}/billing/top-up-receipts": { "get": { "description": "List Top Up Receipts. Browser-admin Everyn operation. Send the request to the selected server from this document with a human principal bearer token. Product API keys cannot call this route. Parameters and responses are typed in this document.", "operationId": "list_top_up_receipts_v1_organizations__organization_id__billing_top_up_receipts_get", "parameters": [ { "description": "Everyn organization that owns this resource.", "in": "path", "name": "organization_id", "required": true, "schema": { "title": "Organization Id", "type": "string" } }, { "description": "Opaque pagination cursor from the previous page.", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, { "description": "Maximum number of items to return in this page.", "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "title": "Limit", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TopUpReceiptListResponse" } } }, "description": "Successful Response", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Malformed request, header, cursor, or multipart form field.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Missing, malformed, unknown, revoked, or expired credential.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Authenticated principal lacks the required scope or role.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Resource not found, including cross-organization resources.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Idempotency conflict or invalid resource state.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Public error", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Rate limit exceeded.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } } }, "security": [ { "BearerAuth": [] } ], "summary": "List Top Up Receipts", "tags": [ "billing" ] } }, "/v1/organizations/{organization_id}/billing/top-ups": { "post": { "description": "Start Top Up. Browser-admin Everyn operation. Send the request to the selected server from this document with a human principal bearer token. Product API keys cannot call this route. Parameters and responses are typed in this document.", "operationId": "start_top_up_v1_organizations__organization_id__billing_top_ups_post", "parameters": [ { "description": "Everyn organization that owns this resource.", "in": "path", "name": "organization_id", "required": true, "schema": { "title": "Organization Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TopUpStartRequestBody" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TopUpIntentResponse" } } }, "description": "Successful Response", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Malformed request, header, cursor, or multipart form field.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Missing, malformed, unknown, revoked, or expired credential.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Authenticated principal lacks the required scope or role.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Resource not found, including cross-organization resources.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Idempotency conflict or invalid resource state.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Public error", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Rate limit exceeded.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Start Top Up", "tags": [ "billing" ] } }, "/v1/organizations/{organization_id}/billing/top-ups/{top_up_intent_id}": { "get": { "description": "Get Top Up Status. Browser-admin Everyn operation. Send the request to the selected server from this document with a human principal bearer token. Product API keys cannot call this route. Parameters and responses are typed in this document.", "operationId": "get_top_up_status_v1_organizations__organization_id__billing_top_ups__top_up_intent_id__get", "parameters": [ { "description": "Everyn organization that owns this resource.", "in": "path", "name": "organization_id", "required": true, "schema": { "title": "Organization Id", "type": "string" } }, { "description": "top_up_intent_id for this Everyn API operation.", "in": "path", "name": "top_up_intent_id", "required": true, "schema": { "title": "Top Up Intent Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TopUpIntentResponse" } } }, "description": "Successful Response", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Malformed request, header, cursor, or multipart form field.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Missing, malformed, unknown, revoked, or expired credential.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Authenticated principal lacks the required scope or role.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Resource not found, including cross-organization resources.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Idempotency conflict or invalid resource state.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Public error", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Rate limit exceeded.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Get Top Up Status", "tags": [ "billing" ] } }, "/v1/organizations/{organization_id}/invitations": { "get": { "description": "List Organization Invitations. Browser-admin Everyn operation. Send the request to the selected server from this document with a human principal bearer token. Product API keys cannot call this route. Parameters and responses are typed in this document.", "operationId": "list_organization_invitations_v1_organizations__organization_id__invitations_get", "parameters": [ { "description": "Everyn organization that owns this resource.", "in": "path", "name": "organization_id", "required": true, "schema": { "title": "Organization Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_OrganizationInvitationResponse_" } } }, "description": "Successful Response", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Malformed request, header, cursor, or multipart form field.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Missing, malformed, unknown, revoked, or expired credential.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Authenticated principal lacks the required scope or role.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Resource not found, including cross-organization resources.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Idempotency conflict or invalid resource state.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Public error", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Rate limit exceeded.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } } }, "security": [ { "BearerAuth": [] } ], "summary": "List Organization Invitations", "tags": [ "organization-admin" ] }, "post": { "description": "Create Organization Invitation. Browser-admin Everyn operation. Send the request to the selected server from this document with a human principal bearer token. Product API keys cannot call this route. Parameters and responses are typed in this document.", "operationId": "create_organization_invitation_v1_organizations__organization_id__invitations_post", "parameters": [ { "description": "Everyn organization that owns this resource.", "in": "path", "name": "organization_id", "required": true, "schema": { "title": "Organization Id", "type": "string" } }, { "description": "Caller-supplied key that makes this write retry-safe.", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency-Key" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationInvitationCreateRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/CreatedOrganizationInvitationResponse" }, { "$ref": "#/components/schemas/OrganizationInvitationResponse" } ], "title": "Response Create Organization Invitation V1 Organizations Organization Id Invitations Post" } } }, "description": "Successful Response", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Malformed request, header, cursor, or multipart form field.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Missing, malformed, unknown, revoked, or expired credential.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Authenticated principal lacks the required scope or role.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Resource not found, including cross-organization resources.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Idempotency conflict or invalid resource state.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Public error", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Rate limit exceeded.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Create Organization Invitation", "tags": [ "organization-admin" ] } }, "/v1/organizations/{organization_id}/invitations/{invitation_id}/revoke": { "post": { "description": "Revoke Organization Invitation. Browser-admin Everyn operation. Send the request to the selected server from this document with a human principal bearer token. Product API keys cannot call this route. Parameters and responses are typed in this document.", "operationId": "revoke_organization_invitation_v1_organizations__organization_id__invitations__invitation_id__revoke_post", "parameters": [ { "description": "Everyn organization that owns this resource.", "in": "path", "name": "organization_id", "required": true, "schema": { "title": "Organization Id", "type": "string" } }, { "description": "invitation_id for this Everyn API operation.", "in": "path", "name": "invitation_id", "required": true, "schema": { "title": "Invitation Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationInvitationResponse" } } }, "description": "Successful Response", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Malformed request, header, cursor, or multipart form field.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Missing, malformed, unknown, revoked, or expired credential.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Authenticated principal lacks the required scope or role.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Resource not found, including cross-organization resources.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Idempotency conflict or invalid resource state.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Public error", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Rate limit exceeded.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Revoke Organization Invitation", "tags": [ "organization-admin" ] } }, "/v1/organizations/{organization_id}/members": { "get": { "description": "List Organization Members. Browser-admin Everyn operation. Send the request to the selected server from this document with a human principal bearer token. Product API keys cannot call this route. Parameters and responses are typed in this document.", "operationId": "list_organization_members_v1_organizations__organization_id__members_get", "parameters": [ { "description": "Everyn organization that owns this resource.", "in": "path", "name": "organization_id", "required": true, "schema": { "title": "Organization Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_OrganizationMemberResponse_" } } }, "description": "Successful Response", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Malformed request, header, cursor, or multipart form field.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Missing, malformed, unknown, revoked, or expired credential.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Authenticated principal lacks the required scope or role.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Resource not found, including cross-organization resources.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Idempotency conflict or invalid resource state.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Public error", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Rate limit exceeded.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } } }, "security": [ { "BearerAuth": [] } ], "summary": "List Organization Members", "tags": [ "organization-admin" ] } }, "/v1/organizations/{organization_id}/members/{user_id}": { "delete": { "description": "Remove Organization Member. Browser-admin Everyn operation. Send the request to the selected server from this document with a human principal bearer token. Product API keys cannot call this route. Parameters and responses are typed in this document.", "operationId": "remove_organization_member_v1_organizations__organization_id__members__user_id__delete", "parameters": [ { "description": "Everyn organization that owns this resource.", "in": "path", "name": "organization_id", "required": true, "schema": { "title": "Organization Id", "type": "string" } }, { "description": "Identifier of the user.", "in": "path", "name": "user_id", "required": true, "schema": { "title": "User Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationMemberResponse" } } }, "description": "Successful Response", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Malformed request, header, cursor, or multipart form field.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Missing, malformed, unknown, revoked, or expired credential.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Authenticated principal lacks the required scope or role.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Resource not found, including cross-organization resources.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Idempotency conflict or invalid resource state.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Public error", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Rate limit exceeded.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Remove Organization Member", "tags": [ "organization-admin" ] }, "get": { "description": "Get Organization Member. Browser-admin Everyn operation. Send the request to the selected server from this document with a human principal bearer token. Product API keys cannot call this route. Parameters and responses are typed in this document.", "operationId": "get_organization_member_v1_organizations__organization_id__members__user_id__get", "parameters": [ { "description": "Everyn organization that owns this resource.", "in": "path", "name": "organization_id", "required": true, "schema": { "title": "Organization Id", "type": "string" } }, { "description": "Identifier of the user.", "in": "path", "name": "user_id", "required": true, "schema": { "title": "User Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationMemberResponse" } } }, "description": "Successful Response", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Malformed request, header, cursor, or multipart form field.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Missing, malformed, unknown, revoked, or expired credential.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Authenticated principal lacks the required scope or role.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Resource not found, including cross-organization resources.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Idempotency conflict or invalid resource state.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Public error", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Rate limit exceeded.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Get Organization Member", "tags": [ "organization-admin" ] }, "patch": { "description": "Update Organization Member. Browser-admin Everyn operation. Send the request to the selected server from this document with a human principal bearer token. Product API keys cannot call this route. Parameters and responses are typed in this document.", "operationId": "update_organization_member_v1_organizations__organization_id__members__user_id__patch", "parameters": [ { "description": "Everyn organization that owns this resource.", "in": "path", "name": "organization_id", "required": true, "schema": { "title": "Organization Id", "type": "string" } }, { "description": "Identifier of the user.", "in": "path", "name": "user_id", "required": true, "schema": { "title": "User Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationMemberUpdateRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationMemberResponse" } } }, "description": "Successful Response", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Malformed request, header, cursor, or multipart form field.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Missing, malformed, unknown, revoked, or expired credential.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Authenticated principal lacks the required scope or role.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Resource not found, including cross-organization resources.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Idempotency conflict or invalid resource state.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Public error", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Rate limit exceeded.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Update Organization Member", "tags": [ "organization-admin" ] } }, "/v1/organizations/{organization_id}/usage": { "get": { "description": "Get Workspace Usage. Browser-admin Everyn operation. Send the request to the selected server from this document with a human principal bearer token. Product API keys cannot call this route. Parameters and responses are typed in this document.", "operationId": "get_workspace_usage_v1_organizations__organization_id__usage_get", "parameters": [ { "description": "Everyn organization that owns this resource.", "in": "path", "name": "organization_id", "required": true, "schema": { "title": "Organization Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/WorkspaceUsageResponse" }, { "$ref": "#/components/schemas/WorkspaceUsageUnavailableResponse" } ], "title": "Response Get Workspace Usage V1 Organizations Organization Id Usage Get" } } }, "description": "Successful Response", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Malformed request, header, cursor, or multipart form field.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Missing, malformed, unknown, revoked, or expired credential.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Authenticated principal lacks the required scope or role.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Resource not found, including cross-organization resources.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Idempotency conflict or invalid resource state.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Public error", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Rate limit exceeded.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Get Workspace Usage", "tags": [ "usage" ] } }, "/v1/runs": { "get": { "description": "List Runs. Authenticated Everyn public API operation. Send the request to the selected server from this document with a product API key (Authorization: Bearer sk-everyn-...). Parameters and responses are typed in this document.", "operationId": "list_runs_v1_runs_get", "parameters": [ { "description": "Maximum number of items to return in this page.", "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "title": "Limit", "type": "integer" } }, { "description": "Opaque pagination cursor from the previous page.", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, { "description": "state for this Everyn API operation.", "in": "query", "name": "state", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "enum": [ "canceled", "completed_with_flags", "draft", "failed", "paused", "queued", "running", "succeeded" ], "title": "State" } }, { "description": "datasetId for this Everyn API operation.", "in": "query", "name": "datasetId", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Datasetid" } }, { "description": "jobSpecId for this Everyn API operation.", "in": "query", "name": "jobSpecId", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Jobspecid" } }, { "description": "createdAfter for this Everyn API operation.", "in": "query", "name": "createdAfter", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Createdafter" } }, { "description": "createdBefore for this Everyn API operation.", "in": "query", "name": "createdBefore", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Createdbefore" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_RunResponse_" } } }, "description": "Successful Response", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Malformed request, header, cursor, or multipart form field.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Missing, malformed, unknown, revoked, or expired credential.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Authenticated principal lacks the required scope or role.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Resource not found, including cross-organization resources.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Idempotency conflict or invalid resource state.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Public error", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Rate limit exceeded.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } } }, "security": [ { "BearerAuth": [] } ], "summary": "List Runs", "tags": [ "runs" ] }, "post": { "description": "Create Run. Authenticated Everyn public API operation. Send the request to the selected server from this document with a product API key (Authorization: Bearer sk-everyn-...). Parameters and responses are typed in this document.", "operationId": "create_run_v1_runs_post", "parameters": [ { "description": "Caller-supplied key that makes this write retry-safe.", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency-Key" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RunCreateRequestBody" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RunResponse" } } }, "description": "Successful Response", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Malformed request, header, cursor, or multipart form field.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Missing, malformed, unknown, revoked, or expired credential.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Authenticated principal lacks the required scope or role.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Resource not found, including cross-organization resources.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Idempotency conflict or invalid resource state.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Public error", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Rate limit exceeded.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Create Run", "tags": [ "runs" ] } }, "/v1/runs/{run_id}": { "get": { "description": "Get Run. Authenticated Everyn public API operation. Send the request to the selected server from this document with a product API key (Authorization: Bearer sk-everyn-...). Parameters and responses are typed in this document.", "operationId": "get_run_v1_runs__run_id__get", "parameters": [ { "description": "Identifier of the run.", "in": "path", "name": "run_id", "required": true, "schema": { "title": "Run Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RunResponse" } } }, "description": "Successful Response", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Malformed request, header, cursor, or multipart form field.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Missing, malformed, unknown, revoked, or expired credential.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Authenticated principal lacks the required scope or role.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Resource not found, including cross-organization resources.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Idempotency conflict or invalid resource state.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Public error", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Rate limit exceeded.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Get Run", "tags": [ "runs" ] } }, "/v1/runs/{run_id}/cancel": { "post": { "description": "Cancel Run. Authenticated Everyn public API operation. Send the request to the selected server from this document with a product API key (Authorization: Bearer sk-everyn-...). Parameters and responses are typed in this document.", "operationId": "cancel_run_v1_runs__run_id__cancel_post", "parameters": [ { "description": "Identifier of the run.", "in": "path", "name": "run_id", "required": true, "schema": { "title": "Run Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RunResponse" } } }, "description": "Successful Response", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Malformed request, header, cursor, or multipart form field.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Missing, malformed, unknown, revoked, or expired credential.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Authenticated principal lacks the required scope or role.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Resource not found, including cross-organization resources.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Idempotency conflict or invalid resource state.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Public error", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Rate limit exceeded.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Cancel Run", "tags": [ "runs" ] } }, "/v1/runs/{run_id}/events": { "get": { "description": "List Run Events. Authenticated Everyn public API operation. Send the request to the selected server from this document with a product API key (Authorization: Bearer sk-everyn-...). Parameters and responses are typed in this document.", "operationId": "list_run_events_v1_runs__run_id__events_get", "parameters": [ { "description": "Identifier of the run.", "in": "path", "name": "run_id", "required": true, "schema": { "title": "Run Id", "type": "string" } }, { "description": "Maximum number of items to return in this page.", "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "title": "Limit", "type": "integer" } }, { "description": "Opaque pagination cursor from the previous page.", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, { "description": "type for this Everyn API operation.", "in": "query", "name": "type", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "enum": [ "billing.model_charge_waived", "billing.web_charge_waived", "export.created", "export.failed", "export.ready", "row.failed", "row.flagged", "row.requeued", "row.started", "row.succeeded", "rows.claimed", "run.cancel_requested", "run.canceled", "run.completed_with_flags", "run.controller_attention", "run.controller_progressed", "run.counters_repaired", "run.created", "run.failed", "run.materialized_rows_canceled", "run.paused", "run.queued", "run.resumed", "run.rows_cancel_skipped", "run.rows_materialized", "run.schedule_prepared", "run.started", "run.submitted", "run.succeeded", "run.worker_started", "run_row.admission_delayed", "run_row.canceled", "run_row.dispatch_reconciled", "run_row.effect_dispatching", "run_row.executing", "run_row.failed", "run_row.lease_recovered", "run_row.needs_attention" ], "title": "Type" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_RunEventResponse_" } } }, "description": "Successful Response", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Malformed request, header, cursor, or multipart form field.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Missing, malformed, unknown, revoked, or expired credential.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Authenticated principal lacks the required scope or role.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Resource not found, including cross-organization resources.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Idempotency conflict or invalid resource state.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Public error", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Rate limit exceeded.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } } }, "security": [ { "BearerAuth": [] } ], "summary": "List Run Events", "tags": [ "runs" ] } }, "/v1/runs/{run_id}/exports": { "get": { "description": "List Run Exports. Authenticated Everyn public API operation. Send the request to the selected server from this document with a product API key (Authorization: Bearer sk-everyn-...). Parameters and responses are typed in this document.", "operationId": "list_run_exports_v1_runs__run_id__exports_get", "parameters": [ { "description": "Identifier of the run.", "in": "path", "name": "run_id", "required": true, "schema": { "title": "Run Id", "type": "string" } }, { "description": "Maximum number of items to return in this page.", "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "title": "Limit", "type": "integer" } }, { "description": "Opaque pagination cursor from the previous page.", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, { "description": "status for this Everyn API operation.", "in": "query", "name": "status", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "enum": [ "expired", "failed", "generating", "queued", "ready" ], "title": "Status" } }, { "description": "type for this Everyn API operation.", "in": "query", "name": "type", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "enum": [ "all_rows", "failed_rows", "flagged_rows", "generated_outputs", "resolved_lineage_results", "successful_rows" ], "title": "Type" } }, { "description": "format for this Everyn API operation.", "in": "query", "name": "format", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "enum": [ "csv" ], "title": "Format" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_ExportResponse_" } } }, "description": "Successful Response", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Malformed request, header, cursor, or multipart form field.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Missing, malformed, unknown, revoked, or expired credential.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Authenticated principal lacks the required scope or role.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Resource not found, including cross-organization resources.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Idempotency conflict or invalid resource state.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Public error", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Rate limit exceeded.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } } }, "security": [ { "BearerAuth": [] } ], "summary": "List Run Exports", "tags": [ "exports" ] }, "post": { "description": "Create Export. Authenticated Everyn public API operation. Send the request to the selected server from this document with a product API key (Authorization: Bearer sk-everyn-...). Parameters and responses are typed in this document.", "operationId": "create_export_v1_runs__run_id__exports_post", "parameters": [ { "description": "Identifier of the run.", "in": "path", "name": "run_id", "required": true, "schema": { "title": "Run Id", "type": "string" } }, { "description": "Caller-supplied key that makes this write retry-safe.", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency-Key" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExportCreateRequestBody" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExportResponse" } } }, "description": "Successful Response", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Malformed request, header, cursor, or multipart form field.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Missing, malformed, unknown, revoked, or expired credential.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Authenticated principal lacks the required scope or role.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Resource not found, including cross-organization resources.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Idempotency conflict or invalid resource state.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Public error", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Rate limit exceeded.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Create Export", "tags": [ "exports" ] } }, "/v1/runs/{run_id}/failures": { "get": { "description": "List Run Failures. Authenticated Everyn public API operation. Send the request to the selected server from this document with a product API key (Authorization: Bearer sk-everyn-...). Parameters and responses are typed in this document.", "operationId": "list_run_failures_v1_runs__run_id__failures_get", "parameters": [ { "description": "Identifier of the run.", "in": "path", "name": "run_id", "required": true, "schema": { "title": "Run Id", "type": "string" } }, { "description": "Maximum number of items to return in this page.", "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "title": "Limit", "type": "integer" } }, { "description": "Opaque pagination cursor from the previous page.", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, { "description": "retryable for this Everyn API operation.", "in": "query", "name": "retryable", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Retryable" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_FailureResponse_" } } }, "description": "Successful Response", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Malformed request, header, cursor, or multipart form field.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Missing, malformed, unknown, revoked, or expired credential.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Authenticated principal lacks the required scope or role.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Resource not found, including cross-organization resources.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Idempotency conflict or invalid resource state.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Public error", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Rate limit exceeded.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } } }, "security": [ { "BearerAuth": [] } ], "summary": "List Run Failures", "tags": [ "runs" ] } }, "/v1/runs/{run_id}/failures/{run_row_id}": { "get": { "description": "Get Run Failure. Authenticated Everyn public API operation. Send the request to the selected server from this document with a product API key (Authorization: Bearer sk-everyn-...). Parameters and responses are typed in this document.", "operationId": "get_run_failure_v1_runs__run_id__failures__run_row_id__get", "parameters": [ { "description": "Identifier of the run.", "in": "path", "name": "run_id", "required": true, "schema": { "title": "Run Id", "type": "string" } }, { "description": "run_row_id for this Everyn API operation.", "in": "path", "name": "run_row_id", "required": true, "schema": { "title": "Run Row Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FailureResponse" } } }, "description": "Successful Response", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Malformed request, header, cursor, or multipart form field.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Missing, malformed, unknown, revoked, or expired credential.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Authenticated principal lacks the required scope or role.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Resource not found, including cross-organization resources.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Idempotency conflict or invalid resource state.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Public error", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Rate limit exceeded.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Get Run Failure", "tags": [ "runs" ] } }, "/v1/runs/{run_id}/outputs": { "get": { "description": "List Run Outputs. Authenticated Everyn public API operation. Send the request to the selected server from this document with a product API key (Authorization: Bearer sk-everyn-...). Parameters and responses are typed in this document.", "operationId": "list_run_outputs_v1_runs__run_id__outputs_get", "parameters": [ { "description": "Identifier of the run.", "in": "path", "name": "run_id", "required": true, "schema": { "title": "Run Id", "type": "string" } }, { "description": "Maximum number of items to return in this page.", "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "title": "Limit", "type": "integer" } }, { "description": "Opaque pagination cursor from the previous page.", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, { "description": "datasetRowId for this Everyn API operation.", "in": "query", "name": "datasetRowId", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Datasetrowid" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_OutputListItemResponse_" } } }, "description": "Successful Response", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Malformed request, header, cursor, or multipart form field.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Missing, malformed, unknown, revoked, or expired credential.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Authenticated principal lacks the required scope or role.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Resource not found, including cross-organization resources.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Idempotency conflict or invalid resource state.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Public error", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Rate limit exceeded.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } } }, "security": [ { "BearerAuth": [] } ], "summary": "List Run Outputs", "tags": [ "runs" ] } }, "/v1/runs/{run_id}/outputs/{output_id}": { "get": { "description": "Get Run Output. Authenticated Everyn public API operation. Send the request to the selected server from this document with a product API key (Authorization: Bearer sk-everyn-...). Parameters and responses are typed in this document.", "operationId": "get_run_output_v1_runs__run_id__outputs__output_id__get", "parameters": [ { "description": "Identifier of the run.", "in": "path", "name": "run_id", "required": true, "schema": { "title": "Run Id", "type": "string" } }, { "description": "output_id for this Everyn API operation.", "in": "path", "name": "output_id", "required": true, "schema": { "title": "Output Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutputDetailResponse" } } }, "description": "Successful Response", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Malformed request, header, cursor, or multipart form field.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Missing, malformed, unknown, revoked, or expired credential.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Authenticated principal lacks the required scope or role.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Resource not found, including cross-organization resources.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Idempotency conflict or invalid resource state.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Public error", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Rate limit exceeded.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Get Run Output", "tags": [ "runs" ] } }, "/v1/runs/{run_id}/resolved-results": { "get": { "description": "Get Resolved Run Results. Authenticated Everyn public API operation. Send the request to the selected server from this document with a product API key (Authorization: Bearer sk-everyn-...). Parameters and responses are typed in this document.", "operationId": "get_resolved_run_results_v1_runs__run_id__resolved_results_get", "parameters": [ { "description": "Identifier of the run.", "in": "path", "name": "run_id", "required": true, "schema": { "title": "Run Id", "type": "string" } }, { "description": "Maximum number of items to return in this page.", "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "title": "Limit", "type": "integer" } }, { "description": "Opaque pagination cursor from the previous page.", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, { "description": "resultState for this Everyn API operation.", "in": "query", "name": "resultState", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Resultstate" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResolvedResultsResponse" } } }, "description": "Successful Response", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Malformed request, header, cursor, or multipart form field.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Missing, malformed, unknown, revoked, or expired credential.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Authenticated principal lacks the required scope or role.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Resource not found, including cross-organization resources.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Idempotency conflict or invalid resource state.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Public error", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Rate limit exceeded.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Get Resolved Run Results", "tags": [ "runs" ] } }, "/v1/runs/{run_id}/resume": { "post": { "description": "Continue a run that paused because its managed-AI value was exhausted.\n\nA state transition on an existing run rather than a create, so it carries\nno idempotency key — the same shape as start and cancel. Resuming an\nalready-running run is a no-op that returns the run, so a double click\ncosts nothing.\n\nResume re-checks billing authority and execution-safe wallet value before\nchanging a paused run. If funding or paid-work authority was not restored,\nthe request is rejected and the run remains paused.", "operationId": "resume_run_v1_runs__run_id__resume_post", "parameters": [ { "description": "Identifier of the run.", "in": "path", "name": "run_id", "required": true, "schema": { "title": "Run Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RunResponse" } } }, "description": "Successful Response", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Malformed request, header, cursor, or multipart form field.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Missing, malformed, unknown, revoked, or expired credential.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Authenticated principal lacks the required scope or role.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Resource not found, including cross-organization resources.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Idempotency conflict or invalid resource state.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Public error", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Rate limit exceeded.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Resume Run", "tags": [ "runs" ] } }, "/v1/runs/{run_id}/retry": { "post": { "description": "Create Retry Run. Authenticated Everyn public API operation. Send the request to the selected server from this document with a product API key (Authorization: Bearer sk-everyn-...). Parameters and responses are typed in this document.", "operationId": "create_retry_run_v1_runs__run_id__retry_post", "parameters": [ { "description": "Identifier of the run.", "in": "path", "name": "run_id", "required": true, "schema": { "title": "Run Id", "type": "string" } }, { "description": "Caller-supplied key that makes this write retry-safe.", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency-Key" } } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RunResponse" } } }, "description": "Successful Response", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Malformed request, header, cursor, or multipart form field.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Missing, malformed, unknown, revoked, or expired credential.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Authenticated principal lacks the required scope or role.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Resource not found, including cross-organization resources.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Idempotency conflict or invalid resource state.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Public error", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Rate limit exceeded.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Create Retry Run", "tags": [ "runs" ] } }, "/v1/runs/{run_id}/rows": { "get": { "description": "List Run Rows. Authenticated Everyn public API operation. Send the request to the selected server from this document with a product API key (Authorization: Bearer sk-everyn-...). Parameters and responses are typed in this document.", "operationId": "list_run_rows_v1_runs__run_id__rows_get", "parameters": [ { "description": "Identifier of the run.", "in": "path", "name": "run_id", "required": true, "schema": { "title": "Run Id", "type": "string" } }, { "description": "Maximum number of items to return in this page.", "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "title": "Limit", "type": "integer" } }, { "description": "Opaque pagination cursor from the previous page.", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, { "description": "state for this Everyn API operation.", "in": "query", "name": "state", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "enum": [ "failed", "flagged", "pending", "running", "skipped", "succeeded" ], "title": "State" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_RunRowResponse_" } } }, "description": "Successful Response", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Malformed request, header, cursor, or multipart form field.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Missing, malformed, unknown, revoked, or expired credential.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Authenticated principal lacks the required scope or role.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Resource not found, including cross-organization resources.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Idempotency conflict or invalid resource state.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Public error", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Rate limit exceeded.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } } }, "security": [ { "BearerAuth": [] } ], "summary": "List Run Rows", "tags": [ "runs" ] } }, "/v1/runs/{run_id}/rows/{dataset_row_id}/history": { "get": { "description": "Get Row History. Authenticated Everyn public API operation. Send the request to the selected server from this document with a product API key (Authorization: Bearer sk-everyn-...). Parameters and responses are typed in this document.", "operationId": "get_row_history_v1_runs__run_id__rows__dataset_row_id__history_get", "parameters": [ { "description": "Identifier of the run.", "in": "path", "name": "run_id", "required": true, "schema": { "title": "Run Id", "type": "string" } }, { "description": "dataset_row_id for this Everyn API operation.", "in": "path", "name": "dataset_row_id", "required": true, "schema": { "title": "Dataset Row Id", "type": "string" } }, { "description": "Maximum number of items to return in this page.", "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 50, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "Opaque pagination cursor from the previous page.", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, { "description": "attemptId for this Everyn API operation.", "in": "query", "name": "attemptId", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Attemptid" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RowHistoryPageResponse" } } }, "description": "Successful Response", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Malformed request, header, cursor, or multipart form field.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Missing, malformed, unknown, revoked, or expired credential.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Authenticated principal lacks the required scope or role.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Resource not found, including cross-organization resources.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Idempotency conflict or invalid resource state.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Public error", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Rate limit exceeded.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Get Row History", "tags": [ "runs" ] } }, "/v1/runs/{run_id}/rows/{dataset_row_id}/history/content/{handle}": { "get": { "description": "Get Row History Content. Authenticated Everyn public API operation. Send the request to the selected server from this document with a product API key (Authorization: Bearer sk-everyn-...). Parameters and responses are typed in this document.", "operationId": "get_row_history_content_v1_runs__run_id__rows__dataset_row_id__history_content__handle__get", "parameters": [ { "description": "Identifier of the run.", "in": "path", "name": "run_id", "required": true, "schema": { "title": "Run Id", "type": "string" } }, { "description": "dataset_row_id for this Everyn API operation.", "in": "path", "name": "dataset_row_id", "required": true, "schema": { "title": "Dataset Row Id", "type": "string" } }, { "description": "handle for this Everyn API operation.", "in": "path", "name": "handle", "required": true, "schema": { "title": "Handle", "type": "string" } }, { "description": "offset for this Everyn API operation.", "in": "query", "name": "offset", "required": false, "schema": { "default": 0, "minimum": 0, "title": "Offset", "type": "integer" } }, { "description": "Maximum number of items to return in this page.", "in": "query", "name": "limit", "required": false, "schema": { "default": 65536, "maximum": 65536, "minimum": 1, "title": "Limit", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RowHistoryContentResponse" } } }, "description": "Successful Response", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Malformed request, header, cursor, or multipart form field.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Missing, malformed, unknown, revoked, or expired credential.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Authenticated principal lacks the required scope or role.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Resource not found, including cross-organization resources.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Idempotency conflict or invalid resource state.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Public error", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Rate limit exceeded.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Get Row History Content", "tags": [ "runs" ] } }, "/v1/runs/{run_id}/rows/{dataset_row_id}/history/tail": { "get": { "description": "Get Row History Tail. Authenticated Everyn public API operation. Send the request to the selected server from this document with a product API key (Authorization: Bearer sk-everyn-...). Parameters and responses are typed in this document.", "operationId": "get_row_history_tail_v1_runs__run_id__rows__dataset_row_id__history_tail_get", "parameters": [ { "description": "Identifier of the run.", "in": "path", "name": "run_id", "required": true, "schema": { "title": "Run Id", "type": "string" } }, { "description": "dataset_row_id for this Everyn API operation.", "in": "path", "name": "dataset_row_id", "required": true, "schema": { "title": "Dataset Row Id", "type": "string" } }, { "description": "Opaque pagination cursor from the previous page.", "in": "query", "name": "cursor", "required": true, "schema": { "minLength": 1, "title": "Cursor", "type": "string" } }, { "description": "Maximum number of items to return in this page.", "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 50, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "attemptId for this Everyn API operation.", "in": "query", "name": "attemptId", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Attemptid" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RowHistoryPageResponse" } } }, "description": "Successful Response", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Malformed request, header, cursor, or multipart form field.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Missing, malformed, unknown, revoked, or expired credential.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Authenticated principal lacks the required scope or role.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Resource not found, including cross-organization resources.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Idempotency conflict or invalid resource state.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Public error", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Rate limit exceeded.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Get Row History Tail", "tags": [ "runs" ] } }, "/v1/runs/{run_id}/rows/{run_row_id}": { "get": { "description": "Get Run Row. Authenticated Everyn public API operation. Send the request to the selected server from this document with a product API key (Authorization: Bearer sk-everyn-...). Parameters and responses are typed in this document.", "operationId": "get_run_row_v1_runs__run_id__rows__run_row_id__get", "parameters": [ { "description": "Identifier of the run.", "in": "path", "name": "run_id", "required": true, "schema": { "title": "Run Id", "type": "string" } }, { "description": "run_row_id for this Everyn API operation.", "in": "path", "name": "run_row_id", "required": true, "schema": { "title": "Run Row Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RunRowDetailResponse" } } }, "description": "Successful Response", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Malformed request, header, cursor, or multipart form field.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Missing, malformed, unknown, revoked, or expired credential.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Authenticated principal lacks the required scope or role.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Resource not found, including cross-organization resources.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Idempotency conflict or invalid resource state.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Public error", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Rate limit exceeded.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Get Run Row", "tags": [ "runs" ] } }, "/v1/runs/{run_id}/start": { "post": { "description": "Start Run. Authenticated Everyn public API operation. Send the request to the selected server from this document with a product API key (Authorization: Bearer sk-everyn-...). Parameters and responses are typed in this document.", "operationId": "start_run_v1_runs__run_id__start_post", "parameters": [ { "description": "Identifier of the run.", "in": "path", "name": "run_id", "required": true, "schema": { "title": "Run Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RunResponse" } } }, "description": "Successful Response", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Malformed request, header, cursor, or multipart form field.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Missing, malformed, unknown, revoked, or expired credential.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Authenticated principal lacks the required scope or role.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Resource not found, including cross-organization resources.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Idempotency conflict or invalid resource state.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Public error", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Rate limit exceeded.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Start Run", "tags": [ "runs" ] } }, "/v1/usage/balance": { "get": { "description": "Preflight the organization's managed-AI funding before starting a run.\n\nReports the organization's billing state and execution-safe balance from\nthe same wallet projection standard managed-run admission uses. Read-only\nand advisory — nothing is reserved by calling it, and the balance is\nmodel-agnostic: whether a specific model's turn can fund depends on that\nmodel's per-turn reservation bound.", "operationId": "get_managed_ai_balance_v1_usage_balance_get", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagedAiBalanceResponse" } } }, "description": "Successful Response", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Malformed request, header, cursor, or multipart form field.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Missing, malformed, unknown, revoked, or expired credential.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Authenticated principal lacks the required scope or role.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Resource not found, including cross-organization resources.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Idempotency conflict or invalid resource state.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Public error", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Rate limit exceeded.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Get Managed Ai Balance", "tags": [ "usage" ] } }, "/v1/webhook-deliveries": { "get": { "description": "List Webhook Deliveries. Authenticated Everyn public API operation. Send the request to the selected server from this document with a product API key (Authorization: Bearer sk-everyn-...). Parameters and responses are typed in this document.", "operationId": "list_webhook_deliveries_v1_webhook_deliveries_get", "parameters": [ { "description": "Maximum number of items to return in this page.", "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "title": "Limit", "type": "integer" } }, { "description": "Opaque pagination cursor from the previous page.", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, { "description": "webhookEndpointId for this Everyn API operation.", "in": "query", "name": "webhookEndpointId", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Webhookendpointid" } }, { "description": "status for this Everyn API operation.", "in": "query", "name": "status", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "enum": [ "failed", "pending", "succeeded" ], "title": "Status" } }, { "description": "eventType for this Everyn API operation.", "in": "query", "name": "eventType", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "enum": [ "export.ready", "row.failed", "run.canceled", "run.completed_with_flags", "run.created", "run.failed", "run.succeeded", "webhook.test" ], "title": "Eventtype" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_WebhookDeliveryResponse_" } } }, "description": "Successful Response", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Malformed request, header, cursor, or multipart form field.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Missing, malformed, unknown, revoked, or expired credential.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Authenticated principal lacks the required scope or role.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Resource not found, including cross-organization resources.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Idempotency conflict or invalid resource state.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Public error", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Rate limit exceeded.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } } }, "security": [ { "BearerAuth": [] } ], "summary": "List Webhook Deliveries", "tags": [ "webhooks" ] } }, "/v1/webhook-deliveries/{delivery_id}": { "get": { "description": "Get Webhook Delivery. Authenticated Everyn public API operation. Send the request to the selected server from this document with a product API key (Authorization: Bearer sk-everyn-...). Parameters and responses are typed in this document.", "operationId": "get_webhook_delivery_v1_webhook_deliveries__delivery_id__get", "parameters": [ { "description": "delivery_id for this Everyn API operation.", "in": "path", "name": "delivery_id", "required": true, "schema": { "title": "Delivery Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookDeliveryDetailResponse" } } }, "description": "Successful Response", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Malformed request, header, cursor, or multipart form field.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Missing, malformed, unknown, revoked, or expired credential.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Authenticated principal lacks the required scope or role.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Resource not found, including cross-organization resources.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Idempotency conflict or invalid resource state.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Public error", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Rate limit exceeded.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Get Webhook Delivery", "tags": [ "webhooks" ] } }, "/v1/webhook-endpoints": { "get": { "description": "List Webhook Endpoints. Authenticated Everyn public API operation. Send the request to the selected server from this document with a product API key (Authorization: Bearer sk-everyn-...). Parameters and responses are typed in this document.", "operationId": "list_webhook_endpoints_v1_webhook_endpoints_get", "parameters": [ { "description": "Maximum number of items to return in this page.", "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "title": "Limit", "type": "integer" } }, { "description": "Opaque pagination cursor from the previous page.", "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_WebhookEndpointResponse_" } } }, "description": "Successful Response", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Malformed request, header, cursor, or multipart form field.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Missing, malformed, unknown, revoked, or expired credential.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Authenticated principal lacks the required scope or role.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Resource not found, including cross-organization resources.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Idempotency conflict or invalid resource state.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Public error", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Rate limit exceeded.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } } }, "security": [ { "BearerAuth": [] } ], "summary": "List Webhook Endpoints", "tags": [ "webhooks" ] }, "post": { "description": "Create Webhook Endpoint. Authenticated Everyn public API operation. Send the request to the selected server from this document with a product API key (Authorization: Bearer sk-everyn-...). Parameters and responses are typed in this document.", "operationId": "create_webhook_endpoint_v1_webhook_endpoints_post", "parameters": [ { "description": "Caller-supplied key that makes this write retry-safe.", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency-Key" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookEndpointCreateRequestBody" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/WebhookEndpointSecretResponse" }, { "$ref": "#/components/schemas/WebhookEndpointResponse" } ], "title": "Response Create Webhook Endpoint V1 Webhook Endpoints Post" } } }, "description": "Successful Response", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Malformed request, header, cursor, or multipart form field.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Missing, malformed, unknown, revoked, or expired credential.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Authenticated principal lacks the required scope or role.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Resource not found, including cross-organization resources.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Idempotency conflict or invalid resource state.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Public error", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Rate limit exceeded.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Create Webhook Endpoint", "tags": [ "webhooks" ] } }, "/v1/webhook-endpoints/{webhook_endpoint_id}": { "delete": { "description": "Delete Webhook Endpoint. Authenticated Everyn public API operation. Send the request to the selected server from this document with a product API key (Authorization: Bearer sk-everyn-...). Parameters and responses are typed in this document.", "operationId": "delete_webhook_endpoint_v1_webhook_endpoints__webhook_endpoint_id__delete", "parameters": [ { "description": "Identifier of the webhook endpoint.", "in": "path", "name": "webhook_endpoint_id", "required": true, "schema": { "title": "Webhook Endpoint Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookEndpointResponse" } } }, "description": "Successful Response", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Malformed request, header, cursor, or multipart form field.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Missing, malformed, unknown, revoked, or expired credential.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Authenticated principal lacks the required scope or role.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Resource not found, including cross-organization resources.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Idempotency conflict or invalid resource state.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Public error", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Rate limit exceeded.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Delete Webhook Endpoint", "tags": [ "webhooks" ] }, "get": { "description": "Get Webhook Endpoint. Authenticated Everyn public API operation. Send the request to the selected server from this document with a product API key (Authorization: Bearer sk-everyn-...). Parameters and responses are typed in this document.", "operationId": "get_webhook_endpoint_v1_webhook_endpoints__webhook_endpoint_id__get", "parameters": [ { "description": "Identifier of the webhook endpoint.", "in": "path", "name": "webhook_endpoint_id", "required": true, "schema": { "title": "Webhook Endpoint Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookEndpointResponse" } } }, "description": "Successful Response", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Malformed request, header, cursor, or multipart form field.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Missing, malformed, unknown, revoked, or expired credential.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Authenticated principal lacks the required scope or role.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Resource not found, including cross-organization resources.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Idempotency conflict or invalid resource state.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Public error", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Rate limit exceeded.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Get Webhook Endpoint", "tags": [ "webhooks" ] }, "patch": { "description": "Update Webhook Endpoint. Authenticated Everyn public API operation. Send the request to the selected server from this document with a product API key (Authorization: Bearer sk-everyn-...). Parameters and responses are typed in this document.", "operationId": "update_webhook_endpoint_v1_webhook_endpoints__webhook_endpoint_id__patch", "parameters": [ { "description": "Identifier of the webhook endpoint.", "in": "path", "name": "webhook_endpoint_id", "required": true, "schema": { "title": "Webhook Endpoint Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookEndpointUpdateRequestBody" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookEndpointResponse" } } }, "description": "Successful Response", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Malformed request, header, cursor, or multipart form field.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Missing, malformed, unknown, revoked, or expired credential.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Authenticated principal lacks the required scope or role.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Resource not found, including cross-organization resources.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Idempotency conflict or invalid resource state.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Public error", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Rate limit exceeded.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Update Webhook Endpoint", "tags": [ "webhooks" ] } }, "/v1/webhook-endpoints/{webhook_endpoint_id}/rotate-secret": { "post": { "description": "Rotate Webhook Endpoint Secret. Authenticated Everyn public API operation. Send the request to the selected server from this document with a product API key (Authorization: Bearer sk-everyn-...). Parameters and responses are typed in this document.", "operationId": "rotate_webhook_endpoint_secret_v1_webhook_endpoints__webhook_endpoint_id__rotate_secret_post", "parameters": [ { "description": "Identifier of the webhook endpoint.", "in": "path", "name": "webhook_endpoint_id", "required": true, "schema": { "title": "Webhook Endpoint Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookEndpointSecretResponse" } } }, "description": "Successful Response", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Malformed request, header, cursor, or multipart form field.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Missing, malformed, unknown, revoked, or expired credential.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Authenticated principal lacks the required scope or role.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Resource not found, including cross-organization resources.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Idempotency conflict or invalid resource state.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Public error", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Rate limit exceeded.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Rotate Webhook Endpoint Secret", "tags": [ "webhooks" ] } }, "/v1/webhook-endpoints/{webhook_endpoint_id}/test": { "post": { "description": "Test Webhook Endpoint. Authenticated Everyn public API operation. Send the request to the selected server from this document with a product API key (Authorization: Bearer sk-everyn-...). Parameters and responses are typed in this document.", "operationId": "test_webhook_endpoint_v1_webhook_endpoints__webhook_endpoint_id__test_post", "parameters": [ { "description": "Identifier of the webhook endpoint.", "in": "path", "name": "webhook_endpoint_id", "required": true, "schema": { "title": "Webhook Endpoint Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookDeliveryDetailResponse" } } }, "description": "Successful Response", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Malformed request, header, cursor, or multipart form field.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Missing, malformed, unknown, revoked, or expired credential.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Authenticated principal lacks the required scope or role.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Resource not found, including cross-organization resources.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Idempotency conflict or invalid resource state.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Public error", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } }, "description": "Rate limit exceeded.", "headers": { "X-Request-Id": { "description": "Canonical everyn request ID generated by the API.", "schema": { "examples": [ "req_abc123" ], "type": "string" } } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Test Webhook Endpoint", "tags": [ "webhooks" ] } } }, "servers": [ { "description": "Production API", "url": "https://api.everyn.ai" }, { "description": "Local development API", "url": "http://localhost:8000" } ], "tags": [ { "description": "Unauthenticated operational readiness checks.", "name": "health" }, { "description": "Browser-admin routes for organizations, members, invitations, API-key management, and audit events. API keys cannot call these admin routes.", "name": "organization-admin" }, { "description": "Organization-scoped human billing reads and owner/admin billing mutations.", "name": "billing" }, { "description": "CSV dataset intake. Direct multipart uploads are limited to 25 MiB and return 202 DatasetUpload resources for async processing.", "name": "dataset-uploads" }, { "description": "Dataset read models. Use /v1/dataset-uploads for CSV intake.", "name": "datasets" }, { "description": "Product model catalog. Reads require job_specs:read; job-spec create/update still validates model IDs against this catalog.", "name": "models" }, { "description": "Reusable job specs and immutable job-spec versions.", "name": "job-specs" }, { "description": "Managed run creation, start/cancel/retry, rows, events, outputs, failures, and resolved retry-lineage results.", "name": "runs" }, { "description": "Organization usage and funding reads: the browser workspace usage snapshot and the machine-readable managed-AI balance preflight (runs:read). The execution-safe balance is advisory — settlement drains asynchronously after runs complete.", "name": "usage" }, { "description": "Self-starting CSV exports. Clients create, poll/list/read, and download ready exports through the API; there is no public execute action.", "name": "exports" }, { "description": "Event-based alert rules and public-safe alert delivery inspection.", "name": "alert-rules" }, { "description": "Webhook endpoint management, one-time signing-secret display/rotation, test deliveries, and public-safe delivery inspection.", "name": "webhooks" } ] }