NodaroAccount
Docs do Nodaro
DocumentaçãoReferência de nósModelosTemplatesAgentes de IA (MCP)DesenvolvedoresAuto-hospedagemPesquisaComparações
SDK para TypeScript

Tipos

Todos os tipos TypeScript, funções auxiliares e constantes que o @nodaro/sdk exporta, agrupados por recurso, com a página que documenta cada um.

@nodaro/sdk exporta um tipo TypeScript para as entradas e as saídas da maioria dos métodos, além de algumas funções auxiliares e constantes. Importe os tipos com import type, para que eles não acrescentem nada ao seu pacote final:

import type { Workflow, Job, NodeJobOutput, WorkflowExecution } from "@nodaro/sdk"

const { data }: { data: Workflow } = await client.workflows.get(id)

Os tipos seguem o formato de transmissão da API. Um Job usa campos em snake_case, como output_data e created_at, porque a API os envia assim. Um Workflow e um WorkflowExecution usam camelCase. Object, o tipo de objeto, tem o mesmo nome do objeto global do JavaScript, então importe-o com outro nome quando precisar dos dois: import type { Object as NodaroObject } from "@nodaro/sdk".

Alguns tipos que os métodos usam não são exportados. Um tipo definido em @nodaro/shared, como PipelineInput ou CommunityFullDetail, é importado de lá. Adicione @nodaro/shared às suas próprias dependências, na faixa de versões que o SDK usa, para que só uma cópia seja instalada. Derive qualquer outro tipo, como PipelineRecord, do método que o retorna:

import type { NodaroClient } from "@nodaro/sdk"
import type { PipelineInput, CommunityFullDetail } from "@nodaro/shared"

type PipelineRecord = Awaited<ReturnType<NodaroClient["pipelines"]["get"]>>

Cliente, autenticação e erros

ExportaçãoTipoDocumentado em
createClient, NodaroClientFunção, classeCliente
ClientOptions, UserIdentity, MeOrganizations, ConnectedAppTiposCliente
Auth, StaticTokenAuth, CallbackAuth, supabaseAuthTipo, classes, funçãoAutenticação
createSharedSupabaseClientFunção, de @nodaro/sdk/supabaseAutenticação
NodaroError, UnauthorizedError, ForbiddenError, ModelUnavailableError, NotFoundError, RateLimitedError, InsufficientCreditsError, StorageExceededError, WorkflowConflictError, JobBlockedError, MediaTooLongError, LargeUploadUnavailableError, JobFailedError, JobTimeoutError, JobAbortedError, JobHeldError, StudioOpError, StudioPreviewUnavailable, StudioPreviewAppliedErrorClassesErros
WorkflowConflictCode, throwFromResponseTipo, funçãoErros

Workflows, execuções e nós

