@parall/sdk 1.56.1 → 1.57.1

package/dist/llm-provider-types.d.ts

@@ -0,0 +1,97 @@
+/**
+ * Org-configured model providers (BYOK) and the model rows bound to them.
+ *
+ * Design: docs/engineering-design/org-llm-provider-byok-design.md
+ */
+/** Inbound protocol a provider can serve. */
+export type LLMProviderEndpoint = 'chat_completions' | 'messages' | 'responses';
+export type LLMProviderStatus = 'active' | 'disabled';
+/**
+ * A provider as the server returns it. The credential is never echoed back —
+ * `api_key_set` is the only thing a client learns about it.
+ */
+export interface LLMProvider {
+    id: string;
+    name: string;
+    base_url: string;
+    api_key_set: boolean;
+    endpoints: LLMProviderEndpoint[];
+    status: LLMProviderStatus;
+    is_platform: boolean;
+    /**
+     * Runtime types whose protocol this provider can actually serve. Anything
+     * absent here silently uses the platform provider — surface this, or an
+     * operator will assume their credential covers every agent.
+     */
+    runtimes: string[];
+    /** Most recent fallback-worthy failure, if any. */
+    last_error_at?: string | null;
+    last_error_status?: number | null;
+    created_at: string;
+    updated_at: string;
+}
+export interface CreateLLMProviderRequest {
+    name: string;
+    base_url: string;
+    api_key: string;
+    endpoints: LLMProviderEndpoint[];
+}
+/** Omitting `api_key` leaves the stored credential untouched. */
+export interface UpdateLLMProviderRequest {
+    name?: string;
+    base_url?: string;
+    api_key?: string;
+    endpoints?: LLMProviderEndpoint[];
+    status?: LLMProviderStatus;
+}
+/**
+ * One org's row for a model. Overriding a platform model and adding a new one
+ * are the same shape: `overrides_platform` is derived by the server from
+ * whether the platform catalog knows this id, never stored.
+ */
+export interface OrgLLMModel {
+    id: string;
+    model_id: string;
+    provider_id: string;
+    upstream_model_id: string;
+    display_name?: string | null;
+    context_window?: number | null;
+    max_tokens?: number | null;
+    overrides_platform: boolean;
+    created_at: string;
+    updated_at: string;
+}
+export interface CreateOrgLLMModelRequest {
+    model_id: string;
+    provider_id: string;
+    /** The name to send to this provider, which differs per provider. */
+    upstream_model_id: string;
+    /** Required when `model_id` is not in the platform catalog. */
+    display_name?: string;
+    context_window?: number;
+    max_tokens?: number;
+    effort_levels?: string[];
+    input_modalities?: string[];
+}
+/**
+ * Everything about a model row except its identity. `model_id` is what agents
+ * pin to, so changing it is a delete-and-recreate the operator performs
+ * deliberately; the server rejects it here.
+ */
+export interface UpdateOrgLLMModelRequest {
+    provider_id?: string;
+    upstream_model_id?: string;
+    /**
+     * Metadata fields accept `null` to clear the org's value and go back to
+     * inheriting the platform entry's. Omitting a field leaves it as it is —
+     * the two are different requests, so do not send `undefined` meaning
+     * "clear". A model the platform does not have cannot clear these: it has
+     * nothing to inherit from, and the server rejects it.
+     */
+    display_name?: string | null;
+    context_window?: number | null;
+    max_tokens?: number | null;
+    effort_levels?: string[] | null;
+    input_modalities?: string[] | null;
+}
+//# sourceMappingURL=llm-provider-types.d.ts.map

package/dist/llm-provider-types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"llm-provider-types.d.ts","sourceRoot":"","sources":["../src/llm-provider-types.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,6CAA6C;AAC7C,MAAM,MAAM,mBAAmB,GAAG,kBAAkB,GAAG,UAAU,GAAG,WAAW,CAAC;AAEhF,MAAM,MAAM,iBAAiB,GAAG,QAAQ,GAAG,UAAU,CAAC;AAEtD;;;GAGG;AACH,MAAM,WAAW,WAAW;IAC1B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,EAAE,OAAO,CAAC;IACrB,SAAS,EAAE,mBAAmB,EAAE,CAAC;IACjC,MAAM,EAAE,iBAAiB,CAAC;IAC1B,WAAW,EAAE,OAAO,CAAC;IACrB;;;;OAIG;IACH,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,mDAAmD;IACnD,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAClC,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,wBAAwB;IACvC,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,mBAAmB,EAAE,CAAC;CAClC;AAED,iEAAiE;AACjE,MAAM,WAAW,wBAAwB;IACvC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,mBAAmB,EAAE,CAAC;IAClC,MAAM,CAAC,EAAE,iBAAiB,CAAC;CAC5B;AAED;;;;GAIG;AACH,MAAM,WAAW,WAAW;IAC1B,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,EAAE,MAAM,CAAC;IACpB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,kBAAkB,EAAE,OAAO,CAAC;IAC5B,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,wBAAwB;IACvC,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,EAAE,MAAM,CAAC;IACpB,qEAAqE;IACrE,iBAAiB,EAAE,MAAM,CAAC;IAC1B,+DAA+D;IAC/D,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;IACzB,gBAAgB,CAAC,EAAE,MAAM,EAAE,CAAC;CAC7B;AAED;;;;GAIG;AACH,MAAM,WAAW,wBAAwB;IACvC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B;;;;;;OAMG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,aAAa,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;IAChC,gBAAgB,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;CACpC"}