ExportaçãoDocumentado em
Workflow, ListWorkflowsParams, CreateWorkflowInput, UpdateWorkflowInput, RunWorkflowParams, RunWorkflowResult, RenderFinalParams, RenderFinalQuoteWorkflows e projetos
Project, CreateProjectInput, UpdateProjectInputWorkflows e projetos
GenerationSession, SessionItem, SessionPage, CreateSessionInput, UpdateSessionInput, ListSessionsParams, ListSessionItemsParams, GenerationSessionParamsWorkflows e projetos
GenericNode, GenericEdge, WorkflowExport, WorkflowExportCharacter, WorkflowExportObject, WorkflowExportLocationWorkflows e projetos
Job, JobStatus, JobStatusResult, JobErrorHint, SafetyBlockHint, PolicyBlockHint, CreditStatus, CancelJobResult, DeleteJobResult, ListJobsParams, ListJobsPage, JobRating, JobRatingFilter, RateJobResultTarefas e execuções
WebhookEndpoint, CreateWebhookEndpointInput, UpdateWebhookEndpointInput, CreatedWebhookEndpoint, RotateWebhookSecretInput, RotatedWebhookSecret, WebhookDelivery, WebhookDeliveryPage, ListWebhookDeliveriesParams, WebhookJobEvent, WebhookEventType, WebhookDeliveryStatus, WebhookEvent, JobWebhookEvent, PingWebhookEvent, WebhookSignatureError, VerifyWebhookSignatureOptions, WebhookSignatureErrorCodeTarefas e execuções
WorkflowExecution, WorkflowExecutionSummary, NodeExecutionState, NodeExecutionStatus, ExecutionStatus, ExecutionOutcome, ExecutionTriggerType, ListExecutionsForWorkflowParams, ListExecutionsPage, CancelExecutionParamsTarefas e execuções
StopVideoProResult, ContinueVideoProResultTarefas e execuções
NodeDescriptor, NodeCategory, OutputType, NodeInputField, NodeInputSchemaExecutar nós
RunNodeResult, RunNodeAdjustment, RunNodeWarning, NodeJobOutput, JobOutputImage, RunAndWaitOptions, RunManyResult, GenerateImageBatchResult, GenerateImageBatchOutput, BatchJobOutcomeExecutar nós
GenerateImageParams, GenerateVideoParams, TextToVideoParams, StructuredReferenceParams, ConnectedReference, DescribedReference, ImageOutputFormat, ImageSvgLevelExecutar nós
PromptAffixFieldsOs campos de dados do nó para o texto antes e depois do prompt: promptPrefix e promptSuffix
PublishedApp, PublishedAppDetail, ListAppsParams, ListAppsResult, AppRunResult, RunAppOptions, AppRun, ListAppRunsParams, DeleteAppRunResultApps e templates
Template, TemplateBrowseCard, TemplateSort, BrowseTemplatesParams, BrowseTemplatesResult, CloneTemplateParams, CloneTemplateResultApps e templates
TutorialCategory, TutorialVideoItem, TutorialFlowItemApps e templates
LlmStructuredInput, LlmStructuredResult, LlmStructuredJobInput, LlmStructuredJobOutputLLM e Reduce
ReduceStrategyId, ReduceMeta, ReduceInput, ReduceResultLLM e Reduce

Mídia, vozes e edição

ExportaçãoDocumentado em
UploadResult, ImportUrlResult, LibraryAsset, ListLibraryParams, ListLibraryResultMídia e uploads
GalleryItem, GalleryMediaType, BrowseGalleryParams, GalleryPage, ToggleFavoriteResultMídia e uploads
VideoMetadata, DownloadVideoProgress, MediaProcessInput, MediaProcessResult, OverlayPlacementMídia e uploads
AddCaptionsInput, CaptionLookInput, CaptionSegmentInput, CaptionEntryMídia e uploads
Voice, SharedVoice, VoiceClone, VoiceLibraryParams, VoiceLibraryResponseVozes e áudio
VoiceChangerProInput, VoiceChangerProVoice, VcpAnalyzeInput, VcpAnalysis, VcpAnalysisSpeaker, VcpExportInput, VcpExportTrackVozes e áudio
VoiceDesignInput, VoiceRemixInput, DubbingInput, AudioFxPresetVozes e áudio
TranscribeWord, TranscribeJobOutput, TranscribeProvider, TranscribeLaneVozes e áudio
EditJobResult, SilenceDetectInput, SilenceRanges, AudioSyncInput, AudioSyncSource, AudioSyncOffset, AudioSyncResult, ApplyEdlInput, EditPlanInput, EditPlanSource, EditPlanMode, EditPlanTier, Edl, EdlClipSet, ChapterSet, Transcript, TightenEpisodeInput, TightenEpisodeJobResult, TightenEpisodeEstimate, UseCaseRecordingsInput, UseCaseJobResult, UseCaseEstimate, EpisodeChaptersInput, EpisodeTrailerInput, TrailerFormat, ClipPackInput, SpeakerLayoutInput, SpeakerMapInput, SpeakerMapSource, SpeakerMapResult, CameraSwitchInput, EditPlanCapabilities, UseCaseContinueInputEdição
GenerateScene3DParams, EditScene3DParams, RenderScene3DParams, Scene3DJobOutput, Scene3DCapabilities, Scene3DAuthoringEngine, RetainedScene3DEditParams, RetainedScene3DEditResult, Scene3DDelivery, Scene3DDeliveryAsset, Scene3DDeliveryAssetKindCenas 3D

Entidades

ExportaçãoDocumentado em
Character, CharacterDetail, CharacterUsage, ReferencePhoto, ReferencePhotoKind, UpsertCharacterInput, UpsertCharacterResult, ListCharactersParams, ListCharactersResult, DuplicateCharacterInput, GenerateCharacterInput, GenerateCharacterResult, GenerateAssetInput, GenerateMotionInput, ApprovePortraitResult, RecaptionResult, CharacterAspectRatio, EntityStyle, TrainCharacterInput, TrainCharacterResult, CharacterTrainingStatus, CharacterTrainingState, TrainCharacterRefusalCodePersonagens
Location, LocationDetail, LocationReferencePhoto, LocationReferencePhotoKind, CreateLocationInput, UpdateLocationInput, UpdateLocationResult, ListLocationsParams, GenerateLocationInput, GenerateLocationResult, GenerateLocationAssetInput, GenerateSurroundContinuationInput, ApproveMainImageResult, RecaptionLocationResult, LocationAssetType, LocationAttachColumn, SurroundDirectionLocais
Object, ObjectDetail, ObjectCategory, ObjectReferencePhoto, ObjectReferencePhotoKind, CreateObjectInput, UpdateObjectInput, UpdateObjectResult, UpsertObjectInput, UpsertObjectResult, ListObjectsParams, GenerateObjectInput, GenerateObjectResult, GenerateObjectAssetInput, GenerateObjectAssetResult, GenerateObjectMotionInput, GenerateObjectMotionResult, ApproveObjectMainImageResult, RecaptionObjectResult, ObjectAssetType, ObjectAttachColumn, ObjectAspectRatioObjetos e criaturas
Creature, CreatureDetail, CreatureReferencePhoto, CreatureReferencePhotoKind, CreateCreatureInput, UpdateCreatureInput, UpdateCreatureResult, UpsertCreatureInput, UpsertCreatureResult, ListCreaturesParams, GenerateCreatureInput, GenerateCreatureResult, GenerateCreatureAssetInput, GenerateCreatureAssetResult, GenerateCreatureMotionInput, GenerateCreatureMotionResult, ApproveCreatureMainImageResult, RecaptionCreatureResult, CreatureAssetType, CreatureAttachColumn, CreatureAspectRatioObjetos e criaturas
CommunityCard, CommunityEntityType, CommunitySort, CommunityReportReason, BrowseCommunityParams, BrowseCommunityResult, CloneListingResult, FavoriteListingResult, ReportListingResultBiblioteca da comunidade

Produções

ExportaçãoDocumentado em
StudioProduction, StudioProductionDetail, StudioSkillResponse, StudioValidatePlanResponse, StudioPlanIssue, StudioListProductionsResponse, ListStudioProductionsOptions, GetProductionOptions, StudioExportPlanOptions, StudioExportPlanResponse, StudioExportStepProduções do Studio
StudioCreateProductionRequest, StudioProductionResponse, StudioImportSummary, StudioClientRequestId, StudioOpsRequest, StudioOpsResponse, StudioOpsReceipt, StudioOpsImpact, StudioOpClass, StudioOpsDryRunReceipt, StudioOpsDryRunResponse, StudioReconcileResponseProduções do Studio
StudioGenerateRequest, StudioGenerateOptions, StudioGenerateResult, StudioGenerateEstimate, StudioGenerateResponse, StudioVideoLane, StudioDescribeRequest, StudioFrameRequest, StudioVoiceRequest, StudioRevoiceRequest, StudioMusicRequest, StudioMediaResponse, StudioJobStartedResponse, StudioCloneRequestProduções do Studio
StudioProductionCapabilities, StudioKeyframeRecord, StudioProductionRecord, StudioProductionReply, StudioEditInput, StudioKeyframeGenerationInput, StudioKeyframeAcceptanceInput, StudioShotGenerationInput, StudioGenerationReply, StudioDocumentJsonProduções do Studio
Shot, ShotMode, ShotEntityRef, CreateShotInput, UpdateShotInputProduções do Studio
CreateRecastInput, EstimateRecastInput, RecastEstimate, RecastRunSnapshot, ResolveRecastGateInput, RecastScriptValidation, RecastScriptValidationError, RecastScriptImportResultRecast
RecastAudioManifestV1, RecastAudioLayerName, RecastAudioMix, RecastAudioMixControl, RecastAudioSectionReplacement, RecastRescoreReplacement, RecastRescoreOperation, EstimateRecastRescoreInput, RecastRescoreRequestV2, RecastRescoreQuote, RecastRescoreResponseRecast
PipelineStageName, BranchPipelineInput, BranchPipelineResult, ChatTurn, ChatStageResult, ApplyChatProposalResultPipelines
CopilotThread, CopilotThreadWorkflow, CopilotSurface, CopilotRunMode, CopilotModelTier, CopilotMessage, CopilotMessagePart, CreateCopilotThreadInput, CopilotStreamOptions, CopilotStreamFrame e os tipos de dados dos eventosCopilot