package/dist/llm-provider-types.js

@@ -0,0 +1,6 @@
+/**
+ * Org-configured model providers (BYOK) and the model rows bound to them.
+ *
+ * Design: docs/engineering-design/org-llm-provider-byok-design.md
+ */
+export {};

package/dist/types.d.ts

@@ -376,6 +376,25 @@ export interface Organization {
     onboarding_agent_id: string | null;
     /** Org-level IANA timezone (e.g. "America/New_York"). Defaults to "UTC". */
     timezone: string;
+    /**
+     * Whether this org may configure its own LLM providers (BYOK). Absent means
+     * it inherits the platform default, which is off.
+     *
+     * An entitlement, not a feature flag: only a platform admin changes it, and
+     * it is expected to become plan-driven. Turning it off also stops existing
+     * provider configuration from taking effect.
+     */
+    llm_byok_enabled?: boolean | null;
+    /**
+     * When an org's own model provider fails at run time, retry once on the
+     * platform provider — billed to this org's credit balance. Defaults to off,
+     * so "no fallback" is the default state and fallback is opted into.
+     * Does NOT gate the capability fallback: a provider that cannot serve a
+     * runtime's protocol always defers to the platform regardless.
+     * Current servers populate this field; it remains optional for source
+     * compatibility with cached and rolling-upgrade organization payloads.
+     */
+    llm_byok_fallback_enabled?: boolean;
     created_at: string;
     /** Per-member flag: true when the user has dismissed the onboarding popup for this org. */
     onboarding_dismissed: boolean;
@@ -561,6 +580,23 @@ export interface CreateInvitationRequest {
 export interface ApiKey {
     id: string;
     api_key: string;
+    org_id?: string;
+}
+export interface PersonalApiKey {
+    id: string;
+    user_id: string;
+    name?: string;
+    org_id: string;
+    last_used_at?: string;
+    expires_at?: string;
+    created_at: string;
+}
+export interface CreatePersonalApiKeyRequest {
+    name?: string;
+    /** The org this key is bound to; the caller must be a member. */
+    org_id: string;
+    /** RFC3339; must be in the future. Omit for a non-expiring key. */
+    expires_at?: string;
 }
 export interface CreateAgentResponse {
     user: User;
@@ -856,10 +892,8 @@ export interface MessageDispatchSource {
     source_type: string;
     source_id: string;
     /**
-     * Conversation generation of the sending execution (parel v2 invocation
-     * context). Required by the server for agents on the direct_session_v2
-     * transport; a value older than the current New Session barrier is
-     * rejected (STALE_GENERATION).
+     * @deprecated Ignored by current servers. Retained so clients compiled
+     * against older SDKs can upgrade without source changes.
      */
     generation?: number;
 }
@@ -1448,8 +1482,8 @@ export interface UpdateTaskRequest {
      * Lane-bound form (v1 consumers): dispatch_lane + dispatch_event_id bind
      * the update to the claimed typed lane (incumbency-checked).
      * By-id form (parel v2 converged consumers — no lane exists):
-     * dispatch_event_id + dispatch_generation bind the update to the WorkItem
-     * directly under the conversation-generation fence.
+     * dispatch_event_id alone binds the update to the WorkItem; the server
+     * admits it on the binding's transport and deletion state alone.
      * In both forms dispatch_effect_key additionally commits the update as
      * the dispatch's idempotent Effect and resolves the WorkItem in the same
      * transaction. Lane-bound: exactly "task_update:<dispatch_event_id>" —
@@ -1462,6 +1496,10 @@ export interface UpdateTaskRequest {
     dispatch_lane?: string;
     dispatch_event_id?: string;
     dispatch_effect_key?: string;
+    /**
+     * @deprecated Ignored by current servers. Retained so clients compiled
+     * against older SDKs can upgrade without source changes.
+     */
     dispatch_generation?: number;
 }
 export interface CreateTaskRelationRequest {
@@ -1964,6 +2002,10 @@ export interface WikiChangeset {
     title: string;
     message: string | null;
     status: WikiChangesetStatus;
+    /** Present on current servers; optional keeps older mocked/client data source-compatible. */
+    head_branch?: string | null;
+    /** Present on current servers; optional keeps older mocked/client data source-compatible. */
+    base_commit?: string | null;
     merge_commit: string | null;
     file_changes: WikiFileChange[];
     changed_paths: string[];
@@ -2195,6 +2237,8 @@ export interface CreateWikiChangesetRequest {
     title: string;
     message?: string;
     file_changes: WikiFileChangeInput[];
+    /** Omit for the server default (`proposed`); pass `draft` for staged uploads. */
+    status?: 'draft' | 'proposed';
     source_chat_id?: string;
     source_message_id?: string;
     source_run_id?: string;
@@ -2203,6 +2247,8 @@ export interface UpdateWikiChangesetRequest {
     title?: string;
     message?: string;
     file_changes?: WikiFileChangeInput[];
+    /** Author-settable transitions currently include `proposed` and `closed`. */
+    status?: 'proposed' | 'closed';
     /**
      * When true, file_changes define the changeset's FULL content: the server
      * resets the feature branch to the current default-branch HEAD before
@@ -2321,15 +2367,6 @@ export interface WikiBlob {
     signed_url?: string;
     signed_url_expires_at?: string;
 }
-export type WikiStoredAs = 'git_blob' | 'lfs_pointer';
-/** Response from POST /uploads or POST /changesets/{csId}/files. */
-export interface WikiFileUploadResponse {
-    path: string;
-    size: number;
-    stored_as: WikiStoredAs;
-    commit_sha: string;
-    content_sha: string;
-}
 /** Response from POST /files/preview-url — short-lived signed URL for
  * browser `<img>`/`<video>`/`<iframe>` src. TTL is 5 minutes by default. */
 export interface WikiFilePreviewUrlResponse {
@@ -2757,6 +2794,7 @@ export interface ChannelConversation {
     agent_id: string;
     agent_session_id?: string | null;
     external_conversation_id: string;
+    external_conversation_name?: string;
     external_thread_id: string;
     conversation_type: string;
     external_user_id: string;
@@ -3456,6 +3494,8 @@ export interface ResolvedRef {
     type: string;
     exists: boolean;
     restricted?: boolean;
+    /** The target could not be resolved because a dependency failed temporarily. */
+    unavailable?: boolean;
     display_name?: string;
     avatar_url?: string | null;
     user_type?: string;
@@ -4585,61 +4625,7 @@ export interface BrowserAliasExecutionReceipt {
     terminal_at?: string;
     updated_at: string;
 }
-export type BrowserUseAction = 'read' | 'tabs' | 'wait' | 'snapshot' | 'get' | 'screenshot' | 'open' | 'navigate' | 'viewport' | 'click' | 'fill' | 'type' | 'press' | 'scroll' | 'close' | 'recover' | 'eval';
-export interface BrowserUseTarget {
-    tab_id?: string;
-    browser_generation?: number;
-    document_generation?: number;
-    snapshot_id?: string;
-    ref?: string;
-}
-export interface BrowserUseOperationRequest {
-    contract_version: 'browser-use-operation-v1';
-    request_id: string;
-    profile_id: string;
-    action: BrowserUseAction;
-    target?: BrowserUseTarget;
-    params: Record<string, unknown>;
-    /** Canonical RFC3339 UTC instant, no more than two minutes in the future. */
-    deadline: string;
-}
-export type BrowserUseOperationPhase = 'accepted' | 'started' | 'succeeded' | 'failed' | 'outcome_unknown';
-export interface BrowserUseOperationError {
-    code: string;
-    message?: string;
-    hint?: string;
-}
-/** Durable Browser Use proof. `data` is encrypted/transient: it is present
- * only while result_available is true and disappears after result_expires_at;
- * the terminal receipt and result_digest remain durable. */
-export interface BrowserUseOperationReceipt {
-    contract_version: 'browser-use-operation-v1';
-    operation_id: string;
-    request_id: string;
-    profile_id: string;
-    profile_version: number;
-    profile_config_revision: number;
-    action: BrowserUseAction;
-    required_grant: 'browser.read' | 'browser.interact' | 'browser.advanced';
-    phase: BrowserUseOperationPhase;
-    dispatched?: boolean;
-    receipt_id?: string;
-    receipt_digest?: string;
-    occurred_at?: string;
-    tab_id?: string;
-    browser_generation?: number;
-    duration_ms?: number;
-    result_digest?: string;
-    result_available: boolean;
-    result_expires_at?: string;
-    data?: unknown;
-    error?: BrowserUseOperationError;
-    deadline: string;
-    accepted_at: string;
-    started_at?: string;
-    terminal_at?: string;
-    updated_at: string;
-}
+export type { BrowserUseAction, BrowserUseActionRequest, BrowserUseArticle, BrowserUseGrant, BrowserUseOperationError, BrowserUseOperationPhase, BrowserUseOperationReceipt, BrowserUseOperationReceiptBase, BrowserUseOperationReceiptFor, BrowserUseOperationRequest, BrowserUseRefTarget, BrowserUseSuccessDataMap, BrowserUseTabState, BrowserUseTabSummary, BrowserUseTabTarget, BrowserUseTarget, BrowserUseViewport, } from './browser-use.js';
 /**
  * Sanitized per-profile egress proxy status (hosted Cloud Profiles) — the GET
  * response and the PUT/DELETE result. NEVER carries the password; `password_set`