Conta e catálogos

ExportaçãoDocumentado em
ModelSummary, ModelMaker, ModelsListResult, ListModelsOptions, UserBalance, ModelCostsResult, FreeGrantState, WelcomeOfferState, WelcomeOfferClaimInput, WelcomeOfferClaimResult, UsageSummary, UsageSummaryOptions, UsageSummaryBucket, UsageSummaryTotals, UsageByModel, UsageByCategory, UsageOverTime, UsageByGroup, CreditHistoryEntry, CreditHistoryJob, CreditHistoryKind, CreditHistoryPage, CreditHistoryFilters, CreditHistoryOptionsModelos e créditos
BillingPlansResult, BillingPlan, BillingPlanPrices, BillingMoney, BillingMonthlyPrice, BillingYearlyPrice, BillingPriceCredits, BillingTopUp, BillingSubscriptionResult, BillingSubscription, BillingSurface, BillingAccountSummary, BillingUsageCategory, BillingPurchase, BillingDocument, BillingCard, BillingDetails, BillingPaymentMethod, BillingAutoRecharge, BillingAutoRechargeInput, BillingAutoRechargeSaved, BillingUiMode, BillingCheckoutInput, BillingCheckoutSession, BillingCheckoutStatus, BillingLoadInput, BillingLoadSession, BillingPortalInput, BillingPortalSession, BillingChangePlanInput, BillingChangePlanResultModelos e créditos
PickerCatalog, PickerCatalogSummary, PickerOption, PickerDimension, PickerCatalogSection, GetPickerCatalogOptionsSeletores, predefinições e prompts
CatalogsListResponse, ProjectedCatalog, ProjectedCatalogOption, ProjectedCatalogDimension, ProjectedCatalogSectionSeletores, predefinições e prompts
NodePreset, NodePresetGroup, FactoryPresetsResult, FactoryPresetEntry, CreateNodePresetInput, UpdateNodePresetInput, ImportNodePresetInput, ReorderNodePresetsInputSeletores, predefinições e prompts
ColorPalette, PalettePage, ListPalettesParams, CreatePaletteInput, UpdatePaletteInput, Moodboard, MoodboardPage, ListMoodboardsParams, CreateMoodboardInput, UpdateMoodboardInput, DirectionFieldsSeletores, predefinições e prompts
AnalyzeInput, AnalyzeResult, GenerateInput, EnhanceInput, PromptResult, WizardQuestion, WizardOption, WizardSelection, RecommendedModel, WizardNodeContextSeletores, predefinições e prompts
OrganizationView, OrganizationSummary, OrgMemberView, OrgKind, OrgRole, OrgStatus, OrgSettings, OrgAuditEntry, OrgPage, OrgErrorCode, MemberStatus, CreateOrgInput, InviteInput, ListInvitationsOptionsOrganizações e espaços de trabalho
InvitationView, InvitationDelivery, InvitationPreview, InvitationState, JoinCodeViewOrganizações e espaços de trabalho
WorkspaceView, WorkspaceSummary, WorkspaceMemberView, WorkspaceRole, WorkspaceSettings, CreateWorkspaceInputOrganizações e espaços de trabalho
UsageQuery, UsageGroupBy, UsageReport, UsageReportRow, UsageReportTotals, UsageVarianceRow, UsageLogEntryOrganizações e espaços de trabalho
DeveloperApp, DeveloperAppScope, DeveloperAppStatus, DeveloperAppKind, CreateDeveloperAppInput, UpdateDeveloperAppInput, CreateDeveloperAppResult, RotateSecretResultOAuth e apps de desenvolvedor
ExchangeCodeInput, AccessTokenResponse, OAuthAppInfoOAuth e apps de desenvolvedor

Funções auxiliares e constantes

Estes são valores, não tipos, então importe-os sem type.

ExportaçãoO que é
nodeStateMayCarryOutput(status), OUTPUT_BEARING_NODE_STATUSESSe o estado de um nó pode trazer output: completed e failed. Veja Tarefas e execuções.
executionOutcome(status, nodeStates), countEmptyInputSkips(nodeStates)Se uma execução concluída não encontrou nada novo, e quantos nós ela pulou por falta de entrada. Veja Tarefas e execuções.
isStudioGenerateEstimate(result)Distingue uma cotação de geração de uma execução iniciada. Veja Produções do Studio.
unwrapEditPlanOutput(outputData)Lê a saída de uma tarefa de plano de edição como uma EDL, uma lista de EDLs ou capítulos. Veja Edição.
verifyWebhookSignature(options)Verifica a assinatura de uma chamada de webhook e retorna o evento. Veja Tarefas e execuções.
paletteDirectionId(id), moodboardDirectionId(id), PALETTE_DIRECTION_PREFIX, MOODBOARD_DIRECTION_PREFIXMontam os valores de direction de uma paleta ou de um painel de inspiração. Veja Seletores, predefinições e prompts.
throwFromResponse(status, body)Lança a classe de erro que corresponde a uma resposta da API. Veja Erros.
PROMPT_PREFIX_KEY, PROMPT_SUFFIX_KEYAs chaves de dados do nó do texto antes e depois do prompt.
WORKSPACE_HEADERO nome do cabeçalho de espaço de trabalho, X-Nodaro-Workspace.
USAGE_GROUP_BYSOs agrupamentos que um relatório de uso aceita.
LOCATION_ASSET_TYPES, LOCATION_ATTACH_COLUMNS, SURROUND_DIRECTIONSOs tipos de variação, as coleções e as direções das vistas em 360 graus permitidos para locais.
OBJECT_ASSET_TYPES, OBJECT_ATTACH_COLUMNS, OBJECT_ASPECT_OPTIONS, OBJECT_ASPECT_DEFAULTSOs tipos de variação, as coleções e as proporções permitidos para objetos.
CREATURE_ASSET_TYPES, CREATURE_ATTACH_COLUMNS, CREATURE_ASPECT_OPTIONS, CREATURE_ASPECT_DEFAULTSAs mesmas listas para criaturas.
CHARACTER_STYLES, CHARACTER_ASPECT_OPTIONS, CHARACTER_ASPECT_DEFAULTSOs estilos e as proporções de personagens.
SCENE3D_DELIVERY_ASSET_USAGEOs pares permitidos de tipo de arquivo de entrega e uso.

Toda classe de recurso, como WorkflowsResource ou NodesResource, também é exportada, para tipagem avançada. Você raramente precisa delas: createClient monta todos os recursos para você.

Perguntas frequentes

Como importo um tipo do SDK do Nodaro?

Use import type com o nome do tipo, por exemplo import type { Workflow, Job } from @nodaro/sdk. Alguns tipos que os métodos usam não são exportados: importe-os de @nodaro/shared ou derive-os do método.

Por que alguns campos usam snake_case e outros camelCase?

Os tipos seguem o formato de transmissão da API. Um Job usa snake_case, como output_data e created_at, porque a API o envia assim. Um Workflow e um WorkflowExecution usam camelCase.

Também preciso do @nodaro/shared?

Normalmente, não. O SDK reexporta a maioria dos tipos compartilhados que os métodos dele usam, como os tipos de organização e de edição. Algumas funções auxiliares, como as de revisão 3D e toConnectedReference, e alguns tipos, como PipelineInput e CommunityFullDetail, são importados diretamente de @nodaro/shared.

Última atualização

Nesta página