{"openapi":"3.1.0","info":{"title":"Client SDK","version":"1.0.0"},"paths":{"/v1/execute-prompt":{"post":{"operationId":"execute-prompt","summary":"Execute Prompt","description":"Executes a deployed Prompt and returns the result.","tags":[""],"parameters":[{"name":"X-API-KEY","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExecutePromptResponse"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExecutePromptApiErrorResponse"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExecutePromptApiErrorResponse"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExecutePromptApiErrorResponse"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExecutePromptApiErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExecutePromptRequest"}}}}}},"/v1/execute-prompt-stream":{"post":{"operationId":"execute-prompt-stream","summary":"Execute Prompt Stream","description":"Executes a deployed Prompt and streams back the results.","tags":[""],"parameters":[{"name":"X-API-KEY","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"text/event-stream":{"schema":{"$ref":"#/components/schemas/ExecutePromptEvent"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExecutePromptApiErrorResponse"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExecutePromptApiErrorResponse"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExecutePromptApiErrorResponse"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExecutePromptApiErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExecutePromptStreamRequest"}}}}}},"/v1/submit-completion-actuals":{"post":{"operationId":"submit-completion-actuals","summary":"Submit Completion Actuals","description":"Used to submit feedback regarding the quality of previously generated completions.","tags":[""],"parameters":[{"name":"X-API-KEY","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"No response body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/submit-completion-actuals_Response_200"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitCompletionActualsErrorResponse"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitCompletionActualsErrorResponse"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitCompletionActualsErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitCompletionActualsRequest"}}}}}},"/v1/deployments/provider-payload":{"post":{"operationId":"retrieve-provider-payload","summary":"Retrieve Provider Payload","description":"Given a set of input variable values, compile the exact payload that Vellum would send to the configured model provider\nfor execution if the execute-prompt endpoint had been invoked. Note that this endpoint does not actually execute the\nprompt or make an API call to the model provider.\n\nThis endpoint is useful if you don't want to proxy LLM provider requests through Vellum and prefer to send them directly\nto the provider yourself. Note that no guarantees are made on the format of this API's response schema, other than\nthat it will be a valid payload for the configured model provider. It's not recommended that you try to parse or\nderive meaning from the response body and instead, should simply pass it directly to the model provider as is.\n\nWe encourage you to seek advise from Vellum Support before integrating with this API for production use.\n","tags":["subpackage_deployments"],"parameters":[{"name":"X-API-KEY","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeploymentProviderPayloadResponse"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExecutePromptApiErrorResponse"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExecutePromptApiErrorResponse"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExecutePromptApiErrorResponse"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExecutePromptApiErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeploymentProviderPayloadRequest"}}}}}},"/v1/sandboxes/{id}/prompts/{prompt_variant_id}/deploy":{"post":{"operationId":"deploy-prompt","summary":"Deploy Prompt","tags":["subpackage_sandboxes"],"parameters":[{"name":"id","in":"path","description":"A UUID string identifying this sandbox.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"prompt_variant_id","in":"path","description":"An ID identifying the Prompt you'd like to deploy.","required":true,"schema":{"type":"string"}},{"name":"X-API-KEY","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeploymentRead"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeploySandboxPromptRequest"}}}}}},"/v1/sandboxes/{id}/scenarios":{"post":{"operationId":"upsert-sandbox-scenario","summary":"Upsert Sandbox Scenario","description":"Upserts a new scenario for a sandbox, keying off of the optionally provided scenario id.\n\nIf an id is provided and has a match, the scenario will be updated. If no id is provided or no match\nis found, a new scenario will be appended to the end.\n\nNote that a full replacement of the scenario is performed, so any fields not provided will be removed\nor overwritten with default values.","tags":["subpackage_sandboxes"],"parameters":[{"name":"id","in":"path","description":"A UUID string identifying this sandbox.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"X-API-KEY","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SandboxScenario"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertSandboxScenarioRequest"}}}}}},"/v1/sandboxes/{id}/scenarios/{scenario_id}":{"delete":{"operationId":"delete-sandbox-scenario","summary":"Delete Sandbox Scenario","description":"Deletes an existing scenario from a sandbox, keying off of the provided scenario id.","tags":["subpackage_sandboxes"],"parameters":[{"name":"id","in":"path","description":"A UUID string identifying this sandbox.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"scenario_id","in":"path","description":"An id identifying the scenario that you'd like to delete","required":true,"schema":{"type":"string"}},{"name":"X-API-KEY","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"No response body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sandboxes_delete_sandbox_scenario_Response_204"}}}}}}},"/v1/deployments":{"get":{"operationId":"list","summary":"List","description":"Used to list all Prompt Deployments.","tags":["subpackage_deployments"],"parameters":[{"name":"limit","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer"}},{"name":"offset","in":"query","description":"The initial index from which to return the results.","required":false,"schema":{"type":"integer"}},{"name":"ordering","in":"query","description":"Which field to use when ordering the results.","required":false,"schema":{"type":"string"}},{"name":"status","in":"query","description":"status","required":false,"schema":{"$ref":"#/components/schemas/V1DeploymentsGetParametersStatus"}},{"name":"X-API-KEY","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedSlimDeploymentReadList"}}}}}}},"/v1/deployments/{id}":{"get":{"operationId":"retrieve","summary":"Retrieve","description":"Used to retrieve a Prompt Deployment given its ID or name.","tags":["subpackage_deployments"],"parameters":[{"name":"id","in":"path","description":"Either the Prompt Deployment's ID or its unique name","required":true,"schema":{"type":"string"}},{"name":"X-API-KEY","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeploymentRead"}}}}}}},"/v1/deployments/{id}/releases/{release_id_or_release_tag}":{"get":{"operationId":"retrieve-prompt-deployment-release","summary":"Retrieve Prompt Deployment Release","description":"Retrieve a specific Prompt Deployment Release by either its UUID or the name of a Release Tag that points to it.","tags":["subpackage_deployments"],"parameters":[{"name":"id","in":"path","description":"Either the Prompt Deployment's ID or its unique name","required":true,"schema":{"type":"string"}},{"name":"release_id_or_release_tag","in":"path","description":"Either the UUID of Prompt Deployment Release you'd like to retrieve, or the name of a Release Tag that's pointing to the Prompt Deployment Release you'd like to retrieve.","required":true,"schema":{"type":"string"}},{"name":"X-API-KEY","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PromptDeploymentRelease"}}}}}}},"/v1/deployments/{id}/release-tags/{name}":{"get":{"operationId":"retrieve-deployment-release-tag","summary":"Retrieve Deployment Release Tag","description":"Retrieve a Deployment Release Tag by tag name, associated with a specified Deployment.","tags":["subpackage_deployments"],"parameters":[{"name":"id","in":"path","description":"Either the Prompt Deployment's ID or its unique name","required":true,"schema":{"type":"string"}},{"name":"name","in":"path","description":"The name of the Release Tag associated with this Deployment that you'd like to retrieve.","required":true,"schema":{"type":"string"}},{"name":"X-API-KEY","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeploymentReleaseTagRead"}}}}}},"patch":{"operationId":"update-deployment-release-tag","summary":"Update Deployment Release Tag","description":"Updates an existing Release Tag associated with the specified Prompt Deployment.","tags":["subpackage_deployments"],"parameters":[{"name":"id","in":"path","description":"Either the Prompt Deployment's ID or its unique name","required":true,"schema":{"type":"string"}},{"name":"name","in":"path","description":"The name of the Release Tag associated with this Deployment that you'd like to update.","required":true,"schema":{"type":"string"}},{"name":"X-API-KEY","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeploymentReleaseTagRead"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchedDeploymentReleaseTagUpdateRequest"}}}}}},"/v1/deployments/{id}/release-tags":{"get":{"operationId":"list-deployment-release-tags","summary":"List Deployment Release Tags","description":"List Release Tags associated with the specified Prompt Deployment","tags":["subpackage_deployments"],"parameters":[{"name":"id","in":"path","description":"Either the Prompt Deployment's ID or its unique name","required":true,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer"}},{"name":"offset","in":"query","description":"The initial index from which to return the results.","required":false,"schema":{"type":"integer"}},{"name":"ordering","in":"query","description":"Which field to use when ordering the results.","required":false,"schema":{"type":"string"}},{"name":"source","in":"query","required":false,"schema":{"$ref":"#/components/schemas/V1DeploymentsIdReleaseTagsGetParametersSource"}},{"name":"X-API-KEY","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedDeploymentReleaseTagReadList"}}}}}}},"/v1/deployments/{id}/history/{history_id_or_release_tag}":{"get":{"operationId":"deployment-history-item-retrieve","summary":"Deployment History Item Retrieve","description":"DEPRECATED: This endpoint is deprecated and will be removed in a future release. Please use the\n`retrieve_prompt_deployment_release` xendpoint instead.","tags":["subpackage_deployments"],"parameters":[{"name":"history_id_or_release_tag","in":"path","description":"Either the UUID of Deployment History Item you'd like to retrieve, or the name of a Release Tag that's pointing to the Deployment History Item you'd like to retrieve.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"id","in":"path","description":"Either the Prompt Deployment's ID or its unique name","required":true,"schema":{"type":"string"}},{"name":"X-API-KEY","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeploymentHistoryItem"}}}}}}},"/v1/execute-workflow":{"post":{"operationId":"execute-workflow","summary":"Execute Workflow","description":"Executes a deployed Workflow and returns its outputs.","tags":[""],"parameters":[{"name":"X-API-KEY","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExecuteWorkflowResponse"}}}},"400":{"description":"","content":{"application/json":{"schema":{"type":"object","additionalProperties":{"description":"Any type"}}}}},"404":{"description":"","content":{"application/json":{"schema":{"type":"object","additionalProperties":{"description":"Any type"}}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExecuteWorkflowErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExecuteWorkflowRequest"}}}}}},"/v1/execute-workflow-async":{"post":{"operationId":"execute-workflow-async","summary":"Execute Workflow Async","description":"Executes a deployed Workflow asynchronously and returns the execution ID.","tags":[""],"parameters":[{"name":"X-API-KEY","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExecuteWorkflowAsyncResponse"}}}},"400":{"description":"","content":{"application/json":{"schema":{"type":"object","additionalProperties":{"description":"Any type"}}}}},"404":{"description":"","content":{"application/json":{"schema":{"type":"object","additionalProperties":{"description":"Any type"}}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExecuteWorkflowStreamErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExecuteWorkflowAsyncRequest"}}}}}},"/v1/execute-workflow-stream":{"post":{"operationId":"execute-workflow-stream","summary":"Execute Workflow Stream","description":"Executes a deployed Workflow and streams back its results.","tags":[""],"parameters":[{"name":"X-API-KEY","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"text/event-stream":{"schema":{"$ref":"#/components/schemas/WorkflowStreamEvent"}}}},"400":{"description":"","content":{"application/json":{"schema":{"type":"object","additionalProperties":{"description":"Any type"}}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExecuteWorkflowStreamErrorResponse"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExecuteWorkflowStreamErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExecuteWorkflowStreamRequest"}}}}}},"/v1/workflows/executions/{execution_id}/status":{"get":{"operationId":"workflow-execution-status","summary":"Workflow Execution Status","description":"Checks if a workflow execution is currently executing (not fulfilled, not rejected, and has no end time).\nUses the ClickHouse Prime summary materialized view.","tags":["subpackage_workflows"],"parameters":[{"name":"execution_id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"X-API-KEY","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckWorkflowExecutionStatusResponse"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckWorkflowExecutionStatusErrorResponse"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckWorkflowExecutionStatusErrorResponse"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckWorkflowExecutionStatusErrorResponse"}}}}}}},"/v1/submit-workflow-execution-actuals":{"post":{"operationId":"submit-workflow-execution-actuals","summary":"Submit Workflow Execution Actuals","description":"    Used to submit feedback regarding the quality of previous workflow execution and its outputs.\n\n    **Note:** Uses a base url of `https://predict.vellum.ai`.    ","tags":[""],"parameters":[{"name":"X-API-KEY","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"No response body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/submit-workflow-execution-actuals_Response_200"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitWorkflowExecutionActualsRequest"}}}}}},"/v1/workflow-sandboxes/{id}/deploy":{"post":{"operationId":"deploy-workflow","summary":"Deploy Workflow","tags":["subpackage_workflowSandboxes"],"parameters":[{"name":"id","in":"path","description":"A UUID string identifying this workflow sandbox.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"X-API-KEY","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowDeploymentRead"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeploySandboxWorkflowRequest"}}}}}},"/v1/workflow-deployments/{id}/execute-stream":{"post":{"operationId":"execute-stream","summary":"Execute Stream","description":"Executes a deployed Workflow and streams back its results.","tags":["subpackage_workflowDeployments"],"parameters":[{"name":"id","in":"path","description":"Either the Workflow Deployment's ID or its unique name","required":true,"schema":{"type":"string"}},{"name":"X-API-KEY","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"text/event-stream":{"schema":{"$ref":"#/components/schemas/WorkflowEvent"}}}},"400":{"description":"","content":{"application/json":{"schema":{"type":"object","additionalProperties":{"description":"Any type"}}}}},"404":{"description":"","content":{"application/json":{"schema":{"type":"object","additionalProperties":{"description":"Any type"}}}}},"500":{"description":"","content":{"application/json":{"schema":{"type":"object","additionalProperties":{"description":"Any type"}}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExecuteWorkflowDeploymentStreamRequest"}}}}}},"/v1/workflow-deployments":{"get":{"operationId":"list","summary":"List","description":"Used to list all Workflow Deployments.","tags":["subpackage_workflowDeployments"],"parameters":[{"name":"has_story_config","in":"query","description":"has_story_config","required":false,"schema":{"type":"string"}},{"name":"is_public","in":"query","description":"is_public","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer"}},{"name":"offset","in":"query","description":"The initial index from which to return the results.","required":false,"schema":{"type":"integer"}},{"name":"ordering","in":"query","description":"Specifies the ordering of the returned Workflow Deployments. Valid values are:\n- `created` - Orders by creation time in ascending order.\n- `-created` - Orders by creation time in descending order. (default)\n- `name` - Orders by name in ascending order.\n- `-name` - Orders by name in descending order.\n\nCompound orderings are supported by separating fields with commas, e.g., `-created,name`.\n","required":false,"schema":{"type":"string"}},{"name":"owned_by","in":"query","description":"owned_by","required":false,"schema":{"type":"string"}},{"name":"status","in":"query","description":"status","required":false,"schema":{"$ref":"#/components/schemas/V1WorkflowDeploymentsGetParametersStatus"}},{"name":"X-API-KEY","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedSlimWorkflowDeploymentList"}}}}}}},"/v1/workflow-deployments/{id}/releases":{"get":{"operationId":"list-workflow-deployment-releases","summary":"List Workflow Deployment Releases","description":"List the Releases of the specified Workflow Deployment for the current Environment.","tags":["subpackage_workflowDeployments"],"parameters":[{"name":"id","in":"path","description":"Either the Workflow Deployment's ID or its unique name","required":true,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer"}},{"name":"offset","in":"query","description":"The initial index from which to return the results.","required":false,"schema":{"type":"integer"}},{"name":"ordering","in":"query","description":"Which field to use when ordering the results.","required":false,"schema":{"type":"string"}},{"name":"X-API-KEY","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedWorkflowDeploymentReleaseList"}}}}}}},"/v1/workflow-deployments/{id}":{"get":{"operationId":"retrieve","summary":"Retrieve","description":"Used to retrieve a workflow deployment given its ID or name.","tags":["subpackage_workflowDeployments"],"parameters":[{"name":"id","in":"path","description":"Either the Workflow Deployment's ID or its unique name","required":true,"schema":{"type":"string"}},{"name":"X-API-KEY","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowDeploymentRead"}}}}}}},"/v1/workflow-deployments/{id}/releases/{release_id_or_release_tag}":{"get":{"operationId":"retrieve-workflow-deployment-release","summary":"Retrieve Workflow Deployment Release","description":"Retrieve a specific Workflow Deployment Release by either its UUID or the name of a Release Tag that points to it.","tags":["subpackage_workflowDeployments"],"parameters":[{"name":"id","in":"path","description":"Either the Workflow Deployment's ID or its unique name","required":true,"schema":{"type":"string"}},{"name":"release_id_or_release_tag","in":"path","description":"Either the UUID of Workflow Deployment Release you'd like to retrieve, or the name of a Release Tag that's pointing to the Workflow Deployment Release you'd like to retrieve.","required":true,"schema":{"type":"string"}},{"name":"X-API-KEY","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowDeploymentRelease"}}}}}}},"/v1/workflow-deployments/{id}/release-tags/{name}":{"get":{"operationId":"retrieve-workflow-release-tag","summary":"Retrieve Workflow Release Tag","description":"Retrieve a Workflow Release Tag by tag name, associated with a specified Workflow Deployment.","tags":["subpackage_workflowDeployments"],"parameters":[{"name":"id","in":"path","description":"Either the Workflow Deployment's ID or its unique name","required":true,"schema":{"type":"string"}},{"name":"name","in":"path","description":"The name of the Release Tag associated with this Workflow Deployment that you'd like to retrieve.","required":true,"schema":{"type":"string"}},{"name":"X-API-KEY","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowReleaseTagRead"}}}}}},"patch":{"operationId":"update-workflow-release-tag","summary":"Update Workflow Release Tag","description":"Updates an existing Release Tag associated with the specified Workflow Deployment.","tags":["subpackage_workflowDeployments"],"parameters":[{"name":"id","in":"path","description":"Either the Workflow Deployment's ID or its unique name","required":true,"schema":{"type":"string"}},{"name":"name","in":"path","description":"The name of the Release Tag associated with this Workflow Deployment that you'd like to update.","required":true,"schema":{"type":"string"}},{"name":"X-API-KEY","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowReleaseTagRead"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchedWorkflowReleaseTagUpdateRequest"}}}}}},"/v1/workflow-deployments/{id}/release-tags":{"get":{"operationId":"list-workflow-release-tags","summary":"List Workflow Release Tags","description":"List Release Tags associated with the specified Workflow Deployment","tags":["subpackage_workflowDeployments"],"parameters":[{"name":"id","in":"path","description":"Either the Workflow Deployment's ID or its unique name","required":true,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer"}},{"name":"offset","in":"query","description":"The initial index from which to return the results.","required":false,"schema":{"type":"integer"}},{"name":"ordering","in":"query","description":"Which field to use when ordering the results.","required":false,"schema":{"type":"string"}},{"name":"source","in":"query","required":false,"schema":{"$ref":"#/components/schemas/V1WorkflowDeploymentsIdReleaseTagsGetParametersSource"}},{"name":"X-API-KEY","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedWorkflowReleaseTagReadList"}}}}}}},"/v1/workflow-deployments/{id}/history/{history_id_or_release_tag}":{"get":{"operationId":"workflow-deployment-history-item-retrieve","summary":"Workflow Deployment History Item Retrieve","description":"DEPRECATED: This endpoint is deprecated and will be removed in a future release. Please use the\n`retrieve_workflow_deployment_release` endpoint instead.","tags":["subpackage_workflowDeployments"],"parameters":[{"name":"history_id_or_release_tag","in":"path","description":"Either the UUID of Workflow Deployment History Item you'd like to retrieve, or the name of a Release Tag that's pointing to the Workflow Deployment History Item you'd like to retrieve.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"id","in":"path","description":"Either the Workflow Deployment's ID or its unique name","required":true,"schema":{"type":"string"}},{"name":"X-API-KEY","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowDeploymentHistoryItem"}}}}}}},"/v1/workflow-deployments/{id}/execution-events":{"get":{"operationId":"list-workflow-deployment-event-executions","summary":"List Workflow Deployment Event Executions","tags":["subpackage_workflowDeployments"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"filters","in":"query","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Number of executions to return per page.","required":false,"schema":{"type":"integer"}},{"name":"offset","in":"query","description":"The initial index from which to return the executions.","required":false,"schema":{"type":"integer"}},{"name":"ordering","in":"query","required":false,"schema":{"type":"string"}},{"name":"X-API-KEY","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowDeploymentEventExecutionsResponse"}}}}}}},"/v1/workflow-deployments/{id}/execution-events/{execution_id}":{"get":{"operationId":"workflow-deployment-event-execution","summary":"Workflow Deployment Event Execution","tags":["subpackage_workflowDeployments"],"parameters":[{"name":"execution_id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"X-API-KEY","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowEventExecutionRead"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorDetailResponse"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorDetailResponse"}}}},"421":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateActiveWorkspaceResponse"}}}}}}},"/v1/workflow-executions/{execution_id}/detail":{"get":{"operationId":"retrieve-workflow-execution-detail","summary":"Retrieve Workflow Execution Detail","tags":["subpackage_workflowExecutions"],"parameters":[{"name":"execution_id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"prev_span_id","in":"query","description":"Optional keyset cursor span_id to continue from (exclusive)","required":false,"schema":{"type":"string","format":"uuid"}},{"name":"span_limit","in":"query","description":"Maximum number of spans to return (for lazy loading)","required":false,"schema":{"type":"integer"}},{"name":"X-API-KEY","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowExecutionDetail"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorDetailResponse"}}}},"421":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateActiveWorkspaceResponse"}}}}}}},"/monitoring/v1/events":{"post":{"operationId":"create","summary":"Create","description":"Accept an event or list of events and publish them to ClickHouse for analytics processing.","tags":["subpackage_events"],"parameters":[{"name":"X-API-KEY","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"schema":{"type":"string"}}],"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventCreateResponse"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorDetailResponse"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorDetailResponse"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorDetailResponse"}}}},"429":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorDetailResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateWorkflowEventRequest"}}}}}},"/v1/search":{"post":{"operationId":"search","summary":"Search","description":"Perform a search against a document index.","tags":[""],"parameters":[{"name":"X-API-KEY","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchResponse"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchErrorResponse"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchErrorResponse"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchRequestBodyRequest"}}}}}},"/v1/document-indexes/{id}/documents/{document_id}":{"post":{"operationId":"add-document","summary":"Add Document","description":"Adds a previously uploaded Document to the specified Document Index.","tags":["subpackage_documentIndexes"],"parameters":[{"name":"document_id","in":"path","description":"Either the Vellum-generated ID or the originally supplied external_id that uniquely identifies the Document you'd like to add.","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Either the Vellum-generated ID or the originally specified name that uniquely identifies the Document Index to which you'd like to add the Document.","required":true,"schema":{"type":"string"}},{"name":"X-API-KEY","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"No response body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/document-indexes_add_document_Response_204"}}}}}},"delete":{"operationId":"remove-document","summary":"Remove Document","description":"Removes a Document from a Document Index without deleting the Document itself.","tags":["subpackage_documentIndexes"],"parameters":[{"name":"document_id","in":"path","description":"Either the Vellum-generated ID or the originally supplied external_id that uniquely identifies the Document you'd like to remove.","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Either the Vellum-generated ID or the originally specified name that uniquely identifies the Document Index from which you'd like to remove a Document.","required":true,"schema":{"type":"string"}},{"name":"X-API-KEY","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"No response body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/document-indexes_remove_document_Response_204"}}}}}}},"/v1/document-indexes":{"post":{"operationId":"create","summary":"Create","description":"Creates a new document index.","tags":["subpackage_documentIndexes"],"parameters":[{"name":"X-API-KEY","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"schema":{"type":"string"}}],"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentIndexRead"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentIndexCreateRequest"}}}}},"get":{"operationId":"list","summary":"List","description":"Used to retrieve a list of Document Indexes.","tags":["subpackage_documentIndexes"],"parameters":[{"name":"limit","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer"}},{"name":"offset","in":"query","description":"The initial index from which to return the results.","required":false,"schema":{"type":"integer"}},{"name":"ordering","in":"query","description":"Which field to use when ordering the results.","required":false,"schema":{"type":"string"}},{"name":"search","in":"query","description":"Search for document indices by name or label","required":false,"schema":{"type":"string"}},{"name":"status","in":"query","description":"Filter down to only document indices that have a status matching the status specified\n\n* `ACTIVE` - Active\n* `ARCHIVED` - Archived\n* `PENDING_DELETION` - Pending Deletion","required":false,"schema":{"$ref":"#/components/schemas/V1DocumentIndexesGetParametersStatus"}},{"name":"X-API-KEY","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedDocumentIndexReadList"}}}}}}},"/v1/document-indexes/{id}":{"get":{"operationId":"retrieve","summary":"Retrieve","description":"Used to retrieve a Document Index given its ID or name.","tags":["subpackage_documentIndexes"],"parameters":[{"name":"id","in":"path","description":"Either the Document Index's ID or its unique name","required":true,"schema":{"type":"string"}},{"name":"mask_indexing_config","in":"query","description":"Whether to mask the indexing configuration in the response","required":false,"schema":{"type":"boolean"}},{"name":"X-API-KEY","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentIndexRead"}}}}}},"patch":{"operationId":"partial-update","summary":"Partial Update","description":"Used to partial update a Document Index given its ID or name.","tags":["subpackage_documentIndexes"],"parameters":[{"name":"id","in":"path","description":"Either the Document Index's ID or its unique name","required":true,"schema":{"type":"string"}},{"name":"X-API-KEY","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentIndexRead"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchedDocumentIndexUpdateRequest"}}}}},"put":{"operationId":"update","summary":"Update","description":"Used to fully update a Document Index given its ID or name.","tags":["subpackage_documentIndexes"],"parameters":[{"name":"id","in":"path","description":"Either the Document Index's ID or its unique name","required":true,"schema":{"type":"string"}},{"name":"X-API-KEY","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentIndexRead"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentIndexUpdateRequest"}}}}},"delete":{"operationId":"destroy","summary":"Destroy","description":"Used to delete a Document Index given its ID or name.","tags":["subpackage_documentIndexes"],"parameters":[{"name":"id","in":"path","description":"Either the Document Index's ID or its unique name","required":true,"schema":{"type":"string"}},{"name":"X-API-KEY","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"No response body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/document-indexes_destroy_Response_204"}}}}}}},"/v1/upload-document":{"post":{"operationId":"upload","summary":"Upload","description":"Upload a document to be indexed and used for search.\n\n**Note:** Uses a base url of `https://documents.vellum.ai`.\n","tags":["subpackage_documents"],"parameters":[{"name":"X-API-KEY","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"schema":{"type":"string"}}],"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UploadDocumentResponse"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UploadDocumentErrorResponse"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UploadDocumentErrorResponse"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UploadDocumentErrorResponse"}}}}},"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"add_to_index_names":{"type":["array","null"],"items":{"type":"string"},"description":"Optionally include the names of all indexes that you'd like this document to be included in"},"external_id":{"type":["string","null"],"description":"Optionally include an external ID for this document. This is useful if you want to re-upload the same document later when its contents change and would like it to be re-indexed."},"label":{"type":"string","description":"A human-friendly name for this document. Typically the filename."},"contents":{"type":"string","format":"binary","description":"The file contents of the document. Either contents or url must be provided."},"url":{"type":["string","null"],"format":"uri","description":"A URL from which the document can be downloaded. Either contents or url must be provided."},"keywords":{"type":["array","null"],"items":{"type":"string"},"description":"Optionally include a list of keywords that'll be associated with this document. Used when performing keyword searches."},"metadata":{"type":["string","null"],"format":"byte","description":"A stringified JSON object containing any metadata associated with the document that you'd like to filter upon later."}},"required":["label"]}}}}}},"/v1/documents/{id}":{"get":{"operationId":"retrieve","summary":"Retrieve","description":"Retrieve a Document, keying off of either its Vellum-generated ID or its external ID.","tags":["subpackage_documents"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"X-API-KEY","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentRead"}}}}}},"patch":{"operationId":"partial-update","summary":"Partial Update","description":"Update a Document, keying off of either its Vellum-generated ID or its external ID. Particularly useful for updating its metadata.","tags":["subpackage_documents"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"X-API-KEY","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentRead"}}}}},"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"label":{"type":"string","description":"A human-readable label for the document. Defaults to the originally uploaded file's file name."},"status":{"$ref":"#/components/schemas/DocumentStatus","description":"The current status of the document\n\n* `ACTIVE` - Active"},"keywords":{"type":"array","items":{"type":"string"},"description":"A list of keywords that'll be associated with the document. Used as part of keyword search."},"metadata":{"type":["object","null"],"additionalProperties":{"description":"Any type"},"description":"A JSON object containing any metadata associated with the document that you'd like to filter upon later."}}}}}}},"delete":{"operationId":"destroy","summary":"Destroy","description":"Delete a Document, keying off of either its Vellum-generated ID or its external ID.","tags":["subpackage_documents"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"X-API-KEY","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"No response body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/documents_destroy_Response_204"}}}}}}},"/v1/documents":{"get":{"operationId":"list","summary":"List","description":"Used to list documents. Optionally filter on supported fields.","tags":["subpackage_documents"],"parameters":[{"name":"document_index_id","in":"query","description":"Filter down to only those documents that are included in the specified index. You may provide either the Vellum-generated ID or the unique name of the index specified upon initial creation.","required":false,"schema":{"type":"string","format":"uuid"}},{"name":"limit","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer"}},{"name":"offset","in":"query","description":"The initial index from which to return the results.","required":false,"schema":{"type":"integer"}},{"name":"ordering","in":"query","description":"Which field to use when ordering the results.","required":false,"schema":{"type":"string"}},{"name":"search","in":"query","description":"A search term.","required":false,"schema":{"type":"string"}},{"name":"X-API-KEY","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedSlimDocumentList"}}}}}}},"/v1/uploaded-files/{id}":{"get":{"operationId":"retrieve","summary":"Retrieve","description":"Retrieve a previously uploaded file by its ID","tags":["subpackage_uploadedFiles"],"parameters":[{"name":"id","in":"path","description":"A UUID string identifying this uploaded file.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"expiry_seconds","in":"query","description":"The number of seconds until the signed URL expires. Must be > 0 and <= 2592000 (30 days). Non-numeric or out-of-range values fall back to the default (604800 seconds or 7 days).","required":false,"schema":{"type":"integer"}},{"name":"X-API-KEY","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UploadedFileRead"}}}}}}},"/v1/test-suites/{id}/test-cases":{"get":{"operationId":"list-test-suite-test-cases","summary":"List Test Suite Test Cases","description":"List the Test Cases associated with a Test Suite","tags":["subpackage_testSuites"],"parameters":[{"name":"id","in":"path","description":"Either the Test Suites' ID or its unique name","required":true,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer"}},{"name":"offset","in":"query","description":"The initial index from which to return the results.","required":false,"schema":{"type":"integer"}},{"name":"X-API-KEY","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedTestSuiteTestCaseList"}}}}}},"post":{"operationId":"upsert-test-suite-test-case","summary":"Upsert Test Suite Test Case","description":"Upserts a new test case for a test suite, keying off of the optionally provided test case id.\n\nIf an id is provided and has a match, the test case will be updated. If no id is provided or no match\nis found, a new test case will be appended to the end.\n\nNote that a full replacement of the test case is performed, so any fields not provided will be removed\nor overwritten with default values.","tags":["subpackage_testSuites"],"parameters":[{"name":"id","in":"path","description":"Either the Test Suites' ID or its unique name","required":true,"schema":{"type":"string"}},{"name":"X-API-KEY","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TestSuiteTestCase"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertTestSuiteTestCaseRequest"}}}}}},"/v1/test-suites/{id}/test-cases-bulk":{"post":{"operationId":"test-suite-test-cases-bulk","summary":"Test Suite Test Cases Bulk","description":"Created, replace, and delete Test Cases within the specified Test Suite in bulk","tags":["subpackage_testSuites"],"parameters":[{"name":"id","in":"path","description":"Either the Test Suites' ID or its unique name","required":true,"schema":{"type":"string"}},{"name":"X-API-KEY","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"text/event-stream":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TestSuiteTestCaseBulkResult"}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TestSuiteTestCaseBulkOperationRequest"}}}}}}},"/v1/test-suites/{id}/test-cases/{test_case_id}":{"delete":{"operationId":"delete-test-suite-test-case","summary":"Delete Test Suite Test Case","description":"Deletes an existing test case for a test suite, keying off of the test case id.\n","tags":["subpackage_testSuites"],"parameters":[{"name":"id","in":"path","description":"Either the Test Suites' ID or its unique name","required":true,"schema":{"type":"string"}},{"name":"test_case_id","in":"path","description":"An id identifying the test case that you'd like to delete","required":true,"schema":{"type":"string"}},{"name":"X-API-KEY","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"No response body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/test-suites_delete_test_suite_test_case_Response_204"}}}}}}},"/v1/test-suite-runs":{"post":{"operationId":"create","summary":"Create","description":"Trigger a Test Suite and create a new Test Suite Run","tags":["subpackage_testSuiteRuns"],"parameters":[{"name":"X-API-KEY","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"schema":{"type":"string"}}],"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TestSuiteRunRead"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TestSuiteRunCreateRequest"}}}}}},"/v1/test-suite-runs/{id}":{"get":{"operationId":"retrieve","summary":"Retrieve","description":"Retrieve a specific Test Suite Run by ID","tags":["subpackage_testSuiteRuns"],"parameters":[{"name":"id","in":"path","description":"A UUID string identifying this test suite run.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"X-API-KEY","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TestSuiteRunRead"}}}}}}},"/v1/test-suite-runs/{id}/executions":{"get":{"operationId":"list-executions","summary":"List Executions","tags":["subpackage_testSuiteRuns"],"parameters":[{"name":"id","in":"path","description":"A UUID string identifying this test suite run.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"expand","in":"query","description":"The response fields to expand for more information.\n- 'metric_results.metric_label' expands the metric label for each metric result.\n- 'metric_results.metric_definition' expands the metric definition for each metric result.\n- 'metric_results.metric_definition.name' expands the metric definition name for each metric result.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"limit","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer"}},{"name":"offset","in":"query","description":"The initial index from which to return the results.","required":false,"schema":{"type":"integer"}},{"name":"X-API-KEY","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedTestSuiteRunExecutionList"}}}}}}},"/v1/folders/{folder_id}/add-entity":{"post":{"operationId":"add-entity-to-folder","summary":"Add Entity To Folder","description":"Add an entity to a specific folder or root directory.\n\nAdding an entity to a folder will remove it from any other folders it might have been a member of.","tags":["subpackage_folderEntities"],"parameters":[{"name":"folder_id","in":"path","description":"The ID of the folder to which the entity should be added. This can be a UUID of a folder, or the name of a root\ndirectory. Supported root directories include:\n- PROMPT_SANDBOX\n- WORKFLOW_SANDBOX\n- DOCUMENT_INDEX\n- TEST_SUITE","required":true,"schema":{"type":"string"}},{"name":"X-API-KEY","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"No response body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/folder-entities_add_entity_to_folder_Response_200"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddEntityToFolderRequest"}}}}}},"/v1/folder-entities":{"get":{"operationId":"list","summary":"List","description":"List all folder entities within a specified folder.","tags":["subpackage_folderEntities"],"parameters":[{"name":"entity_status","in":"query","description":"Filter down to only those objects whose entities have a status matching the status specified.\n\n* `ACTIVE` - Active\n* `ARCHIVED` - Archived\n* `PENDING_DELETION` - Pending Deletion","required":false,"schema":{"$ref":"#/components/schemas/V1FolderEntitiesGetParametersEntityStatus"}},{"name":"limit","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer"}},{"name":"offset","in":"query","description":"The initial index from which to return the results.","required":false,"schema":{"type":"integer"}},{"name":"ordering","in":"query","description":"Which field to use when ordering the results.","required":false,"schema":{"type":"string"}},{"name":"parent_folder_id","in":"query","description":"Filter down to only those entities whose parent folder has the specified ID.\n\nTo filter by an entity's parent folder, provide the ID of the parent folder. To filter by the root directory, provide\na string representing the entity type of the root directory. Supported root directories include:\n- PROMPT_SANDBOX\n- WORKFLOW_SANDBOX\n- DOCUMENT_INDEX\n- TEST_SUITE","required":true,"schema":{"type":"string"}},{"name":"X-API-KEY","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedFolderEntityList"}}}}}}},"/v1/workspace-secrets/{id}":{"get":{"operationId":"retrieve","summary":"Retrieve","description":"Used to retrieve a Workspace Secret given its ID or name.","tags":["subpackage_workspaceSecrets"],"parameters":[{"name":"id","in":"path","description":"Either the Workspace Secret's ID or its unique name","required":true,"schema":{"type":"string"}},{"name":"X-API-KEY","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceSecretRead"}}}}}},"patch":{"operationId":"partial-update","summary":"Partial Update","description":"Used to update a Workspace Secret given its ID or name.","tags":["subpackage_workspaceSecrets"],"parameters":[{"name":"id","in":"path","description":"Either the Workspace Secret's ID or its unique name","required":true,"schema":{"type":"string"}},{"name":"X-API-KEY","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-API-Version","in":"header","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceSecretRead"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchedWorkspaceSecretUpdateRequest"}}}}}}},"servers":[{"url":"https://predict.vellum.ai"},{"url":"https://api.vellum.ai"},{"url":"https://documents.vellum.ai"}],"components":{"schemas":{"StringEnum":{"type":"string","enum":["STRING"],"title":"StringEnum"},"StringInputRequest":{"type":"object","properties":{"name":{"type":"string","description":"The variable's name"},"type":{"$ref":"#/components/schemas/StringEnum"},"value":{"type":"string"}},"required":["name","type","value"],"description":"A user input representing a string value","title":"StringInputRequest"},"JsonEnum":{"type":"string","enum":["JSON"],"title":"JsonEnum"},"JSONInputRequest":{"type":"object","properties":{"name":{"type":"string","description":"The variable's name"},"type":{"$ref":"#/components/schemas/JsonEnum"},"value":{"oneOf":[{"description":"Any type"},{"type":"null"}]}},"required":["name","type","value"],"description":"A user input representing a JSON object","title":"JSONInputRequest"},"ChatHistoryEnum":{"type":"string","enum":["CHAT_HISTORY"],"title":"ChatHistoryEnum"},"ChatMessageRole":{"type":"string","enum":["SYSTEM","ASSISTANT","USER","FUNCTION"],"description":"* `SYSTEM` - System\n* `ASSISTANT` - Assistant\n* `USER` - User\n* `FUNCTION` - Function","title":"ChatMessageRole"},"StringChatMessageContentRequest":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/StringEnum"},"value":{"type":"string"}},"required":["type","value"],"description":"A string value that is used in a chat message.","title":"StringChatMessageContentRequest"},"FunctionCallEnum":{"type":"string","enum":["FUNCTION_CALL"],"title":"FunctionCallEnum"},"FunctionCallChatMessageContentValueRequest":{"type":"object","properties":{"name":{"type":"string"},"arguments":{"type":"object","additionalProperties":{"description":"Any type"}},"id":{"type":["string","null"]}},"required":["name","arguments"],"description":"The final resolved function call value.","title":"FunctionCallChatMessageContentValueRequest"},"FunctionCallChatMessageContentRequest":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/FunctionCallEnum"},"value":{"$ref":"#/components/schemas/FunctionCallChatMessageContentValueRequest"}},"required":["type","value"],"description":"A function call value that is used in a chat message.","title":"FunctionCallChatMessageContentRequest"},"ArrayEnum":{"type":"string","enum":["ARRAY"],"title":"ArrayEnum"},"AudioEnum":{"type":"string","enum":["AUDIO"],"title":"AudioEnum"},"VellumAudioRequest":{"type":"object","properties":{"src":{"type":"string","description":"The reference to the source data. This can be one of the following formats:\n1. A base64-encoded data URL (e.g., 'data:application/pdf;base64,JVBERi0xLjQKJcfs...').\n2. A url pointing to a file accessible over HTTP or HTTPS.\n3. A reference to a file that's been previously uploaded to Vellum, in the form of 'vellum:uploaded-file:{uploaded_file_id}'.\n    You can use the Uploaded Files API to retrieve the url of the uploaded file given its ID. See https://docs.vellum.ai/developers/client-sdk/uploaded-files/retrieve for details."},"metadata":{"type":["object","null"],"additionalProperties":{"description":"Any type"}}},"required":["src"],"title":"VellumAudioRequest"},"AudioChatMessageContentRequest":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/AudioEnum"},"value":{"$ref":"#/components/schemas/VellumAudioRequest"}},"required":["type","value"],"description":"An audio value that is used in a chat message.","title":"AudioChatMessageContentRequest"},"VideoEnum":{"type":"string","enum":["VIDEO"],"title":"VideoEnum"},"VellumVideoRequest":{"type":"object","properties":{"src":{"type":"string","description":"The reference to the source data. This can be one of the following formats:\n1. A base64-encoded data URL (e.g., 'data:application/pdf;base64,JVBERi0xLjQKJcfs...').\n2. A url pointing to a file accessible over HTTP or HTTPS.\n3. A reference to a file that's been previously uploaded to Vellum, in the form of 'vellum:uploaded-file:{uploaded_file_id}'.\n    You can use the Uploaded Files API to retrieve the url of the uploaded file given its ID. See https://docs.vellum.ai/developers/client-sdk/uploaded-files/retrieve for details."},"metadata":{"type":["object","null"],"additionalProperties":{"description":"Any type"}}},"required":["src"],"title":"VellumVideoRequest"},"VideoChatMessageContentRequest":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/VideoEnum"},"value":{"$ref":"#/components/schemas/VellumVideoRequest"}},"required":["type","value"],"description":"A video value that is used in a chat message.","title":"VideoChatMessageContentRequest"},"ImageEnum":{"type":"string","enum":["IMAGE"],"title":"ImageEnum"},"VellumImageRequest":{"type":"object","properties":{"src":{"type":"string","description":"The reference to the source data. This can be one of the following formats:\n1. A base64-encoded data URL (e.g., 'data:application/pdf;base64,JVBERi0xLjQKJcfs...').\n2. A url pointing to a file accessible over HTTP or HTTPS.\n3. A reference to a file that's been previously uploaded to Vellum, in the form of 'vellum:uploaded-file:{uploaded_file_id}'.\n    You can use the Uploaded Files API to retrieve the url of the uploaded file given its ID. See https://docs.vellum.ai/developers/client-sdk/uploaded-files/retrieve for details."},"metadata":{"type":["object","null"],"additionalProperties":{"description":"Any type"}}},"required":["src"],"title":"VellumImageRequest"},"ImageChatMessageContentRequest":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/ImageEnum"},"value":{"$ref":"#/components/schemas/VellumImageRequest"}},"required":["type","value"],"description":"An image value that is used in a chat message.","title":"ImageChatMessageContentRequest"},"DocumentEnum":{"type":"string","enum":["DOCUMENT"],"title":"DocumentEnum"},"VellumDocumentRequest":{"type":"object","properties":{"src":{"type":"string","description":"The reference to the source data. This can be one of the following formats:\n1. A base64-encoded data URL (e.g., 'data:application/pdf;base64,JVBERi0xLjQKJcfs...').\n2. A url pointing to a file accessible over HTTP or HTTPS.\n3. A reference to a file that's been previously uploaded to Vellum, in the form of 'vellum:uploaded-file:{uploaded_file_id}'.\n    You can use the Uploaded Files API to retrieve the url of the uploaded file given its ID. See https://docs.vellum.ai/developers/client-sdk/uploaded-files/retrieve for details."},"metadata":{"type":["object","null"],"additionalProperties":{"description":"Any type"}}},"required":["src"],"title":"VellumDocumentRequest"},"DocumentChatMessageContentRequest":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/DocumentEnum"},"value":{"$ref":"#/components/schemas/VellumDocumentRequest"}},"required":["type","value"],"description":"A document value that is used in a chat message.","title":"DocumentChatMessageContentRequest"},"ArrayChatMessageContentItemRequest":{"oneOf":[{"$ref":"#/components/schemas/StringChatMessageContentRequest"},{"$ref":"#/components/schemas/FunctionCallChatMessageContentRequest"},{"$ref":"#/components/schemas/AudioChatMessageContentRequest"},{"$ref":"#/components/schemas/VideoChatMessageContentRequest"},{"$ref":"#/components/schemas/ImageChatMessageContentRequest"},{"$ref":"#/components/schemas/DocumentChatMessageContentRequest"}],"title":"ArrayChatMessageContentItemRequest"},"ArrayChatMessageContentRequest":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/ArrayEnum"},"value":{"type":"array","items":{"$ref":"#/components/schemas/ArrayChatMessageContentItemRequest"}}},"required":["type","value"],"description":"A list of chat message content items.","title":"ArrayChatMessageContentRequest"},"ChatMessageContentRequest":{"oneOf":[{"$ref":"#/components/schemas/StringChatMessageContentRequest"},{"$ref":"#/components/schemas/FunctionCallChatMessageContentRequest"},{"$ref":"#/components/schemas/ArrayChatMessageContentRequest"},{"$ref":"#/components/schemas/AudioChatMessageContentRequest"},{"$ref":"#/components/schemas/VideoChatMessageContentRequest"},{"$ref":"#/components/schemas/ImageChatMessageContentRequest"},{"$ref":"#/components/schemas/DocumentChatMessageContentRequest"}],"title":"ChatMessageContentRequest"},"ChatMessageRequest":{"type":"object","properties":{"text":{"type":["string","null"]},"role":{"$ref":"#/components/schemas/ChatMessageRole"},"content":{"oneOf":[{"$ref":"#/components/schemas/ChatMessageContentRequest"},{"type":"null"}]},"source":{"type":["string","null"],"description":"An optional identifier representing who or what generated this message."},"metadata":{"type":["object","null"],"additionalProperties":{"description":"Any type"}}},"required":["role"],"title":"ChatMessageRequest"},"ChatHistoryInputRequest":{"type":"object","properties":{"name":{"type":"string","description":"The variable's name, as defined in the deployment."},"type":{"$ref":"#/components/schemas/ChatHistoryEnum"},"value":{"type":"array","items":{"$ref":"#/components/schemas/ChatMessageRequest"}}},"required":["name","type","value"],"description":"A user input representing a list of chat messages","title":"ChatHistoryInputRequest"},"AudioInputRequest":{"type":"object","properties":{"name":{"type":"string","description":"The variable's name"},"type":{"$ref":"#/components/schemas/AudioEnum"},"value":{"$ref":"#/components/schemas/VellumAudioRequest"}},"required":["name","type","value"],"description":"A user input representing a Vellum Audio value","title":"AudioInputRequest"},"VideoInputRequest":{"type":"object","properties":{"name":{"type":"string","description":"The variable's name"},"type":{"$ref":"#/components/schemas/VideoEnum"},"value":{"$ref":"#/components/schemas/VellumVideoRequest"}},"required":["name","type","value"],"description":"A user input representing a Vellum Video value","title":"VideoInputRequest"},"ImageInputRequest":{"type":"object","properties":{"name":{"type":"string","description":"The variable's name"},"type":{"$ref":"#/components/schemas/ImageEnum"},"value":{"$ref":"#/components/schemas/VellumImageRequest"}},"required":["name","type","value"],"description":"A user input representing a Vellum Image value","title":"ImageInputRequest"},"DocumentInputRequest":{"type":"object","properties":{"name":{"type":"string","description":"The variable's name"},"type":{"$ref":"#/components/schemas/DocumentEnum"},"value":{"$ref":"#/components/schemas/VellumDocumentRequest"}},"required":["name","type","value"],"description":"A user input representing a Vellum Document value","title":"DocumentInputRequest"},"PromptDeploymentInputRequest":{"oneOf":[{"$ref":"#/components/schemas/StringInputRequest"},{"$ref":"#/components/schemas/JSONInputRequest"},{"$ref":"#/components/schemas/ChatHistoryInputRequest"},{"$ref":"#/components/schemas/AudioInputRequest"},{"$ref":"#/components/schemas/VideoInputRequest"},{"$ref":"#/components/schemas/ImageInputRequest"},{"$ref":"#/components/schemas/DocumentInputRequest"}],"title":"PromptDeploymentInputRequest"},"PromptDeploymentExpandMetaRequest":{"type":"object","properties":{"model_name":{"type":["boolean","null"],"description":"If enabled, the response will include the model identifier representing the ML Model invoked by the Prompt."},"usage":{"type":["boolean","null"],"description":"If enabled, the response will include model host usage tracking. This may increase latency for some model hosts."},"cost":{"type":["boolean","null"],"description":"If enabled, the response will include model host cost tracking. This may increase latency for some model hosts."},"finish_reason":{"type":["boolean","null"],"description":"If enabled, the response will include the reason provided by the model for why the execution finished."},"latency":{"type":["boolean","null"],"description":"If enabled, the response will include the time in nanoseconds it took to execute the Prompt Deployment."},"deployment_release_tag":{"type":["boolean","null"],"description":"If enabled, the response will include the release tag of the Prompt Deployment."},"prompt_version_id":{"type":["boolean","null"],"description":"If enabled, the response will include the ID of the Prompt Version backing the deployment."}},"title":"PromptDeploymentExpandMetaRequest"},"RawPromptExecutionOverridesRequest":{"type":"object","properties":{"body":{"type":["object","null"],"additionalProperties":{"description":"Any type"}},"headers":{"type":["object","null"],"additionalProperties":{"type":"string"},"description":"The raw headers to send to the model host."},"url":{"type":["string","null"],"description":"The raw URL to send to the model host."}},"title":"RawPromptExecutionOverridesRequest"},"ExecutePromptRequest":{"type":"object","properties":{"inputs":{"type":"array","items":{"$ref":"#/components/schemas/PromptDeploymentInputRequest"},"description":"A list consisting of the Prompt Deployment's input variables and their values."},"prompt_deployment_id":{"type":["string","null"],"format":"uuid","description":"The ID of the Prompt Deployment. Must provide either this or prompt_deployment_name."},"prompt_deployment_name":{"type":["string","null"],"description":"The unique name of the Prompt Deployment. Must provide either this or prompt_deployment_id."},"release_tag":{"type":["string","null"],"description":"Optionally specify a release tag if you want to pin to a specific release of the Prompt Deployment"},"external_id":{"type":["string","null"],"description":"Optionally include a unique identifier for tracking purposes. Must be unique within a given Workspace."},"expand_meta":{"oneOf":[{"$ref":"#/components/schemas/PromptDeploymentExpandMetaRequest"},{"type":"null"}],"description":"An optionally specified configuration used to opt in to including additional metadata about this prompt execution in the API response. Corresponding values will be returned under the `meta` key of the API response."},"raw_overrides":{"oneOf":[{"$ref":"#/components/schemas/RawPromptExecutionOverridesRequest"},{"type":"null"}],"description":"Overrides for the raw API request sent to the model host. Combined with `expand_raw`, it can be used to access new features from models."},"expand_raw":{"type":["array","null"],"items":{"type":"string"},"description":"A list of keys whose values you'd like to directly return from the JSON response of the model provider. Useful if you need lower-level info returned by model providers that Vellum would otherwise omit. Corresponding key/value pairs will be returned under the `raw` key of the API response."},"metadata":{"type":["object","null"],"additionalProperties":{"description":"Any type"},"description":"Arbitrary JSON metadata associated with this request. Can be used to capture additional monitoring data such as user id, session id, etc. for future analysis."}},"required":["inputs"],"title":"ExecutePromptRequest"},"FinishReasonEnum":{"type":"string","enum":["LENGTH","STOP","UNKNOWN"],"description":"* `LENGTH` - LENGTH\n* `STOP` - STOP\n* `UNKNOWN` - UNKNOWN","title":"FinishReasonEnum"},"MLModelUsage":{"type":"object","properties":{"output_token_count":{"type":["integer","null"]},"input_token_count":{"type":["integer","null"]},"input_char_count":{"type":["integer","null"]},"output_char_count":{"type":["integer","null"]},"compute_nanos":{"type":["integer","null"]},"cache_creation_input_tokens":{"type":["integer","null"]},"cache_read_input_tokens":{"type":["integer","null"]}},"title":"MLModelUsage"},"UnitEnum":{"type":"string","enum":["USD"],"description":"* `USD` - USD","title":"UnitEnum"},"Price":{"type":"object","properties":{"value":{"type":"number","format":"double"},"unit":{"$ref":"#/components/schemas/UnitEnum"}},"required":["value","unit"],"title":"Price"},"PromptExecutionMeta":{"type":"object","properties":{"model_name":{"type":["string","null"]},"latency":{"type":["integer","null"]},"deployment_release_tag":{"type":["string","null"]},"prompt_version_id":{"type":["string","null"]},"finish_reason":{"oneOf":[{"$ref":"#/components/schemas/FinishReasonEnum"},{"type":"null"}]},"usage":{"oneOf":[{"$ref":"#/components/schemas/MLModelUsage"},{"type":"null"}]},"cost":{"oneOf":[{"$ref":"#/components/schemas/Price"},{"type":"null"}]}},"description":"The subset of the metadata tracked by Vellum during prompt execution that the request opted into with `expand_meta`.","title":"PromptExecutionMeta"},"FulfilledEnum":{"type":"string","enum":["FULFILLED"],"title":"FulfilledEnum"},"StringVellumValue":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/StringEnum"},"value":{"type":["string","null"]}},"required":["type","value"],"description":"A value representing a string.","title":"StringVellumValue"},"JsonVellumValue":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/JsonEnum"},"value":{"oneOf":[{"description":"Any type"},{"type":"null"}]}},"required":["type","value"],"description":"A value representing a JSON object.","title":"JsonVellumValue"},"ErrorEnum":{"type":"string","enum":["ERROR"],"title":"ErrorEnum"},"VellumErrorCodeEnum":{"type":"string","enum":["INVALID_REQUEST","INVALID_INPUTS","PROVIDER_ERROR","PROVIDER_CREDENTIALS_UNAVAILABLE","INTEGRATION_CREDENTIALS_UNAVAILABLE","REQUEST_TIMEOUT","INTERNAL_SERVER_ERROR","USER_DEFINED_ERROR","WORKFLOW_CANCELLED","NODE_CANCELLED","PROVIDER_QUOTA_EXCEEDED","CHAT_QUOTA_EXCEEDED"],"description":"* `INVALID_REQUEST` - INVALID_REQUEST\n* `INVALID_INPUTS` - INVALID_INPUTS\n* `PROVIDER_ERROR` - PROVIDER_ERROR\n* `PROVIDER_CREDENTIALS_UNAVAILABLE` - PROVIDER_CREDENTIALS_UNAVAILABLE\n* `INTEGRATION_CREDENTIALS_UNAVAILABLE` - INTEGRATION_CREDENTIALS_UNAVAILABLE\n* `REQUEST_TIMEOUT` - REQUEST_TIMEOUT\n* `INTERNAL_SERVER_ERROR` - INTERNAL_SERVER_ERROR\n* `USER_DEFINED_ERROR` - USER_DEFINED_ERROR\n* `WORKFLOW_CANCELLED` - WORKFLOW_CANCELLED\n* `NODE_CANCELLED` - NODE_CANCELLED\n* `PROVIDER_QUOTA_EXCEEDED` - PROVIDER_QUOTA_EXCEEDED\n* `CHAT_QUOTA_EXCEEDED` - CHAT_QUOTA_EXCEEDED","title":"VellumErrorCodeEnum"},"VellumError":{"type":"object","properties":{"code":{"$ref":"#/components/schemas/VellumErrorCodeEnum"},"message":{"type":"string"},"raw_data":{"type":["object","null"],"additionalProperties":{"description":"Any type"}}},"required":["code","message"],"title":"VellumError"},"ErrorVellumValue":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/ErrorEnum"},"value":{"oneOf":[{"$ref":"#/components/schemas/VellumError"},{"type":"null"}]}},"required":["type","value"],"description":"A value representing an Error.","title":"ErrorVellumValue"},"FunctionCall":{"type":"object","properties":{"arguments":{"type":"object","additionalProperties":{"description":"Any type"}},"id":{"type":["string","null"]},"name":{"type":"string"}},"required":["arguments","name"],"description":"The final resolved function call value.","title":"FunctionCall"},"FunctionCallVellumValue":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/FunctionCallEnum"},"value":{"oneOf":[{"$ref":"#/components/schemas/FunctionCall"},{"type":"null"}]}},"required":["type","value"],"description":"A value representing a Function Call.","title":"FunctionCallVellumValue"},"ThinkingEnum":{"type":"string","enum":["THINKING"],"title":"ThinkingEnum"},"ThinkingVellumValue":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/ThinkingEnum"},"value":{"oneOf":[{"$ref":"#/components/schemas/StringVellumValue"},{"type":"null"}]}},"required":["type","value"],"description":"A value representing Thinking mode output.","title":"ThinkingVellumValue"},"PromptOutput":{"oneOf":[{"$ref":"#/components/schemas/StringVellumValue"},{"$ref":"#/components/schemas/JsonVellumValue"},{"$ref":"#/components/schemas/ErrorVellumValue"},{"$ref":"#/components/schemas/FunctionCallVellumValue"},{"$ref":"#/components/schemas/ThinkingVellumValue"}],"title":"PromptOutput"},"FulfilledExecutePromptResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/PromptExecutionMeta"},"raw":{"type":"object","additionalProperties":{"description":"Any type"},"description":"The subset of the raw response from the model that the request opted into with `expand_raw`."},"execution_id":{"type":"string","description":"The ID of the execution."},"state":{"$ref":"#/components/schemas/FulfilledEnum"},"outputs":{"type":"array","items":{"$ref":"#/components/schemas/PromptOutput"}},"chat_message_metadata":{"type":["object","null"],"additionalProperties":{"description":"Any type"}}},"required":["execution_id","state","outputs"],"description":"The successful response from the model containing all of the resolved values generated by the prompt.","title":"FulfilledExecutePromptResponse"},"RejectedEnum":{"type":"string","enum":["REJECTED"],"title":"RejectedEnum"},"RejectedExecutePromptResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/PromptExecutionMeta"},"raw":{"type":"object","additionalProperties":{"description":"Any type"},"description":"The subset of the raw response from the model that the request opted into with `expand_raw`."},"execution_id":{"type":"string","description":"The ID of the execution."},"state":{"$ref":"#/components/schemas/RejectedEnum"},"error":{"$ref":"#/components/schemas/VellumError"}},"required":["execution_id","state","error"],"description":"The unsuccessful response from the model containing an error of what went wrong.","title":"RejectedExecutePromptResponse"},"ExecutePromptResponse":{"oneOf":[{"$ref":"#/components/schemas/FulfilledExecutePromptResponse"},{"$ref":"#/components/schemas/RejectedExecutePromptResponse"}],"title":"ExecutePromptResponse"},"ExecutePromptApiErrorResponse":{"type":"object","properties":{"detail":{"type":"string","description":"Details about why the request failed."},"raw_data":{"type":["object","null"],"additionalProperties":{"description":"Any type"},"description":"The raw error data structure, if available."}},"required":["detail"],"title":"ExecutePromptApiErrorResponse"},"ExecutePromptStreamRequest":{"type":"object","properties":{"inputs":{"type":"array","items":{"$ref":"#/components/schemas/PromptDeploymentInputRequest"},"description":"A list consisting of the Prompt Deployment's input variables and their values."},"prompt_deployment_id":{"type":["string","null"],"format":"uuid","description":"The ID of the Prompt Deployment. Must provide either this or prompt_deployment_name."},"prompt_deployment_name":{"type":["string","null"],"description":"The unique name of the Prompt Deployment. Must provide either this or prompt_deployment_id."},"release_tag":{"type":["string","null"],"description":"Optionally specify a release tag if you want to pin to a specific release of the Prompt Deployment"},"external_id":{"type":["string","null"],"description":"Optionally include a unique identifier for tracking purposes. Must be unique within a given Workspace."},"expand_meta":{"oneOf":[{"$ref":"#/components/schemas/PromptDeploymentExpandMetaRequest"},{"type":"null"}],"description":"An optionally specified configuration used to opt in to including additional metadata about this prompt execution in the API response. Corresponding values will be returned under the `meta` key of the API response."},"raw_overrides":{"oneOf":[{"$ref":"#/components/schemas/RawPromptExecutionOverridesRequest"},{"type":"null"}],"description":"Overrides for the raw API request sent to the model host. Combined with `expand_raw`, it can be used to access new features from models."},"expand_raw":{"type":["array","null"],"items":{"type":"string"},"description":"A list of keys whose values you'd like to directly return from the JSON response of the model provider. Useful if you need lower-level info returned by model providers that Vellum would otherwise omit. Corresponding key/value pairs will be returned under the `raw` key of the API response."},"metadata":{"type":["object","null"],"additionalProperties":{"description":"Any type"},"description":"Arbitrary JSON metadata associated with this request. Can be used to capture additional monitoring data such as user id, session id, etc. for future analysis."}},"required":["inputs"],"title":"ExecutePromptStreamRequest"},"InitiatedEnum":{"type":"string","enum":["INITIATED"],"title":"InitiatedEnum"},"InitiatedPromptExecutionMeta":{"type":"object","properties":{"model_name":{"type":["string","null"]},"latency":{"type":["integer","null"]},"deployment_release_tag":{"type":["string","null"]},"prompt_version_id":{"type":["string","null"]}},"description":"The subset of the metadata tracked by Vellum during prompt execution that the request opted into with `expand_meta`.","title":"InitiatedPromptExecutionMeta"},"InitiatedExecutePromptEvent":{"type":"object","properties":{"state":{"$ref":"#/components/schemas/InitiatedEnum"},"meta":{"$ref":"#/components/schemas/InitiatedPromptExecutionMeta"},"execution_id":{"type":"string"}},"required":["state","execution_id"],"description":"The initial data returned indicating that the response from the model has returned and begun streaming.","title":"InitiatedExecutePromptEvent"},"StreamingEnum":{"type":"string","enum":["STREAMING"],"title":"StreamingEnum"},"StreamingPromptExecutionMeta":{"type":"object","properties":{"latency":{"type":["integer","null"]}},"description":"The subset of the metadata tracked by Vellum during prompt execution that the request opted into with `expand_meta`.","title":"StreamingPromptExecutionMeta"},"StreamingExecutePromptEvent":{"type":"object","properties":{"state":{"$ref":"#/components/schemas/StreamingEnum"},"output":{"$ref":"#/components/schemas/PromptOutput"},"output_index":{"type":"integer"},"execution_id":{"type":"string"},"meta":{"$ref":"#/components/schemas/StreamingPromptExecutionMeta"},"raw":{"type":"object","additionalProperties":{"description":"Any type"},"description":"The subset of the raw response from the model that the request opted into with `expand_raw`."}},"required":["state","output","output_index","execution_id"],"description":"The data returned for each delta during the prompt execution stream.","title":"StreamingExecutePromptEvent"},"FulfilledPromptExecutionMeta":{"type":"object","properties":{"latency":{"type":["integer","null"]},"finish_reason":{"oneOf":[{"$ref":"#/components/schemas/FinishReasonEnum"},{"type":"null"}]},"usage":{"oneOf":[{"$ref":"#/components/schemas/MLModelUsage"},{"type":"null"}]},"cost":{"oneOf":[{"$ref":"#/components/schemas/Price"},{"type":"null"}]}},"description":"The subset of the metadata tracked by Vellum during prompt execution that the request opted into with `expand_meta`.","title":"FulfilledPromptExecutionMeta"},"FulfilledExecutePromptEvent":{"type":"object","properties":{"state":{"$ref":"#/components/schemas/FulfilledEnum"},"outputs":{"type":"array","items":{"$ref":"#/components/schemas/PromptOutput"}},"execution_id":{"type":"string"},"meta":{"$ref":"#/components/schemas/FulfilledPromptExecutionMeta"},"chat_message_metadata":{"type":["object","null"],"additionalProperties":{"description":"Any type"}}},"required":["state","outputs","execution_id"],"description":"The final data event returned indicating that the stream has ended and all final resolved values from the model can be found.","title":"FulfilledExecutePromptEvent"},"RejectedPromptExecutionMeta":{"type":"object","properties":{"latency":{"type":["integer","null"]},"finish_reason":{"oneOf":[{"$ref":"#/components/schemas/FinishReasonEnum"},{"type":"null"}]}},"description":"The subset of the metadata tracked by Vellum during prompt execution that the request opted into with `expand_meta`.","title":"RejectedPromptExecutionMeta"},"RejectedExecutePromptEvent":{"type":"object","properties":{"state":{"$ref":"#/components/schemas/RejectedEnum"},"error":{"$ref":"#/components/schemas/VellumError"},"execution_id":{"type":"string"},"meta":{"$ref":"#/components/schemas/RejectedPromptExecutionMeta"}},"required":["state","error","execution_id"],"description":"The final data returned indicating an error occurred during the stream.","title":"RejectedExecutePromptEvent"},"ExecutePromptEvent":{"oneOf":[{"$ref":"#/components/schemas/InitiatedExecutePromptEvent"},{"$ref":"#/components/schemas/StreamingExecutePromptEvent"},{"$ref":"#/components/schemas/FulfilledExecutePromptEvent"},{"$ref":"#/components/schemas/RejectedExecutePromptEvent"}],"title":"ExecutePromptEvent"},"SubmitCompletionActualRequest":{"type":"object","properties":{"id":{"type":["string","null"],"description":"The Vellum-generated ID of a previously generated completion. Must provide either this or external_id."},"external_id":{"type":["string","null"],"description":"The external ID that was originally provided when generating the completion that you'd now like to submit actuals for. Must provide either this or id."},"text":{"type":["string","null"],"description":"Text representing what the completion _should_ have been."},"quality":{"type":["number","null"],"format":"double","description":"A number between 0 and 1 representing the quality of the completion. 0 is the worst, 1 is the best."},"timestamp":{"type":["string","null"],"format":"date-time","description":"Optionally provide the timestamp representing when this feedback was collected. Used for reporting purposes."},"metadata":{"type":["object","null"],"additionalProperties":{"description":"Any type"},"description":"Optionally provide additional metadata about the feedback submission."}},"title":"SubmitCompletionActualRequest"},"SubmitCompletionActualsRequest":{"type":"object","properties":{"deployment_id":{"type":["string","null"],"format":"uuid","description":"The ID of the deployment. Must provide either this or deployment_name."},"deployment_name":{"type":["string","null"],"description":"The name of the deployment. Must provide either this or deployment_id."},"actuals":{"type":"array","items":{"$ref":"#/components/schemas/SubmitCompletionActualRequest"},"description":"Feedback regarding the quality of previously generated completions"}},"required":["actuals"],"title":"SubmitCompletionActualsRequest"},"submit-completion-actuals_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"submit-completion-actuals_Response_200"},"SubmitCompletionActualsErrorResponse":{"type":"object","properties":{"detail":{"type":"string"}},"required":["detail"],"title":"SubmitCompletionActualsErrorResponse"},"CompilePromptDeploymentExpandMetaRequest":{"type":"object","properties":{"model_name":{"type":["boolean","null"],"description":"If enabled, the response will include the model identifier representing the ML Model invoked by the Prompt."},"deployment_release_tag":{"type":["boolean","null"],"description":"If enabled, the response will include the release tag of the Prompt Deployment."},"prompt_version_id":{"type":["boolean","null"],"description":"If enabled, the response will include the ID of the Prompt Version backing the deployment."}},"title":"CompilePromptDeploymentExpandMetaRequest"},"DeploymentProviderPayloadRequest":{"type":"object","properties":{"deployment_id":{"type":["string","null"],"format":"uuid","description":"The ID of the deployment. Must provide either this or deployment_name."},"deployment_name":{"type":["string","null"],"description":"The name of the deployment. Must provide either this or deployment_id."},"inputs":{"type":"array","items":{"$ref":"#/components/schemas/PromptDeploymentInputRequest"},"description":"The list of inputs defined in the Prompt's deployment with their corresponding values."},"release_tag":{"type":["string","null"],"description":"Optionally specify a release tag if you want to pin to a specific release of the Workflow Deployment"},"expand_meta":{"oneOf":[{"$ref":"#/components/schemas/CompilePromptDeploymentExpandMetaRequest"},{"type":"null"}]}},"required":["inputs"],"title":"DeploymentProviderPayloadRequest"},"DeploymentProviderPayloadResponsePayload":{"oneOf":[{"type":"object","additionalProperties":{"description":"Any type"}},{"type":"string"}],"title":"DeploymentProviderPayloadResponsePayload"},"CompilePromptMeta":{"type":"object","properties":{"model_name":{"type":["string","null"]},"deployment_release_tag":{"type":["string","null"]},"prompt_version_id":{"type":["string","null"]}},"description":"The subset of the metadata tracked by Vellum during Prompt Deployment compilation that the request opted into with `expand_meta`.","title":"CompilePromptMeta"},"DeploymentProviderPayloadResponse":{"type":"object","properties":{"payload":{"$ref":"#/components/schemas/DeploymentProviderPayloadResponsePayload"},"meta":{"oneOf":[{"$ref":"#/components/schemas/CompilePromptMeta"},{"type":"null"}]}},"required":["payload","meta"],"title":"DeploymentProviderPayloadResponse"},"DeploySandboxPromptRequest":{"type":"object","properties":{"prompt_deployment_id":{"type":["string","null"],"format":"uuid","description":"The Vellum-generated ID of the Prompt Deployment you'd like to update. Cannot specify both this and prompt_deployment_name. Leave null to create a new Prompt Deployment."},"prompt_deployment_name":{"type":["string","null"],"description":"The unique name of the Prompt Deployment you'd like to either create or update. Cannot specify both this and prompt_deployment_id. If provided and matches an existing Prompt Deployment, that Prompt Deployment will be updated. Otherwise, a new Prompt Deployment will be created."},"label":{"type":["string","null"],"description":"In the event that a new Prompt Deployment is created, this will be the label it's given."},"release_tags":{"type":["array","null"],"items":{"type":"string"},"description":"Optionally provide the release tags that you'd like to be associated with the latest release of the created/updated Prompt Deployment."},"release_description":{"type":["string","null"],"default":"","description":"Optionally provide a description that details what's new in this Release."}},"title":"DeploySandboxPromptRequest"},"EntityStatus":{"type":"string","enum":["ACTIVE","ARCHIVED","PENDING_DELETION"],"description":"* `ACTIVE` - Active\n* `ARCHIVED` - Archived\n* `PENDING_DELETION` - Pending Deletion","title":"EntityStatus"},"EnvironmentEnum":{"type":"string","enum":["DEVELOPMENT","STAGING","PRODUCTION"],"title":"EnvironmentEnum"},"VellumVariableType":{"type":"string","enum":["STRING","NUMBER","JSON","CHAT_HISTORY","SEARCH_RESULTS","ERROR","ARRAY","FUNCTION_CALL","AUDIO","VIDEO","IMAGE","DOCUMENT","NULL","THINKING","REFERENCE"],"description":"* `STRING` - STRING\n* `NUMBER` - NUMBER\n* `JSON` - JSON\n* `CHAT_HISTORY` - CHAT_HISTORY\n* `SEARCH_RESULTS` - SEARCH_RESULTS\n* `ERROR` - ERROR\n* `ARRAY` - ARRAY\n\n* `FUNCTION_CALL` - FUNCTION_CALL\n* `AUDIO` - AUDIO\n* `VIDEO` - VIDEO\n* `IMAGE` - IMAGE\n* `DOCUMENT` - DOCUMENT\n* `NULL` - NULL\n* `THINKING` - THINKING\n* `REFERENCE` - REFERENCE","title":"VellumVariableType"},"NumberEnum":{"type":"string","enum":["NUMBER"],"title":"NumberEnum"},"NumberVellumValue":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/NumberEnum"},"value":{"type":["number","null"],"format":"double"}},"required":["type","value"],"description":"A value representing a number.","title":"NumberVellumValue"},"VellumAudio":{"type":"object","properties":{"src":{"type":"string","description":"The reference to the source data. This can be one of the following formats:\n1. A base64-encoded data URL (e.g., 'data:application/pdf;base64,JVBERi0xLjQKJcfs...').\n2. A url pointing to a file accessible over HTTP or HTTPS.\n3. A reference to a file that's been previously uploaded to Vellum, in the form of 'vellum:uploaded-file:{uploaded_file_id}'.\n    You can use the Uploaded Files API to retrieve the url of the uploaded file given its ID. See https://docs.vellum.ai/developers/client-sdk/uploaded-files/retrieve for details."},"metadata":{"type":["object","null"],"additionalProperties":{"description":"Any type"}}},"required":["src"],"title":"VellumAudio"},"AudioVellumValue":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/AudioEnum"},"value":{"oneOf":[{"$ref":"#/components/schemas/VellumAudio"},{"type":"null"}]}},"required":["type","value"],"description":"A base Vellum primitive value representing audio.","title":"AudioVellumValue"},"VellumVideo":{"type":"object","properties":{"src":{"type":"string","description":"The reference to the source data. This can be one of the following formats:\n1. A base64-encoded data URL (e.g., 'data:application/pdf;base64,JVBERi0xLjQKJcfs...').\n2. A url pointing to a file accessible over HTTP or HTTPS.\n3. A reference to a file that's been previously uploaded to Vellum, in the form of 'vellum:uploaded-file:{uploaded_file_id}'.\n    You can use the Uploaded Files API to retrieve the url of the uploaded file given its ID. See https://docs.vellum.ai/developers/client-sdk/uploaded-files/retrieve for details."},"metadata":{"type":["object","null"],"additionalProperties":{"description":"Any type"}}},"required":["src"],"title":"VellumVideo"},"VideoVellumValue":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/VideoEnum"},"value":{"oneOf":[{"$ref":"#/components/schemas/VellumVideo"},{"type":"null"}]}},"required":["type","value"],"description":"A base Vellum primitive value representing a video.","title":"VideoVellumValue"},"VellumImage":{"type":"object","properties":{"src":{"type":"string","description":"The reference to the source data. This can be one of the following formats:\n1. A base64-encoded data URL (e.g., 'data:application/pdf;base64,JVBERi0xLjQKJcfs...').\n2. A url pointing to a file accessible over HTTP or HTTPS.\n3. A reference to a file that's been previously uploaded to Vellum, in the form of 'vellum:uploaded-file:{uploaded_file_id}'.\n    You can use the Uploaded Files API to retrieve the url of the uploaded file given its ID. See https://docs.vellum.ai/developers/client-sdk/uploaded-files/retrieve for details."},"metadata":{"type":["object","null"],"additionalProperties":{"description":"Any type"}}},"required":["src"],"title":"VellumImage"},"ImageVellumValue":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/ImageEnum"},"value":{"oneOf":[{"$ref":"#/components/schemas/VellumImage"},{"type":"null"}]}},"required":["type","value"],"description":"A base Vellum primitive value representing an image.","title":"ImageVellumValue"},"VellumDocument":{"type":"object","properties":{"src":{"type":"string","description":"The reference to the source data. This can be one of the following formats:\n1. A base64-encoded data URL (e.g., 'data:application/pdf;base64,JVBERi0xLjQKJcfs...').\n2. A url pointing to a file accessible over HTTP or HTTPS.\n3. A reference to a file that's been previously uploaded to Vellum, in the form of 'vellum:uploaded-file:{uploaded_file_id}'.\n    You can use the Uploaded Files API to retrieve the url of the uploaded file given its ID. See https://docs.vellum.ai/developers/client-sdk/uploaded-files/retrieve for details."},"metadata":{"type":["object","null"],"additionalProperties":{"description":"Any type"}}},"required":["src"],"title":"VellumDocument"},"DocumentVellumValue":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/DocumentEnum"},"value":{"oneOf":[{"$ref":"#/components/schemas/VellumDocument"},{"type":"null"}]}},"required":["type","value"],"description":"A base Vellum primitive value representing a document.","title":"DocumentVellumValue"},"ArrayVellumValue":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/ArrayEnum"},"value":{"type":["array","null"],"items":{"$ref":"#/components/schemas/VellumValue"}}},"required":["type","value"],"description":"A value representing an array of Vellum variable values.","title":"ArrayVellumValue"},"StringChatMessageContent":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/StringEnum"},"value":{"type":"string"}},"required":["type","value"],"description":"A string value that is used in a chat message.","title":"StringChatMessageContent"},"FunctionCallChatMessageContentValue":{"type":"object","properties":{"name":{"type":"string"},"arguments":{"type":"object","additionalProperties":{"description":"Any type"}},"id":{"type":["string","null"]}},"required":["name","arguments"],"description":"The final resolved function call value.","title":"FunctionCallChatMessageContentValue"},"FunctionCallChatMessageContent":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/FunctionCallEnum"},"value":{"$ref":"#/components/schemas/FunctionCallChatMessageContentValue"}},"required":["type","value"],"description":"A function call value that is used in a chat message.","title":"FunctionCallChatMessageContent"},"AudioChatMessageContent":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/AudioEnum"},"value":{"$ref":"#/components/schemas/VellumAudio"}},"required":["type","value"],"description":"An audio value that is used in a chat message.","title":"AudioChatMessageContent"},"VideoChatMessageContent":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/VideoEnum"},"value":{"$ref":"#/components/schemas/VellumVideo"}},"required":["type","value"],"description":"A video value that is used in a chat message.","title":"VideoChatMessageContent"},"ImageChatMessageContent":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/ImageEnum"},"value":{"$ref":"#/components/schemas/VellumImage"}},"required":["type","value"],"description":"An image value that is used in a chat message.","title":"ImageChatMessageContent"},"DocumentChatMessageContent":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/DocumentEnum"},"value":{"$ref":"#/components/schemas/VellumDocument"}},"required":["type","value"],"description":"A document value that is used in a chat message.","title":"DocumentChatMessageContent"},"ArrayChatMessageContentItem":{"oneOf":[{"$ref":"#/components/schemas/StringChatMessageContent"},{"$ref":"#/components/schemas/FunctionCallChatMessageContent"},{"$ref":"#/components/schemas/AudioChatMessageContent"},{"$ref":"#/components/schemas/VideoChatMessageContent"},{"$ref":"#/components/schemas/ImageChatMessageContent"},{"$ref":"#/components/schemas/DocumentChatMessageContent"}],"title":"ArrayChatMessageContentItem"},"ArrayChatMessageContent":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/ArrayEnum"},"value":{"type":"array","items":{"$ref":"#/components/schemas/ArrayChatMessageContentItem"}}},"required":["type","value"],"description":"A list of chat message content items.","title":"ArrayChatMessageContent"},"ChatMessageContent":{"oneOf":[{"$ref":"#/components/schemas/StringChatMessageContent"},{"$ref":"#/components/schemas/FunctionCallChatMessageContent"},{"$ref":"#/components/schemas/ArrayChatMessageContent"},{"$ref":"#/components/schemas/AudioChatMessageContent"},{"$ref":"#/components/schemas/VideoChatMessageContent"},{"$ref":"#/components/schemas/ImageChatMessageContent"},{"$ref":"#/components/schemas/DocumentChatMessageContent"}],"title":"ChatMessageContent"},"ChatMessage":{"type":"object","properties":{"text":{"type":["string","null"]},"role":{"$ref":"#/components/schemas/ChatMessageRole"},"content":{"oneOf":[{"$ref":"#/components/schemas/ChatMessageContent"},{"type":"null"}]},"source":{"type":["string","null"],"description":"An optional identifier representing who or what generated this message."},"metadata":{"type":["object","null"],"additionalProperties":{"description":"Any type"}}},"required":["role"],"title":"ChatMessage"},"ChatHistoryVellumValue":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/ChatHistoryEnum"},"value":{"type":["array","null"],"items":{"$ref":"#/components/schemas/ChatMessage"}}},"required":["type","value"],"description":"A value representing Chat History.","title":"ChatHistoryVellumValue"},"SearchResultsEnum":{"type":"string","enum":["SEARCH_RESULTS"],"title":"SearchResultsEnum"},"SearchResultDocument":{"type":"object","properties":{"id":{"type":["string","null"],"format":"uuid","description":"The ID of the document."},"label":{"type":"string","description":"The human-readable name for the document."},"external_id":{"type":["string","null"],"description":"The unique ID of the document as represented in an external system and specified when it was originally uploaded."},"metadata":{"type":["object","null"],"additionalProperties":{"description":"Any type"},"description":"A previously supplied JSON object containing metadata that can be filtered on when searching."}},"required":["label"],"title":"SearchResultDocument"},"PdfEnum":{"type":"string","enum":["PDF"],"title":"PdfEnum"},"PdfSearchResultMetaSource":{"type":"object","properties":{"document_type":{"$ref":"#/components/schemas/PdfEnum"},"start_page_num":{"type":["integer","null"],"description":"The 1-indexed page number where the chunk starts in the document. Only available for supported chunking strategies and document types."},"end_page_num":{"type":["integer","null"],"description":"The 1-indexed page number where the chunk ends in the document. Only available for supported chunking strategies and document types."}},"required":["document_type","start_page_num","end_page_num"],"description":"The source of a search result from a PDF document.","title":"PdfSearchResultMetaSource"},"SearchResultMetaSource":{"oneOf":[{"$ref":"#/components/schemas/PdfSearchResultMetaSource"}],"title":"SearchResultMetaSource"},"SearchResultMeta":{"type":"object","properties":{"source":{"oneOf":[{"$ref":"#/components/schemas/SearchResultMetaSource"},{"type":"null"}]}},"title":"SearchResultMeta"},"SearchResult":{"type":"object","properties":{"text":{"type":"string","description":"The text of the chunk that matched the search query."},"score":{"type":"number","format":"double","description":"A score representing how well the chunk matches the search query."},"keywords":{"type":"array","items":{"type":"string"}},"document":{"$ref":"#/components/schemas/SearchResultDocument","description":"The document that contains the chunk that matched the search query."},"meta":{"oneOf":[{"$ref":"#/components/schemas/SearchResultMeta"},{"type":"null"}],"description":"Additional information about the search result."}},"required":["text","score","keywords","document"],"title":"SearchResult"},"SearchResultsVellumValue":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/SearchResultsEnum"},"value":{"type":["array","null"],"items":{"$ref":"#/components/schemas/SearchResult"}}},"required":["type","value"],"description":"A value representing Search Results.","title":"SearchResultsVellumValue"},"VellumValue":{"oneOf":[{"$ref":"#/components/schemas/StringVellumValue"},{"$ref":"#/components/schemas/NumberVellumValue"},{"$ref":"#/components/schemas/JsonVellumValue"},{"$ref":"#/components/schemas/AudioVellumValue"},{"$ref":"#/components/schemas/VideoVellumValue"},{"$ref":"#/components/schemas/ImageVellumValue"},{"$ref":"#/components/schemas/DocumentVellumValue"},{"$ref":"#/components/schemas/FunctionCallVellumValue"},{"$ref":"#/components/schemas/ErrorVellumValue"},{"$ref":"#/components/schemas/ArrayVellumValue"},{"$ref":"#/components/schemas/ChatHistoryVellumValue"},{"$ref":"#/components/schemas/SearchResultsVellumValue"},{"$ref":"#/components/schemas/ThinkingVellumValue"}],"title":"VellumValue"},"VellumVariableExtensions":{"type":"object","properties":{"color":{"type":["string","null"]},"description":{"type":["string","null"]},"title":{"type":["string","null"]}},"description":"A set of fields with additional properties for use in Vellum Variables.","title":"VellumVariableExtensions"},"VellumVariable":{"type":"object","properties":{"id":{"type":"string"},"key":{"type":"string"},"type":{"$ref":"#/components/schemas/VellumVariableType"},"required":{"type":["boolean","null"]},"default":{"oneOf":[{"$ref":"#/components/schemas/VellumValue"},{"type":"null"}]},"extensions":{"oneOf":[{"$ref":"#/components/schemas/VellumVariableExtensions"},{"type":"null"}]},"schema":{"type":["object","null"],"additionalProperties":{"description":"Any type"}}},"required":["id","key","type"],"title":"VellumVariable"},"DeploymentRead":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"created":{"type":"string","format":"date-time"},"label":{"type":"string","description":"A human-readable label for the deployment"},"name":{"type":"string","description":"A name that uniquely identifies this deployment within its workspace"},"status":{"$ref":"#/components/schemas/EntityStatus","description":"The current status of the deployment\n\n* `ACTIVE` - Active\n* `ARCHIVED` - Archived\n* `PENDING_DELETION` - Pending Deletion"},"environment":{"oneOf":[{"$ref":"#/components/schemas/EnvironmentEnum"},{"type":"null"}],"description":"Deprecated. The value returned will always be 'PRODUCTION'."},"last_deployed_on":{"type":"string","format":"date-time"},"input_variables":{"type":"array","items":{"$ref":"#/components/schemas/VellumVariable"}},"description":{"type":["string","null"],"description":"A human-readable description of the deployment"},"active_model_version_ids":{"type":["array","null"],"items":{"type":"string","format":"uuid"},"description":"Deprecated. This now always returns an empty array."},"last_deployed_history_item_id":{"type":"string","format":"uuid","description":"The ID of the history item associated with this Deployment's LATEST Release Tag"}},"required":["id","created","label","name","last_deployed_on","input_variables","active_model_version_ids","last_deployed_history_item_id"],"description":"A Prompt Deployment's full details.","title":"DeploymentRead"},"NamedScenarioInputStringVariableValueRequest":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/StringEnum"},"value":{"type":["string","null"]},"name":{"type":"string"}},"required":["type","value","name"],"description":"Named Prompt Sandbox Scenario input value that is of type STRING","title":"NamedScenarioInputStringVariableValueRequest"},"NamedScenarioInputJsonVariableValueRequest":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/JsonEnum"},"value":{"oneOf":[{"description":"Any type"},{"type":"null"}]},"name":{"type":"string"}},"required":["type","value","name"],"description":"Named Prompt Sandbox Scenario input value that is of type JSON","title":"NamedScenarioInputJsonVariableValueRequest"},"NamedScenarioInputChatHistoryVariableValueRequest":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/ChatHistoryEnum"},"value":{"type":["array","null"],"items":{"$ref":"#/components/schemas/ChatMessageRequest"}},"name":{"type":"string"}},"required":["type","value","name"],"description":"Named Prompt Sandbox Scenario input value that is of type CHAT_HISTORY","title":"NamedScenarioInputChatHistoryVariableValueRequest"},"NamedScenarioInputAudioVariableValueRequest":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/AudioEnum"},"value":{"$ref":"#/components/schemas/VellumAudioRequest"},"name":{"type":"string"}},"required":["type","value","name"],"title":"NamedScenarioInputAudioVariableValueRequest"},"NamedScenarioInputVideoVariableValueRequest":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/VideoEnum"},"value":{"$ref":"#/components/schemas/VellumVideoRequest"},"name":{"type":"string"}},"required":["type","value","name"],"title":"NamedScenarioInputVideoVariableValueRequest"},"NamedScenarioInputImageVariableValueRequest":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/ImageEnum"},"value":{"$ref":"#/components/schemas/VellumImageRequest"},"name":{"type":"string"}},"required":["type","value","name"],"title":"NamedScenarioInputImageVariableValueRequest"},"NamedScenarioInputDocumentVariableValueRequest":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/DocumentEnum"},"value":{"$ref":"#/components/schemas/VellumDocumentRequest"},"name":{"type":"string"}},"required":["type","value","name"],"title":"NamedScenarioInputDocumentVariableValueRequest"},"NamedScenarioInputRequest":{"oneOf":[{"$ref":"#/components/schemas/NamedScenarioInputStringVariableValueRequest"},{"$ref":"#/components/schemas/NamedScenarioInputJsonVariableValueRequest"},{"$ref":"#/components/schemas/NamedScenarioInputChatHistoryVariableValueRequest"},{"$ref":"#/components/schemas/NamedScenarioInputAudioVariableValueRequest"},{"$ref":"#/components/schemas/NamedScenarioInputVideoVariableValueRequest"},{"$ref":"#/components/schemas/NamedScenarioInputImageVariableValueRequest"},{"$ref":"#/components/schemas/NamedScenarioInputDocumentVariableValueRequest"}],"title":"NamedScenarioInputRequest"},"UpsertSandboxScenarioRequest":{"type":"object","properties":{"label":{"type":"string","default":"Untitled Scenario"},"inputs":{"type":"array","items":{"$ref":"#/components/schemas/NamedScenarioInputRequest"},"description":"The inputs for the scenario"},"scenario_id":{"type":"string","description":"The id of the scenario to update. If none is provided, an id will be generated and a new scenario will be appended."}},"required":["inputs"],"title":"UpsertSandboxScenarioRequest"},"ScenarioInputStringVariableValue":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/StringEnum"},"value":{"type":["string","null"]},"input_variable_id":{"type":"string"}},"required":["type","value","input_variable_id"],"description":"Prompt Sandbox Scenario input value that is of type STRING","title":"ScenarioInputStringVariableValue"},"ScenarioInputJsonVariableValue":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/JsonEnum"},"value":{"oneOf":[{"description":"Any type"},{"type":"null"}]},"input_variable_id":{"type":"string"}},"required":["type","value","input_variable_id"],"description":"Prompt Sandbox Scenario input value that is of type JSON","title":"ScenarioInputJsonVariableValue"},"ScenarioInputChatHistoryVariableValue":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/ChatHistoryEnum"},"value":{"type":["array","null"],"items":{"$ref":"#/components/schemas/ChatMessage"}},"input_variable_id":{"type":"string"}},"required":["type","value","input_variable_id"],"description":"Prompt Sandbox Scenario input value that is of type CHAT_HISTORY","title":"ScenarioInputChatHistoryVariableValue"},"ScenarioInputAudioVariableValue":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/AudioEnum"},"value":{"oneOf":[{"$ref":"#/components/schemas/VellumAudio"},{"type":"null"}]},"input_variable_id":{"type":"string"}},"required":["type","value","input_variable_id"],"title":"ScenarioInputAudioVariableValue"},"ScenarioInputVideoVariableValue":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/VideoEnum"},"value":{"oneOf":[{"$ref":"#/components/schemas/VellumVideo"},{"type":"null"}]},"input_variable_id":{"type":"string"}},"required":["type","value","input_variable_id"],"title":"ScenarioInputVideoVariableValue"},"ScenarioInputImageVariableValue":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/ImageEnum"},"value":{"oneOf":[{"$ref":"#/components/schemas/VellumImage"},{"type":"null"}]},"input_variable_id":{"type":"string"}},"required":["type","value","input_variable_id"],"title":"ScenarioInputImageVariableValue"},"ScenarioInputDocumentVariableValue":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/DocumentEnum"},"value":{"oneOf":[{"$ref":"#/components/schemas/VellumDocument"},{"type":"null"}]},"input_variable_id":{"type":"string"}},"required":["type","value","input_variable_id"],"title":"ScenarioInputDocumentVariableValue"},"ScenarioInput":{"oneOf":[{"$ref":"#/components/schemas/ScenarioInputStringVariableValue"},{"$ref":"#/components/schemas/ScenarioInputJsonVariableValue"},{"$ref":"#/components/schemas/ScenarioInputChatHistoryVariableValue"},{"$ref":"#/components/schemas/ScenarioInputAudioVariableValue"},{"$ref":"#/components/schemas/ScenarioInputVideoVariableValue"},{"$ref":"#/components/schemas/ScenarioInputImageVariableValue"},{"$ref":"#/components/schemas/ScenarioInputDocumentVariableValue"}],"title":"ScenarioInput"},"SandboxScenario":{"type":"object","properties":{"label":{"type":"string","default":"Untitled Scenario"},"inputs":{"type":"array","items":{"$ref":"#/components/schemas/ScenarioInput"},"description":"The inputs for the scenario"},"id":{"type":"string","description":"The id of the scenario"}},"required":["inputs","id"],"description":"Sandbox Scenario","title":"SandboxScenario"},"sandboxes_delete_sandbox_scenario_Response_204":{"type":"object","properties":{},"description":"Empty response body","title":"sandboxes_delete_sandbox_scenario_Response_204"},"V1DeploymentsGetParametersStatus":{"type":"string","enum":["ACTIVE","ARCHIVED","PENDING_DELETION"],"title":"V1DeploymentsGetParametersStatus"},"SlimDeploymentRead":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"created":{"type":"string","format":"date-time"},"label":{"type":"string","description":"A human-readable label for the deployment"},"name":{"type":"string","description":"A name that uniquely identifies this deployment within its workspace"},"status":{"$ref":"#/components/schemas/EntityStatus","description":"The current status of the deployment\n\n* `ACTIVE` - Active\n* `ARCHIVED` - Archived\n* `PENDING_DELETION` - Pending Deletion"},"environment":{"oneOf":[{"$ref":"#/components/schemas/EnvironmentEnum"},{"type":"null"}],"description":"Deprecated. The value returned will always be 'PRODUCTION'."},"last_deployed_on":{"type":"string","format":"date-time"},"input_variables":{"type":"array","items":{"$ref":"#/components/schemas/VellumVariable"}},"description":{"type":["string","null"],"description":"A human-readable description of the deployment"}},"required":["id","created","label","name","last_deployed_on","input_variables"],"description":"A subset of a Prompt Deployment's full details.","title":"SlimDeploymentRead"},"PaginatedSlimDeploymentReadList":{"type":"object","properties":{"count":{"type":"integer"},"next":{"type":["string","null"],"format":"uri"},"previous":{"type":["string","null"],"format":"uri"},"results":{"type":"array","items":{"$ref":"#/components/schemas/SlimDeploymentRead"}}},"title":"PaginatedSlimDeploymentReadList"},"ReleaseEnvironment":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"label":{"type":"string"}},"required":["id","name","label"],"title":"ReleaseEnvironment"},"ReleaseCreatedBy":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"full_name":{"type":"string"},"email":{"type":"string","format":"email"}},"required":["id","email"],"title":"ReleaseCreatedBy"},"SandboxEnum":{"type":"string","enum":["SANDBOX"],"title":"SandboxEnum"},"PromptVersionBuildConfigSandbox":{"type":"object","properties":{"source":{"$ref":"#/components/schemas/SandboxEnum"},"sandbox_id":{"type":"string","format":"uuid"},"sandbox_snapshot_id":{"type":"string","format":"uuid"},"prompt_id":{"type":"string"}},"required":["source","sandbox_id","sandbox_snapshot_id","prompt_id"],"title":"PromptVersionBuildConfigSandbox"},"PromptVersionBuildConfig":{"oneOf":[{"$ref":"#/components/schemas/PromptVersionBuildConfigSandbox"}],"title":"PromptVersionBuildConfig"},"PromptDeploymentReleasePromptVersion":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"ml_model_to_workspace_id":{"type":"string","format":"uuid"},"build_config":{"$ref":"#/components/schemas/PromptVersionBuildConfig","description":"Configuration used to build this prompt version."}},"required":["id","ml_model_to_workspace_id","build_config"],"title":"PromptDeploymentReleasePromptVersion"},"PromptDeploymentReleasePromptDeployment":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"}},"required":["id","name"],"title":"PromptDeploymentReleasePromptDeployment"},"ReleaseTagSource":{"type":"string","enum":["SYSTEM","USER"],"description":"* `SYSTEM` - System\n* `USER` - User","title":"ReleaseTagSource"},"ReleaseReleaseTag":{"type":"object","properties":{"name":{"type":"string","description":"The name of the Release Tag"},"source":{"$ref":"#/components/schemas/ReleaseTagSource","description":"The source of how the Release Tag was originally created\n\n* `SYSTEM` - System\n* `USER` - User"}},"required":["name","source"],"title":"ReleaseReleaseTag"},"ReleaseReviewReviewer":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"full_name":{"type":"string"}},"required":["id"],"title":"ReleaseReviewReviewer"},"ReleaseReviewState":{"type":"string","enum":["APPROVED","CHANGES_REQUESTED","COMMENTED"],"description":"* `APPROVED` - Approved\n* `CHANGES_REQUESTED` - Changes Requested\n* `COMMENTED` - Commented","title":"ReleaseReviewState"},"SlimReleaseReview":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"created":{"type":"string","format":"date-time"},"reviewer":{"$ref":"#/components/schemas/ReleaseReviewReviewer"},"state":{"$ref":"#/components/schemas/ReleaseReviewState"}},"required":["id","created","reviewer","state"],"title":"SlimReleaseReview"},"PromptDeploymentRelease":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"created":{"type":"string","format":"date-time"},"environment":{"$ref":"#/components/schemas/ReleaseEnvironment"},"created_by":{"oneOf":[{"$ref":"#/components/schemas/ReleaseCreatedBy"},{"type":"null"}]},"prompt_version":{"$ref":"#/components/schemas/PromptDeploymentReleasePromptVersion"},"deployment":{"$ref":"#/components/schemas/PromptDeploymentReleasePromptDeployment"},"description":{"type":"string"},"release_tags":{"type":"array","items":{"$ref":"#/components/schemas/ReleaseReleaseTag"}},"reviews":{"type":"array","items":{"$ref":"#/components/schemas/SlimReleaseReview"}}},"required":["id","created","environment","created_by","prompt_version","deployment","release_tags","reviews"],"title":"PromptDeploymentRelease"},"DeploymentReleaseTagDeploymentHistoryItem":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"timestamp":{"type":"string","format":"date-time"}},"required":["id","timestamp"],"title":"DeploymentReleaseTagDeploymentHistoryItem"},"ReleaseTagRelease":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"timestamp":{"type":"string","format":"date-time"}},"required":["id","timestamp"],"title":"ReleaseTagRelease"},"DeploymentReleaseTagRead":{"type":"object","properties":{"name":{"type":"string","description":"The name of the Release Tag"},"source":{"$ref":"#/components/schemas/ReleaseTagSource","description":"The source of how the Release Tag was originally created\n\n* `SYSTEM` - System\n* `USER` - User"},"history_item":{"$ref":"#/components/schemas/DeploymentReleaseTagDeploymentHistoryItem","description":"Deprecated. Reference the `release` field instead."},"release":{"$ref":"#/components/schemas/ReleaseTagRelease","description":"The Release that this Release Tag points to."}},"required":["name","source","history_item","release"],"title":"DeploymentReleaseTagRead"},"V1DeploymentsIdReleaseTagsGetParametersSource":{"type":"string","enum":["SYSTEM","USER"],"title":"V1DeploymentsIdReleaseTagsGetParametersSource"},"PaginatedDeploymentReleaseTagReadList":{"type":"object","properties":{"count":{"type":"integer"},"next":{"type":["string","null"],"format":"uri"},"previous":{"type":["string","null"],"format":"uri"},"results":{"type":"array","items":{"$ref":"#/components/schemas/DeploymentReleaseTagRead"}}},"title":"PaginatedDeploymentReleaseTagReadList"},"PatchedDeploymentReleaseTagUpdateRequest":{"type":"object","properties":{"history_item_id":{"type":"string","format":"uuid","description":"The ID of the Release to tag"}},"title":"PatchedDeploymentReleaseTagUpdateRequest"},"DeploymentHistoryItem":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"deployment_id":{"type":"string","format":"uuid"},"timestamp":{"type":"string","format":"date-time"},"label":{"type":"string","description":"A human-readable label for the deployment"},"name":{"type":"string","description":"A name that uniquely identifies this deployment within its workspace"},"input_variables":{"type":"array","items":{"$ref":"#/components/schemas/VellumVariable"}},"description":{"type":["string","null"],"description":"A human-readable description of the deployment"}},"required":["id","deployment_id","timestamp","label","name","input_variables"],"title":"DeploymentHistoryItem"},"WorkflowRequestStringInputRequest":{"type":"object","properties":{"name":{"type":"string","description":"The variable's name, as defined in the Workflow."},"type":{"$ref":"#/components/schemas/StringEnum"},"value":{"type":"string"}},"required":["name","type","value"],"description":"The input for a string variable in a Workflow.","title":"WorkflowRequestStringInputRequest"},"WorkflowRequestJSONInputRequest":{"type":"object","properties":{"name":{"type":"string","description":"The variable's name, as defined in the Workflow."},"type":{"$ref":"#/components/schemas/JsonEnum"},"value":{"oneOf":[{"description":"Any type"},{"type":"null"}]}},"required":["name","type","value"],"description":"The input for a JSON variable in a Workflow.","title":"WorkflowRequestJSONInputRequest"},"WorkflowRequestChatHistoryInputRequest":{"type":"object","properties":{"name":{"type":"string","description":"The variable's name, as defined in the Workflow."},"type":{"$ref":"#/components/schemas/ChatHistoryEnum"},"value":{"type":"array","items":{"$ref":"#/components/schemas/ChatMessageRequest"}}},"required":["name","type","value"],"description":"The input for a chat history variable in a Workflow.","title":"WorkflowRequestChatHistoryInputRequest"},"WorkflowRequestNumberInputRequest":{"type":"object","properties":{"name":{"type":"string","description":"The variable's name, as defined in the Workflow."},"type":{"$ref":"#/components/schemas/NumberEnum"},"value":{"type":"number","format":"double"}},"required":["name","type","value"],"description":"The input for a number variable in a Workflow.","title":"WorkflowRequestNumberInputRequest"},"WorkflowRequestAudioInputRequest":{"type":"object","properties":{"name":{"type":"string","description":"The variable's name, as defined in the Workflow."},"type":{"$ref":"#/components/schemas/AudioEnum"},"value":{"$ref":"#/components/schemas/VellumAudioRequest"}},"required":["name","type","value"],"description":"The input for an audio variable in a Workflow.","title":"WorkflowRequestAudioInputRequest"},"WorkflowRequestVideoInputRequest":{"type":"object","properties":{"name":{"type":"string","description":"The variable's name, as defined in the Workflow."},"type":{"$ref":"#/components/schemas/VideoEnum"},"value":{"$ref":"#/components/schemas/VellumVideoRequest"}},"required":["name","type","value"],"description":"The input for a video variable in a Workflow.","title":"WorkflowRequestVideoInputRequest"},"WorkflowRequestImageInputRequest":{"type":"object","properties":{"name":{"type":"string","description":"The variable's name, as defined in the Workflow."},"type":{"$ref":"#/components/schemas/ImageEnum"},"value":{"$ref":"#/components/schemas/VellumImageRequest"}},"required":["name","type","value"],"description":"The input for an image variable in a Workflow.","title":"WorkflowRequestImageInputRequest"},"WorkflowRequestDocumentInputRequest":{"type":"object","properties":{"name":{"type":"string","description":"The variable's name, as defined in the Workflow."},"type":{"$ref":"#/components/schemas/DocumentEnum"},"value":{"$ref":"#/components/schemas/VellumDocumentRequest"}},"required":["name","type","value"],"description":"The input for a document variable in a Workflow.","title":"WorkflowRequestDocumentInputRequest"},"WorkflowRequestInputRequest":{"oneOf":[{"$ref":"#/components/schemas/WorkflowRequestStringInputRequest"},{"$ref":"#/components/schemas/WorkflowRequestJSONInputRequest"},{"$ref":"#/components/schemas/WorkflowRequestChatHistoryInputRequest"},{"$ref":"#/components/schemas/WorkflowRequestNumberInputRequest"},{"$ref":"#/components/schemas/WorkflowRequestAudioInputRequest"},{"$ref":"#/components/schemas/WorkflowRequestVideoInputRequest"},{"$ref":"#/components/schemas/WorkflowRequestImageInputRequest"},{"$ref":"#/components/schemas/WorkflowRequestDocumentInputRequest"}],"title":"WorkflowRequestInputRequest"},"WorkflowExpandMetaRequest":{"type":"object","properties":{"usage":{"type":["boolean","null"],"description":"If enabled, the Prompt Node FULFILLED events will include model host usage tracking. This may increase latency for some model hosts."},"cost":{"type":["boolean","null"],"description":"If enabled, the Prompt Node FULFILLED events will include model host cost tracking. This may increase latency for some model hosts."},"model_name":{"type":["boolean","null"],"description":"If enabled, the Prompt Node FULFILLED events will include model host name"}},"title":"WorkflowExpandMetaRequest"},"ExecuteWorkflowRequest":{"type":"object","properties":{"inputs":{"type":"array","items":{"$ref":"#/components/schemas/WorkflowRequestInputRequest"},"description":"The list of inputs defined in the Workflow's Deployment with their corresponding values."},"expand_meta":{"oneOf":[{"$ref":"#/components/schemas/WorkflowExpandMetaRequest"},{"type":"null"}],"description":"An optionally specified configuration used to opt in to including additional metadata about this workflow execution in the API response. Corresponding values will be returned under the `execution_meta` key within NODE events in the response stream."},"workflow_deployment_id":{"type":["string","null"],"format":"uuid","description":"The ID of the Workflow Deployment. Must provide either this or workflow_deployment_name."},"workflow_deployment_name":{"type":["string","null"],"description":"The name of the Workflow Deployment. Must provide either this or workflow_deployment_id."},"release_tag":{"type":["string","null"],"description":"Optionally specify a release tag if you want to pin to a specific release of the Workflow Deployment"},"external_id":{"type":["string","null"],"description":"Optionally include a unique identifier for tracking purposes. Must be unique within a given Workspace."},"metadata":{"type":["object","null"],"additionalProperties":{"description":"Any type"},"description":"Arbitrary JSON metadata associated with this request. Can be used to capture additional monitoring data such as user id, session id, etc. for future analysis."},"previous_execution_id":{"type":["string","null"],"format":"uuid","description":"The ID of a previous Workflow Execution to reference for initial State loading."}},"required":["inputs"],"description":"The request to invoke a Workflow Deployment execution.","title":"ExecuteWorkflowRequest"},"WorkflowOutputString":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string","description":"The output's name, as defined in the workflow"},"type":{"$ref":"#/components/schemas/StringEnum"},"value":{"type":["string","null"]}},"required":["id","name","type","value"],"description":"A string output from a Workflow execution.","title":"WorkflowOutputString"},"WorkflowOutputNumber":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string","description":"The output's name, as defined in the workflow"},"type":{"$ref":"#/components/schemas/NumberEnum"},"value":{"type":["number","null"],"format":"double"}},"required":["id","name","type","value"],"description":"A number output from a Workflow execution.","title":"WorkflowOutputNumber"},"WorkflowOutputJSON":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string","description":"The output's name, as defined in the workflow"},"type":{"$ref":"#/components/schemas/JsonEnum"},"value":{"oneOf":[{"description":"Any type"},{"type":"null"}]}},"required":["id","name","type","value"],"description":"A JSON output from a Workflow execution.","title":"WorkflowOutputJSON"},"WorkflowOutputChatHistory":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string","description":"The output's name, as defined in the workflow"},"type":{"$ref":"#/components/schemas/ChatHistoryEnum"},"value":{"type":["array","null"],"items":{"$ref":"#/components/schemas/ChatMessage"}}},"required":["id","name","type","value"],"description":"A chat history output from a Workflow execution.","title":"WorkflowOutputChatHistory"},"WorkflowOutputSearchResults":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string","description":"The output's name, as defined in the workflow"},"type":{"$ref":"#/components/schemas/SearchResultsEnum"},"value":{"type":["array","null"],"items":{"$ref":"#/components/schemas/SearchResult"}}},"required":["id","name","type","value"],"description":"A search results output from a Workflow execution.","title":"WorkflowOutputSearchResults"},"WorkflowOutputArray":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string","description":"The output's name, as defined in the workflow"},"type":{"$ref":"#/components/schemas/ArrayEnum"},"value":{"type":["array","null"],"items":{"$ref":"#/components/schemas/VellumValue"}}},"required":["id","name","type","value"],"description":"An array output from a Workflow execution.","title":"WorkflowOutputArray"},"WorkflowOutputError":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string","description":"The output's name, as defined in the workflow"},"type":{"$ref":"#/components/schemas/ErrorEnum"},"value":{"oneOf":[{"$ref":"#/components/schemas/VellumError"},{"type":"null"}]}},"required":["id","name","type","value"],"description":"An error output from a Workflow execution.","title":"WorkflowOutputError"},"WorkflowOutputFunctionCall":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string","description":"The output's name, as defined in the workflow"},"type":{"$ref":"#/components/schemas/FunctionCallEnum"},"value":{"oneOf":[{"$ref":"#/components/schemas/FunctionCall"},{"type":"null"}]}},"required":["id","name","type","value"],"description":"A function call output from a Workflow execution.","title":"WorkflowOutputFunctionCall"},"WorkflowOutputImage":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string","description":"The output's name, as defined in the workflow"},"type":{"$ref":"#/components/schemas/ImageEnum"},"value":{"oneOf":[{"$ref":"#/components/schemas/VellumImage"},{"type":"null"}]}},"required":["id","name","type","value"],"description":"An image output from a Workflow execution.","title":"WorkflowOutputImage"},"WorkflowOutputAudio":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string","description":"The output's name, as defined in the workflow"},"type":{"$ref":"#/components/schemas/AudioEnum"},"value":{"oneOf":[{"$ref":"#/components/schemas/VellumAudio"},{"type":"null"}]}},"required":["id","name","type","value"],"description":"An audio output from a Workflow execution.","title":"WorkflowOutputAudio"},"WorkflowOutputVideo":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string","description":"The output's name, as defined in the workflow"},"type":{"$ref":"#/components/schemas/VideoEnum"},"value":{"oneOf":[{"$ref":"#/components/schemas/VellumVideo"},{"type":"null"}]}},"required":["id","name","type","value"],"description":"A video output from a Workflow execution.","title":"WorkflowOutputVideo"},"WorkflowOutputDocument":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string","description":"The output's name, as defined in the workflow"},"type":{"$ref":"#/components/schemas/DocumentEnum"},"value":{"oneOf":[{"$ref":"#/components/schemas/VellumDocument"},{"type":"null"}]}},"required":["id","name","type","value"],"description":"A document output from a Workflow execution.","title":"WorkflowOutputDocument"},"WorkflowOutput":{"oneOf":[{"$ref":"#/components/schemas/WorkflowOutputString"},{"$ref":"#/components/schemas/WorkflowOutputNumber"},{"$ref":"#/components/schemas/WorkflowOutputJSON"},{"$ref":"#/components/schemas/WorkflowOutputChatHistory"},{"$ref":"#/components/schemas/WorkflowOutputSearchResults"},{"$ref":"#/components/schemas/WorkflowOutputArray"},{"$ref":"#/components/schemas/WorkflowOutputError"},{"$ref":"#/components/schemas/WorkflowOutputFunctionCall"},{"$ref":"#/components/schemas/WorkflowOutputImage"},{"$ref":"#/components/schemas/WorkflowOutputAudio"},{"$ref":"#/components/schemas/WorkflowOutputVideo"},{"$ref":"#/components/schemas/WorkflowOutputDocument"}],"title":"WorkflowOutput"},"FulfilledExecuteWorkflowWorkflowResultEvent":{"type":"object","properties":{"id":{"type":"string"},"state":{"$ref":"#/components/schemas/FulfilledEnum"},"ts":{"type":"string","format":"date-time"},"outputs":{"type":"array","items":{"$ref":"#/components/schemas/WorkflowOutput"}}},"required":["id","state","ts","outputs"],"description":"The successful response from the Workflow execution containing the produced outputs.","title":"FulfilledExecuteWorkflowWorkflowResultEvent"},"WorkflowEventErrorRawData":{"oneOf":[{"type":"object","additionalProperties":{"description":"Any type"}},{"type":"string"}],"title":"WorkflowEventErrorRawData"},"WorkflowExecutionEventErrorCode":{"type":"string","enum":["WORKFLOW_INITIALIZATION","WORKFLOW_CANCELLED","WORKFLOW_TIMEOUT","PROVIDER_CREDENTIALS_UNAVAILABLE","INTEGRATION_CREDENTIALS_UNAVAILABLE","NODE_EXECUTION_COUNT_LIMIT_REACHED","INTERNAL_SERVER_ERROR","NODE_EXECUTION","NODE_CANCELLED","NODE_TIMEOUT","LLM_PROVIDER","INVALID_TEMPLATE","INVALID_INPUTS","PROVIDER_QUOTA_EXCEEDED","USER_DEFINED_ERROR"],"description":"* `WORKFLOW_INITIALIZATION` - WORKFLOW_INITIALIZATION\n* `WORKFLOW_CANCELLED` - WORKFLOW_CANCELLED\n* `WORKFLOW_TIMEOUT` - WORKFLOW_TIMEOUT\n* `PROVIDER_CREDENTIALS_UNAVAILABLE` - PROVIDER_CREDENTIALS_UNAVAILABLE\n* `INTEGRATION_CREDENTIALS_UNAVAILABLE` - INTEGRATION_CREDENTIALS_UNAVAILABLE\n* `NODE_EXECUTION_COUNT_LIMIT_REACHED` - NODE_EXECUTION_COUNT_LIMIT_REACHED\n* `INTERNAL_SERVER_ERROR` - INTERNAL_SERVER_ERROR\n* `NODE_EXECUTION` - NODE_EXECUTION\n* `NODE_CANCELLED` - NODE_CANCELLED\n* `NODE_TIMEOUT` - NODE_TIMEOUT\n* `LLM_PROVIDER` - LLM_PROVIDER\n* `INVALID_TEMPLATE` - INVALID_TEMPLATE\n* `INVALID_INPUTS` - INVALID_INPUTS\n* `PROVIDER_QUOTA_EXCEEDED` - PROVIDER_QUOTA_EXCEEDED\n* `USER_DEFINED_ERROR` - USER_DEFINED_ERROR","title":"WorkflowExecutionEventErrorCode"},"WorkflowEventError":{"type":"object","properties":{"message":{"type":"string"},"raw_data":{"oneOf":[{"$ref":"#/components/schemas/WorkflowEventErrorRawData"},{"type":"null"}]},"code":{"$ref":"#/components/schemas/WorkflowExecutionEventErrorCode"},"stacktrace":{"type":["string","null"]}},"required":["message","code"],"title":"WorkflowEventError"},"RejectedExecuteWorkflowWorkflowResultEvent":{"type":"object","properties":{"id":{"type":"string"},"state":{"$ref":"#/components/schemas/RejectedEnum"},"ts":{"type":"string","format":"date-time"},"error":{"$ref":"#/components/schemas/WorkflowEventError"}},"required":["id","state","ts","error"],"description":"The unsuccessful response from the Workflow execution containing an error specifying what went wrong.","title":"RejectedExecuteWorkflowWorkflowResultEvent"},"ExecuteWorkflowWorkflowResultEvent":{"oneOf":[{"$ref":"#/components/schemas/FulfilledExecuteWorkflowWorkflowResultEvent"},{"$ref":"#/components/schemas/RejectedExecuteWorkflowWorkflowResultEvent"}],"title":"ExecuteWorkflowWorkflowResultEvent"},"ExecuteWorkflowResponse":{"type":"object","properties":{"execution_id":{"type":"string"},"run_id":{"type":["string","null"]},"external_id":{"type":["string","null"]},"data":{"$ref":"#/components/schemas/ExecuteWorkflowWorkflowResultEvent"}},"required":["execution_id","data"],"title":"ExecuteWorkflowResponse"},"ExecuteWorkflowErrorResponse":{"type":"object","properties":{"detail":{"type":"string","description":"Details about why the request failed."}},"required":["detail"],"title":"ExecuteWorkflowErrorResponse"},"ExecuteWorkflowAsyncRequest":{"type":"object","properties":{"inputs":{"type":"array","items":{"$ref":"#/components/schemas/WorkflowRequestInputRequest"},"description":"The list of inputs defined in the Workflow's Deployment with their corresponding values."},"workflow_deployment_id":{"type":["string","null"],"format":"uuid","description":"The ID of the Workflow Deployment. Must provide either this or workflow_deployment_name."},"workflow_deployment_name":{"type":["string","null"],"description":"The name of the Workflow Deployment. Must provide either this or workflow_deployment_id."},"release_tag":{"type":["string","null"],"description":"Optionally specify a release tag if you want to pin to a specific release of the Workflow Deployment"},"external_id":{"type":["string","null"],"description":"Optionally include a unique identifier for tracking purposes. Must be unique within a given Workspace."},"previous_execution_id":{"type":["string","null"],"format":"uuid","description":"The ID of a previous Workflow Execution to reference for initial State loading."},"metadata":{"type":["object","null"],"additionalProperties":{"description":"Any type"},"description":"Arbitrary JSON metadata associated with this request. Can be used to capture additional monitoring data such as user id, session id, etc. for future analysis."}},"required":["inputs"],"description":"The request to execute a Workflow Deployment asynchronously.","title":"ExecuteWorkflowAsyncRequest"},"ExecuteWorkflowAsyncResponse":{"type":"object","properties":{"execution_id":{"type":"string","description":"The ID of the workflow execution."}},"required":["execution_id"],"description":"The response from an async Workflow Deployment execution.","title":"ExecuteWorkflowAsyncResponse"},"ExecuteWorkflowStreamErrorResponse":{"type":"object","properties":{"detail":{"type":"string","description":"Details about why the request failed."}},"required":["detail"],"title":"ExecuteWorkflowStreamErrorResponse"},"WorkflowExecutionEventType":{"type":"string","enum":["NODE","WORKFLOW"],"description":"* `NODE` - NODE\n* `WORKFLOW` - WORKFLOW","title":"WorkflowExecutionEventType"},"ExecuteWorkflowStreamRequest":{"type":"object","properties":{"inputs":{"type":"array","items":{"$ref":"#/components/schemas/WorkflowRequestInputRequest"},"description":"The list of inputs defined in the Workflow's Deployment with their corresponding values."},"expand_meta":{"oneOf":[{"$ref":"#/components/schemas/WorkflowExpandMetaRequest"},{"type":"null"}],"description":"An optionally specified configuration used to opt in to including additional metadata about this workflow execution in the API response. Corresponding values will be returned under the `execution_meta` key within NODE events in the response stream."},"workflow_deployment_id":{"type":["string","null"],"format":"uuid","description":"The ID of the Workflow Deployment. Must provide either this or workflow_deployment_name."},"workflow_deployment_name":{"type":["string","null"],"description":"The name of the Workflow Deployment. Must provide either this or workflow_deployment_id."},"release_tag":{"type":["string","null"],"description":"Optionally specify a release tag if you want to pin to a specific release of the Workflow Deployment"},"external_id":{"type":["string","null"],"description":"Optionally include a unique identifier for tracking purposes. Must be unique within a given Workspace."},"event_types":{"type":"array","items":{"$ref":"#/components/schemas/WorkflowExecutionEventType"},"description":"Optionally specify which events you want to receive. Defaults to only WORKFLOW events. Note that the schema of non-WORKFLOW events is unstable and should be used with caution."},"metadata":{"type":["object","null"],"additionalProperties":{"description":"Any type"},"description":"Arbitrary JSON metadata associated with this request. Can be used to capture additional monitoring data such as user id, session id, etc. for future analysis."},"previous_execution_id":{"type":["string","null"],"format":"uuid","description":"The ID of a previous Workflow Execution to reference for initial State loading."}},"required":["inputs"],"description":"The request to stream a Workflow Deployment execution.","title":"ExecuteWorkflowStreamRequest"},"WorkflowEnum":{"type":"string","enum":["WORKFLOW"],"title":"WorkflowEnum"},"WorkflowResultEventState":{"type":"string","enum":["INITIATED","STREAMING","FULFILLED","REJECTED","PENDING"],"description":"* `INITIATED` - Initiated\n* `STREAMING` - Streaming\n* `FULFILLED` - Fulfilled\n* `REJECTED` - Rejected\n* `PENDING` - Pending","title":"WorkflowResultEventState"},"WorkflowNodeResultEventState":{"type":"string","enum":["INITIATED","STREAMING","FULFILLED","REJECTED"],"description":"* `INITIATED` - INITIATED\n* `STREAMING` - STREAMING\n* `FULFILLED` - FULFILLED\n* `REJECTED` - REJECTED","title":"WorkflowNodeResultEventState"},"WorkflowResultEventOutputDataString":{"type":"object","properties":{"id":{"type":["string","null"],"format":"uuid"},"name":{"type":"string"},"state":{"$ref":"#/components/schemas/WorkflowNodeResultEventState"},"node_id":{"type":["string","null"]},"delta":{"type":["string","null"],"description":"The newly output string value, meant to be concatenated with all previous. Will be non-null for events of state STREAMING."},"type":{"$ref":"#/components/schemas/StringEnum"},"value":{"type":["string","null"],"description":"The entire string value. Will be non-null for events of state FULFILLED."}},"required":["name","state","delta","type","value"],"description":"A string output streamed from a Workflow execution.","title":"WorkflowResultEventOutputDataString"},"WorkflowResultEventOutputDataNumber":{"type":"object","properties":{"id":{"type":["string","null"],"format":"uuid"},"name":{"type":"string"},"state":{"$ref":"#/components/schemas/WorkflowNodeResultEventState"},"node_id":{"type":["string","null"]},"delta":{"type":["string","null"],"description":"The newly output string value. Only relevant for string outputs with a state of STREAMING."},"type":{"$ref":"#/components/schemas/NumberEnum"},"value":{"type":["number","null"],"format":"double"}},"required":["name","state","delta","type","value"],"description":"A number output streamed from a Workflow execution.","title":"WorkflowResultEventOutputDataNumber"},"WorkflowResultEventOutputDataJSON":{"type":"object","properties":{"id":{"type":["string","null"],"format":"uuid"},"name":{"type":"string"},"state":{"$ref":"#/components/schemas/WorkflowNodeResultEventState"},"node_id":{"type":["string","null"]},"delta":{"type":["string","null"],"description":"The newly output string value. Only relevant for string outputs with a state of STREAMING."},"type":{"$ref":"#/components/schemas/JsonEnum"},"value":{"oneOf":[{"description":"Any type"},{"type":"null"}]}},"required":["name","state","delta","type","value"],"description":"A JSON output streamed from a Workflow execution.","title":"WorkflowResultEventOutputDataJSON"},"WorkflowResultEventOutputDataChatHistory":{"type":"object","properties":{"id":{"type":["string","null"],"format":"uuid"},"name":{"type":"string"},"state":{"$ref":"#/components/schemas/WorkflowNodeResultEventState"},"node_id":{"type":["string","null"]},"delta":{"type":["string","null"],"description":"The newly output string value. Only relevant for string outputs with a state of STREAMING."},"type":{"$ref":"#/components/schemas/ChatHistoryEnum"},"value":{"type":["array","null"],"items":{"$ref":"#/components/schemas/ChatMessage"}}},"required":["name","state","delta","type","value"],"description":"A Chat History output streamed from a Workflow execution.","title":"WorkflowResultEventOutputDataChatHistory"},"WorkflowResultEventOutputDataSearchResults":{"type":"object","properties":{"id":{"type":["string","null"],"format":"uuid"},"name":{"type":"string"},"state":{"$ref":"#/components/schemas/WorkflowNodeResultEventState"},"node_id":{"type":["string","null"]},"delta":{"type":["string","null"],"description":"The newly output string value. Only relevant for string outputs with a state of STREAMING."},"type":{"$ref":"#/components/schemas/SearchResultsEnum"},"value":{"type":["array","null"],"items":{"$ref":"#/components/schemas/SearchResult"}}},"required":["name","state","delta","type","value"],"description":"A Search Results output streamed from a Workflow execution.","title":"WorkflowResultEventOutputDataSearchResults"},"WorkflowResultEventOutputDataArray":{"type":"object","properties":{"id":{"type":["string","null"],"format":"uuid"},"name":{"type":"string"},"state":{"$ref":"#/components/schemas/WorkflowNodeResultEventState"},"node_id":{"type":["string","null"]},"delta":{"type":["string","null"],"description":"The newly output string value. Only relevant for string outputs with a state of STREAMING."},"type":{"$ref":"#/components/schemas/ArrayEnum"},"value":{"type":["array","null"],"items":{"$ref":"#/components/schemas/VellumValue"}}},"required":["name","state","delta","type","value"],"description":"An Array output returned from a Workflow execution.","title":"WorkflowResultEventOutputDataArray"},"WorkflowResultEventOutputDataFunctionCall":{"type":"object","properties":{"id":{"type":["string","null"],"format":"uuid"},"name":{"type":"string"},"state":{"$ref":"#/components/schemas/WorkflowNodeResultEventState"},"node_id":{"type":["string","null"]},"delta":{"type":["string","null"],"description":"The newly output string value. Only relevant for string outputs with a state of STREAMING."},"type":{"$ref":"#/components/schemas/FunctionCallEnum"},"value":{"oneOf":[{"$ref":"#/components/schemas/FunctionCall"},{"type":"null"}]}},"required":["name","state","delta","type","value"],"description":"A Function Call output returned from a Workflow execution.","title":"WorkflowResultEventOutputDataFunctionCall"},"WorkflowResultEventOutputDataError":{"type":"object","properties":{"id":{"type":["string","null"],"format":"uuid"},"name":{"type":"string"},"state":{"$ref":"#/components/schemas/WorkflowNodeResultEventState"},"node_id":{"type":["string","null"]},"delta":{"type":["string","null"],"description":"The newly output string value. Only relevant for string outputs with a state of STREAMING."},"type":{"$ref":"#/components/schemas/ErrorEnum"},"value":{"oneOf":[{"$ref":"#/components/schemas/VellumError"},{"type":"null"}]}},"required":["name","state","delta","type","value"],"description":"An Error output streamed from a Workflow execution.","title":"WorkflowResultEventOutputDataError"},"WorkflowResultEventOutputData":{"oneOf":[{"$ref":"#/components/schemas/WorkflowResultEventOutputDataString"},{"$ref":"#/components/schemas/WorkflowResultEventOutputDataNumber"},{"$ref":"#/components/schemas/WorkflowResultEventOutputDataJSON"},{"$ref":"#/components/schemas/WorkflowResultEventOutputDataChatHistory"},{"$ref":"#/components/schemas/WorkflowResultEventOutputDataSearchResults"},{"$ref":"#/components/schemas/WorkflowResultEventOutputDataArray"},{"$ref":"#/components/schemas/WorkflowResultEventOutputDataFunctionCall"},{"$ref":"#/components/schemas/WorkflowResultEventOutputDataError"}],"title":"WorkflowResultEventOutputData"},"ExecutionStringVellumValue":{"type":"object","properties":{"id":{"type":"string","description":"The variable's uniquely identifying internal id."},"name":{"type":"string"},"type":{"$ref":"#/components/schemas/StringEnum"},"value":{"type":["string","null"]}},"required":["id","name","type","value"],"description":"A value representing a string.","title":"ExecutionStringVellumValue"},"ExecutionNumberVellumValue":{"type":"object","properties":{"id":{"type":"string","description":"The variable's uniquely identifying internal id."},"name":{"type":"string"},"type":{"$ref":"#/components/schemas/NumberEnum"},"value":{"type":["number","null"],"format":"double"}},"required":["id","name","type","value"],"description":"A value representing a number.","title":"ExecutionNumberVellumValue"},"ExecutionJsonVellumValue":{"type":"object","properties":{"id":{"type":"string","description":"The variable's uniquely identifying internal id."},"name":{"type":"string"},"type":{"$ref":"#/components/schemas/JsonEnum"},"value":{"oneOf":[{"description":"Any type"},{"type":"null"}]}},"required":["id","name","type","value"],"description":"A value representing a JSON object.","title":"ExecutionJsonVellumValue"},"ExecutionChatHistoryVellumValue":{"type":"object","properties":{"id":{"type":"string","description":"The variable's uniquely identifying internal id."},"name":{"type":"string"},"type":{"$ref":"#/components/schemas/ChatHistoryEnum"},"value":{"type":["array","null"],"items":{"$ref":"#/components/schemas/ChatMessage"}}},"required":["id","name","type","value"],"description":"A value representing Chat History.","title":"ExecutionChatHistoryVellumValue"},"ExecutionSearchResultsVellumValue":{"type":"object","properties":{"id":{"type":"string","description":"The variable's uniquely identifying internal id."},"name":{"type":"string"},"type":{"$ref":"#/components/schemas/SearchResultsEnum"},"value":{"type":["array","null"],"items":{"$ref":"#/components/schemas/SearchResult"}}},"required":["id","name","type","value"],"description":"A value representing Search Results.","title":"ExecutionSearchResultsVellumValue"},"ExecutionErrorVellumValue":{"type":"object","properties":{"id":{"type":"string","description":"The variable's uniquely identifying internal id."},"name":{"type":"string"},"type":{"$ref":"#/components/schemas/ErrorEnum"},"value":{"oneOf":[{"$ref":"#/components/schemas/VellumError"},{"type":"null"}]}},"required":["id","name","type","value"],"description":"A value representing an Error.","title":"ExecutionErrorVellumValue"},"ExecutionArrayVellumValue":{"type":"object","properties":{"id":{"type":"string","description":"The variable's uniquely identifying internal id."},"name":{"type":"string"},"type":{"$ref":"#/components/schemas/ArrayEnum"},"value":{"type":["array","null"],"items":{"$ref":"#/components/schemas/VellumValue"}}},"required":["id","name","type","value"],"description":"A value representing an array of Vellum variable values.","title":"ExecutionArrayVellumValue"},"ExecutionFunctionCallVellumValue":{"type":"object","properties":{"id":{"type":"string","description":"The variable's uniquely identifying internal id."},"name":{"type":"string"},"type":{"$ref":"#/components/schemas/FunctionCallEnum"},"value":{"oneOf":[{"$ref":"#/components/schemas/FunctionCall"},{"type":"null"}]}},"required":["id","name","type","value"],"description":"A value representing a Function Call.","title":"ExecutionFunctionCallVellumValue"},"ExecutionThinkingVellumValue":{"type":"object","properties":{"id":{"type":"string","description":"The variable's uniquely identifying internal id."},"name":{"type":"string"},"type":{"$ref":"#/components/schemas/ThinkingEnum"},"value":{"oneOf":[{"$ref":"#/components/schemas/StringVellumValue"},{"type":"null"}]}},"required":["id","name","type","value"],"description":"A value representing Thinking mode output.","title":"ExecutionThinkingVellumValue"},"ExecutionAudioVellumValue":{"type":"object","properties":{"id":{"type":"string","description":"The variable's uniquely identifying internal id."},"name":{"type":"string"},"type":{"$ref":"#/components/schemas/AudioEnum"},"value":{"oneOf":[{"$ref":"#/components/schemas/VellumAudio"},{"type":"null"}]}},"required":["id","name","type","value"],"description":"A base Vellum primitive value representing audio.","title":"ExecutionAudioVellumValue"},"ExecutionVideoVellumValue":{"type":"object","properties":{"id":{"type":"string","description":"The variable's uniquely identifying internal id."},"name":{"type":"string"},"type":{"$ref":"#/components/schemas/VideoEnum"},"value":{"oneOf":[{"$ref":"#/components/schemas/VellumVideo"},{"type":"null"}]}},"required":["id","name","type","value"],"description":"A base Vellum primitive value representing a video.","title":"ExecutionVideoVellumValue"},"ExecutionImageVellumValue":{"type":"object","properties":{"id":{"type":"string","description":"The variable's uniquely identifying internal id."},"name":{"type":"string"},"type":{"$ref":"#/components/schemas/ImageEnum"},"value":{"oneOf":[{"$ref":"#/components/schemas/VellumImage"},{"type":"null"}]}},"required":["id","name","type","value"],"description":"A base Vellum primitive value representing an image.","title":"ExecutionImageVellumValue"},"ExecutionDocumentVellumValue":{"type":"object","properties":{"id":{"type":"string","description":"The variable's uniquely identifying internal id."},"name":{"type":"string"},"type":{"$ref":"#/components/schemas/DocumentEnum"},"value":{"oneOf":[{"$ref":"#/components/schemas/VellumDocument"},{"type":"null"}]}},"required":["id","name","type","value"],"description":"A base Vellum primitive value representing a document.","title":"ExecutionDocumentVellumValue"},"ExecutionVellumValue":{"oneOf":[{"$ref":"#/components/schemas/ExecutionStringVellumValue"},{"$ref":"#/components/schemas/ExecutionNumberVellumValue"},{"$ref":"#/components/schemas/ExecutionJsonVellumValue"},{"$ref":"#/components/schemas/ExecutionChatHistoryVellumValue"},{"$ref":"#/components/schemas/ExecutionSearchResultsVellumValue"},{"$ref":"#/components/schemas/ExecutionErrorVellumValue"},{"$ref":"#/components/schemas/ExecutionArrayVellumValue"},{"$ref":"#/components/schemas/ExecutionFunctionCallVellumValue"},{"$ref":"#/components/schemas/ExecutionThinkingVellumValue"},{"$ref":"#/components/schemas/ExecutionAudioVellumValue"},{"$ref":"#/components/schemas/ExecutionVideoVellumValue"},{"$ref":"#/components/schemas/ExecutionImageVellumValue"},{"$ref":"#/components/schemas/ExecutionDocumentVellumValue"}],"title":"ExecutionVellumValue"},"WorkflowResultEvent":{"type":"object","properties":{"id":{"type":"string"},"state":{"$ref":"#/components/schemas/WorkflowResultEventState"},"ts":{"type":"string","format":"date-time"},"output":{"oneOf":[{"$ref":"#/components/schemas/WorkflowResultEventOutputData"},{"type":"null"}]},"error":{"oneOf":[{"$ref":"#/components/schemas/WorkflowEventError"},{"type":"null"}]},"outputs":{"type":["array","null"],"items":{"$ref":"#/components/schemas/WorkflowOutput"}},"inputs":{"type":["array","null"],"items":{"$ref":"#/components/schemas/ExecutionVellumValue"}}},"required":["id","state","ts","output"],"title":"WorkflowResultEvent"},"WorkflowExecutionWorkflowResultEvent":{"type":"object","properties":{"execution_id":{"type":"string"},"run_id":{"type":["string","null"]},"external_id":{"type":["string","null"]},"type":{"$ref":"#/components/schemas/WorkflowEnum"},"data":{"$ref":"#/components/schemas/WorkflowResultEvent"}},"required":["execution_id","type","data"],"description":"A WORKFLOW-level event emitted from the workflow's execution.","title":"WorkflowExecutionWorkflowResultEvent"},"NodeEnum":{"type":"string","enum":["NODE"],"title":"NodeEnum"},"PromptEnum":{"type":"string","enum":["PROMPT"],"title":"PromptEnum"},"PromptNodeExecutionMeta":{"type":"object","properties":{"usage":{"oneOf":[{"$ref":"#/components/schemas/MLModelUsage"},{"type":"null"}]},"cost":{"oneOf":[{"$ref":"#/components/schemas/Price"},{"type":"null"}]},"model_name":{"type":["string","null"]}},"description":"The subset of the metadata tracked by Vellum during prompt execution that the request opted into with `expand_meta`.","title":"PromptNodeExecutionMeta"},"PromptNodeResultData":{"type":"object","properties":{"execution_meta":{"oneOf":[{"$ref":"#/components/schemas/PromptNodeExecutionMeta"},{"type":"null"}]},"output_id":{"type":"string"},"array_output_id":{"type":["string","null"]},"execution_id":{"type":["string","null"]},"text":{"type":["string","null"]},"delta":{"type":["string","null"]}},"required":["output_id"],"title":"PromptNodeResultData"},"PromptNodeResult":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/PromptEnum"},"data":{"$ref":"#/components/schemas/PromptNodeResultData"}},"required":["type","data"],"description":"A Node Result Event emitted from a Prompt Node.","title":"PromptNodeResult"},"SearchEnum":{"type":"string","enum":["SEARCH"],"title":"SearchEnum"},"SearchNodeResultData":{"type":"object","properties":{"results_output_id":{"type":"string"},"results":{"type":"array","items":{"$ref":"#/components/schemas/SearchResult"},"description":"The results of the search. Each result represents a chunk that matches the search query."},"text_output_id":{"type":"string"},"text":{"type":["string","null"]}},"required":["results_output_id","results","text_output_id"],"title":"SearchNodeResultData"},"SearchNodeResult":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/SearchEnum"},"data":{"$ref":"#/components/schemas/SearchNodeResultData"}},"required":["type","data"],"description":"A Node Result Event emitted from a Search Node.","title":"SearchNodeResult"},"TemplatingEnum":{"type":"string","enum":["TEMPLATING"],"title":"TemplatingEnum"},"TemplatingNodeStringResult":{"type":"object","properties":{"id":{"type":"string"},"type":{"$ref":"#/components/schemas/StringEnum"},"value":{"type":["string","null"]}},"required":["id","type","value"],"title":"TemplatingNodeStringResult"},"TemplatingNodeNumberResult":{"type":"object","properties":{"id":{"type":"string"},"type":{"$ref":"#/components/schemas/NumberEnum"},"value":{"type":["number","null"],"format":"double"}},"required":["id","type","value"],"title":"TemplatingNodeNumberResult"},"TemplatingNodeJsonResult":{"type":"object","properties":{"id":{"type":"string"},"type":{"$ref":"#/components/schemas/JsonEnum"},"value":{"oneOf":[{"description":"Any type"},{"type":"null"}]}},"required":["id","type","value"],"title":"TemplatingNodeJsonResult"},"TemplatingNodeChatHistoryResult":{"type":"object","properties":{"id":{"type":"string"},"type":{"$ref":"#/components/schemas/ChatHistoryEnum"},"value":{"type":["array","null"],"items":{"$ref":"#/components/schemas/ChatMessage"}}},"required":["id","type","value"],"title":"TemplatingNodeChatHistoryResult"},"TemplatingNodeSearchResultsResult":{"type":"object","properties":{"id":{"type":"string"},"type":{"$ref":"#/components/schemas/SearchResultsEnum"},"value":{"type":["array","null"],"items":{"$ref":"#/components/schemas/SearchResult"}}},"required":["id","type","value"],"title":"TemplatingNodeSearchResultsResult"},"TemplatingNodeErrorResult":{"type":"object","properties":{"id":{"type":"string"},"type":{"$ref":"#/components/schemas/ErrorEnum"},"value":{"oneOf":[{"$ref":"#/components/schemas/VellumError"},{"type":"null"}]}},"required":["id","type","value"],"title":"TemplatingNodeErrorResult"},"TemplatingNodeArrayResult":{"type":"object","properties":{"id":{"type":"string"},"type":{"$ref":"#/components/schemas/ArrayEnum"},"value":{"type":["array","null"],"items":{"$ref":"#/components/schemas/VellumValue"}}},"required":["id","type","value"],"title":"TemplatingNodeArrayResult"},"TemplatingNodeFunctionCallResult":{"type":"object","properties":{"id":{"type":"string"},"type":{"$ref":"#/components/schemas/FunctionCallEnum"},"value":{"oneOf":[{"$ref":"#/components/schemas/FunctionCall"},{"type":"null"}]}},"required":["id","type","value"],"title":"TemplatingNodeFunctionCallResult"},"TemplatingNodeResultOutput":{"oneOf":[{"$ref":"#/components/schemas/TemplatingNodeStringResult"},{"$ref":"#/components/schemas/TemplatingNodeNumberResult"},{"$ref":"#/components/schemas/TemplatingNodeJsonResult"},{"$ref":"#/components/schemas/TemplatingNodeChatHistoryResult"},{"$ref":"#/components/schemas/TemplatingNodeSearchResultsResult"},{"$ref":"#/components/schemas/TemplatingNodeErrorResult"},{"$ref":"#/components/schemas/TemplatingNodeArrayResult"},{"$ref":"#/components/schemas/TemplatingNodeFunctionCallResult"}],"title":"TemplatingNodeResultOutput"},"TemplatingNodeResultData":{"type":"object","properties":{"output":{"$ref":"#/components/schemas/TemplatingNodeResultOutput"}},"required":["output"],"title":"TemplatingNodeResultData"},"TemplatingNodeResult":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/TemplatingEnum"},"data":{"$ref":"#/components/schemas/TemplatingNodeResultData"}},"required":["type","data"],"description":"A Node Result Event emitted from a Templating Node.","title":"TemplatingNodeResult"},"CodeExecutionEnum":{"type":"string","enum":["CODE_EXECUTION"],"title":"CodeExecutionEnum"},"CodeExecutionNodeStringResult":{"type":"object","properties":{"id":{"type":"string"},"type":{"$ref":"#/components/schemas/StringEnum"},"value":{"type":["string","null"]}},"required":["id","type","value"],"title":"CodeExecutionNodeStringResult"},"CodeExecutionNodeNumberResult":{"type":"object","properties":{"id":{"type":"string"},"type":{"$ref":"#/components/schemas/NumberEnum"},"value":{"type":["number","null"],"format":"double"}},"required":["id","type","value"],"title":"CodeExecutionNodeNumberResult"},"CodeExecutionNodeJsonResult":{"type":"object","properties":{"id":{"type":"string"},"type":{"$ref":"#/components/schemas/JsonEnum"},"value":{"oneOf":[{"description":"Any type"},{"type":"null"}]}},"required":["id","type","value"],"title":"CodeExecutionNodeJsonResult"},"CodeExecutionNodeChatHistoryResult":{"type":"object","properties":{"id":{"type":"string"},"type":{"$ref":"#/components/schemas/ChatHistoryEnum"},"value":{"type":["array","null"],"items":{"$ref":"#/components/schemas/ChatMessage"}}},"required":["id","type","value"],"title":"CodeExecutionNodeChatHistoryResult"},"CodeExecutionNodeSearchResultsResult":{"type":"object","properties":{"id":{"type":"string"},"type":{"$ref":"#/components/schemas/SearchResultsEnum"},"value":{"type":["array","null"],"items":{"$ref":"#/components/schemas/SearchResult"}}},"required":["id","type","value"],"title":"CodeExecutionNodeSearchResultsResult"},"CodeExecutionNodeErrorResult":{"type":"object","properties":{"id":{"type":"string"},"type":{"$ref":"#/components/schemas/ErrorEnum"},"value":{"oneOf":[{"$ref":"#/components/schemas/VellumError"},{"type":"null"}]}},"required":["id","type","value"],"title":"CodeExecutionNodeErrorResult"},"CodeExecutionNodeArrayResult":{"type":"object","properties":{"id":{"type":"string"},"type":{"$ref":"#/components/schemas/ArrayEnum"},"value":{"type":["array","null"],"items":{"$ref":"#/components/schemas/VellumValue"}}},"required":["id","type","value"],"title":"CodeExecutionNodeArrayResult"},"CodeExecutionNodeFunctionCallResult":{"type":"object","properties":{"id":{"type":"string"},"type":{"$ref":"#/components/schemas/FunctionCallEnum"},"value":{"oneOf":[{"$ref":"#/components/schemas/FunctionCall"},{"type":"null"}]}},"required":["id","type","value"],"title":"CodeExecutionNodeFunctionCallResult"},"CodeExecutionNodeResultOutput":{"oneOf":[{"$ref":"#/components/schemas/CodeExecutionNodeStringResult"},{"$ref":"#/components/schemas/CodeExecutionNodeNumberResult"},{"$ref":"#/components/schemas/CodeExecutionNodeJsonResult"},{"$ref":"#/components/schemas/CodeExecutionNodeChatHistoryResult"},{"$ref":"#/components/schemas/CodeExecutionNodeSearchResultsResult"},{"$ref":"#/components/schemas/CodeExecutionNodeErrorResult"},{"$ref":"#/components/schemas/CodeExecutionNodeArrayResult"},{"$ref":"#/components/schemas/CodeExecutionNodeFunctionCallResult"}],"title":"CodeExecutionNodeResultOutput"},"CodeExecutionNodeResultData":{"type":"object","properties":{"output":{"$ref":"#/components/schemas/CodeExecutionNodeResultOutput"},"log_output_id":{"type":["string","null"]}},"required":["output"],"title":"CodeExecutionNodeResultData"},"CodeExecutionNodeResult":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/CodeExecutionEnum"},"data":{"$ref":"#/components/schemas/CodeExecutionNodeResultData"}},"required":["type","data"],"description":"A Node Result Event emitted from a Code Execution Node.","title":"CodeExecutionNodeResult"},"ConditionalEnum":{"type":"string","enum":["CONDITIONAL"],"title":"ConditionalEnum"},"ConditionalNodeResultData":{"type":"object","properties":{"source_handle_id":{"type":["string","null"]}},"title":"ConditionalNodeResultData"},"ConditionalNodeResult":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/ConditionalEnum"},"data":{"$ref":"#/components/schemas/ConditionalNodeResultData"}},"required":["type","data"],"description":"A Node Result Event emitted from a Conditional Node.","title":"ConditionalNodeResult"},"ApiEnum":{"type":"string","enum":["API"],"title":"ApiEnum"},"ApiNodeResultData":{"type":"object","properties":{"json":{"type":["object","null"],"additionalProperties":{"description":"Any type"}},"text_output_id":{"type":"string"},"text":{"type":["string","null"]},"json_output_id":{"type":"string"},"status_code_output_id":{"type":"string"},"status_code":{"type":"integer"}},"required":["text_output_id","json_output_id","status_code_output_id","status_code"],"title":"ApiNodeResultData"},"ApiNodeResult":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/ApiEnum"},"data":{"$ref":"#/components/schemas/ApiNodeResultData"}},"required":["type","data"],"description":"A Node Result Event emitted from an API Node.","title":"ApiNodeResult"},"TerminalEnum":{"type":"string","enum":["TERMINAL"],"title":"TerminalEnum"},"TerminalNodeStringResult":{"type":"object","properties":{"id":{"type":["string","null"],"format":"uuid"},"name":{"type":"string","description":"The unique name given to the terminal node that produced this output."},"type":{"$ref":"#/components/schemas/StringEnum"},"value":{"type":["string","null"]}},"required":["name","type","value"],"title":"TerminalNodeStringResult"},"TerminalNodeNumberResult":{"type":"object","properties":{"id":{"type":["string","null"],"format":"uuid"},"name":{"type":"string","description":"The unique name given to the terminal node that produced this output."},"type":{"$ref":"#/components/schemas/NumberEnum"},"value":{"type":["number","null"],"format":"double"}},"required":["name","type","value"],"title":"TerminalNodeNumberResult"},"TerminalNodeJsonResult":{"type":"object","properties":{"id":{"type":["string","null"],"format":"uuid"},"name":{"type":"string","description":"The unique name given to the terminal node that produced this output."},"type":{"$ref":"#/components/schemas/JsonEnum"},"value":{"oneOf":[{"description":"Any type"},{"type":"null"}]}},"required":["name","type","value"],"title":"TerminalNodeJsonResult"},"TerminalNodeChatHistoryResult":{"type":"object","properties":{"id":{"type":["string","null"],"format":"uuid"},"name":{"type":"string","description":"The unique name given to the terminal node that produced this output."},"type":{"$ref":"#/components/schemas/ChatHistoryEnum"},"value":{"type":["array","null"],"items":{"$ref":"#/components/schemas/ChatMessage"}}},"required":["name","type","value"],"title":"TerminalNodeChatHistoryResult"},"TerminalNodeSearchResultsResult":{"type":"object","properties":{"id":{"type":["string","null"],"format":"uuid"},"name":{"type":"string","description":"The unique name given to the terminal node that produced this output."},"type":{"$ref":"#/components/schemas/SearchResultsEnum"},"value":{"type":["array","null"],"items":{"$ref":"#/components/schemas/SearchResult"}}},"required":["name","type","value"],"title":"TerminalNodeSearchResultsResult"},"TerminalNodeErrorResult":{"type":"object","properties":{"id":{"type":["string","null"],"format":"uuid"},"name":{"type":"string","description":"The unique name given to the terminal node that produced this output."},"type":{"$ref":"#/components/schemas/ErrorEnum"},"value":{"oneOf":[{"$ref":"#/components/schemas/VellumError"},{"type":"null"}]}},"required":["name","type","value"],"title":"TerminalNodeErrorResult"},"TerminalNodeArrayResult":{"type":"object","properties":{"id":{"type":["string","null"],"format":"uuid"},"name":{"type":"string","description":"The unique name given to the terminal node that produced this output."},"type":{"$ref":"#/components/schemas/ArrayEnum"},"value":{"type":["array","null"],"items":{"$ref":"#/components/schemas/VellumValue"}}},"required":["name","type","value"],"title":"TerminalNodeArrayResult"},"TerminalNodeFunctionCallResult":{"type":"object","properties":{"id":{"type":["string","null"],"format":"uuid"},"name":{"type":"string","description":"The unique name given to the terminal node that produced this output."},"type":{"$ref":"#/components/schemas/FunctionCallEnum"},"value":{"oneOf":[{"$ref":"#/components/schemas/FunctionCall"},{"type":"null"}]}},"required":["name","type","value"],"title":"TerminalNodeFunctionCallResult"},"TerminalNodeResultOutput":{"oneOf":[{"$ref":"#/components/schemas/TerminalNodeStringResult"},{"$ref":"#/components/schemas/TerminalNodeNumberResult"},{"$ref":"#/components/schemas/TerminalNodeJsonResult"},{"$ref":"#/components/schemas/TerminalNodeChatHistoryResult"},{"$ref":"#/components/schemas/TerminalNodeSearchResultsResult"},{"$ref":"#/components/schemas/TerminalNodeErrorResult"},{"$ref":"#/components/schemas/TerminalNodeArrayResult"},{"$ref":"#/components/schemas/TerminalNodeFunctionCallResult"}],"title":"TerminalNodeResultOutput"},"TerminalNodeResultData":{"type":"object","properties":{"output":{"$ref":"#/components/schemas/TerminalNodeResultOutput"}},"required":["output"],"title":"TerminalNodeResultData"},"TerminalNodeResult":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/TerminalEnum"},"data":{"$ref":"#/components/schemas/TerminalNodeResultData"}},"required":["type","data"],"description":"A Node Result Event emitted from a Terminal Node.","title":"TerminalNodeResult"},"MergeEnum":{"type":"string","enum":["MERGE"],"title":"MergeEnum"},"MergeNodeResultData":{"type":"object","properties":{"paused_node_data":{"type":["object","null"],"additionalProperties":{"description":"Any type"}}},"title":"MergeNodeResultData"},"MergeNodeResult":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/MergeEnum"},"data":{"$ref":"#/components/schemas/MergeNodeResultData"}},"required":["type","data"],"description":"A Node Result Event emitted from a Merge Node.","title":"MergeNodeResult"},"SubworkflowEnum":{"type":"string","enum":["SUBWORKFLOW"],"title":"SubworkflowEnum"},"SubworkflowNodeResultData":{"type":"object","properties":{"execution_id":{"type":["string","null"],"format":"uuid"}},"title":"SubworkflowNodeResultData"},"SubworkflowNodeResult":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/SubworkflowEnum"},"data":{"$ref":"#/components/schemas/SubworkflowNodeResultData"}},"required":["type"],"description":"A Node Result Event emitted from a Subworkflow Node.","title":"SubworkflowNodeResult"},"MetricEnum":{"type":"string","enum":["METRIC"],"title":"MetricEnum"},"MetricNodeResult":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/MetricEnum"}},"required":["type"],"description":"A Node Result Event emitted from a Metric Node.","title":"MetricNodeResult"},"MapEnum":{"type":"string","enum":["MAP"],"title":"MapEnum"},"IterationStateEnum":{"type":"string","enum":["INITIATED","FULFILLED","REJECTED"],"description":"* `INITIATED` - INITIATED\n* `FULFILLED` - FULFILLED\n* `REJECTED` - REJECTED","title":"IterationStateEnum"},"MapNodeResultData":{"type":"object","properties":{"execution_ids":{"type":"array","items":{"type":"string","format":"uuid"}},"iteration_state":{"oneOf":[{"$ref":"#/components/schemas/IterationStateEnum"},{"type":"null"}]}},"required":["execution_ids"],"title":"MapNodeResultData"},"MapNodeResult":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/MapEnum"},"data":{"$ref":"#/components/schemas/MapNodeResultData"}},"required":["type"],"description":"A Node Result Event emitted from a Map Node.","title":"MapNodeResult"},"WorkflowNodeResultData":{"oneOf":[{"$ref":"#/components/schemas/PromptNodeResult"},{"$ref":"#/components/schemas/SearchNodeResult"},{"$ref":"#/components/schemas/TemplatingNodeResult"},{"$ref":"#/components/schemas/CodeExecutionNodeResult"},{"$ref":"#/components/schemas/ConditionalNodeResult"},{"$ref":"#/components/schemas/ApiNodeResult"},{"$ref":"#/components/schemas/TerminalNodeResult"},{"$ref":"#/components/schemas/MergeNodeResult"},{"$ref":"#/components/schemas/SubworkflowNodeResult"},{"$ref":"#/components/schemas/MetricNodeResult"},{"$ref":"#/components/schemas/MapNodeResult"}],"title":"WorkflowNodeResultData"},"NodeInputCompiledStringValue":{"type":"object","properties":{"node_input_id":{"type":"string"},"key":{"type":"string"},"type":{"$ref":"#/components/schemas/StringEnum"},"value":{"type":["string","null"]}},"required":["node_input_id","key","type","value"],"title":"NodeInputCompiledStringValue"},"NodeInputCompiledNumberValue":{"type":"object","properties":{"node_input_id":{"type":"string"},"key":{"type":"string"},"type":{"$ref":"#/components/schemas/NumberEnum"},"value":{"type":["number","null"],"format":"double"}},"required":["node_input_id","key","type","value"],"title":"NodeInputCompiledNumberValue"},"NodeInputCompiledJsonValue":{"type":"object","properties":{"node_input_id":{"type":"string"},"key":{"type":"string"},"type":{"$ref":"#/components/schemas/JsonEnum"},"value":{"oneOf":[{"description":"Any type"},{"type":"null"}]}},"required":["node_input_id","key","type","value"],"title":"NodeInputCompiledJsonValue"},"NodeInputCompiledChatHistoryValue":{"type":"object","properties":{"node_input_id":{"type":"string"},"key":{"type":"string"},"type":{"$ref":"#/components/schemas/ChatHistoryEnum"},"value":{"type":["array","null"],"items":{"$ref":"#/components/schemas/ChatMessage"}}},"required":["node_input_id","key","type","value"],"title":"NodeInputCompiledChatHistoryValue"},"NodeInputCompiledSearchResultsValue":{"type":"object","properties":{"node_input_id":{"type":"string"},"key":{"type":"string"},"type":{"$ref":"#/components/schemas/SearchResultsEnum"},"value":{"type":["array","null"],"items":{"$ref":"#/components/schemas/SearchResult"}}},"required":["node_input_id","key","type","value"],"title":"NodeInputCompiledSearchResultsValue"},"NodeInputCompiledErrorValue":{"type":"object","properties":{"node_input_id":{"type":"string"},"key":{"type":"string"},"type":{"$ref":"#/components/schemas/ErrorEnum"},"value":{"oneOf":[{"$ref":"#/components/schemas/VellumError"},{"type":"null"}]}},"required":["node_input_id","key","type","value"],"title":"NodeInputCompiledErrorValue"},"NodeInputCompiledArrayValue":{"type":"object","properties":{"node_input_id":{"type":"string"},"key":{"type":"string"},"type":{"$ref":"#/components/schemas/ArrayEnum"},"value":{"type":["array","null"],"items":{"$ref":"#/components/schemas/VellumValue"}}},"required":["node_input_id","key","type","value"],"title":"NodeInputCompiledArrayValue"},"NodeInputCompiledFunctionCallValue":{"type":"object","properties":{"node_input_id":{"type":"string"},"key":{"type":"string"},"type":{"$ref":"#/components/schemas/FunctionCallEnum"},"value":{"oneOf":[{"$ref":"#/components/schemas/FunctionCall"},{"type":"null"}]}},"required":["node_input_id","key","type","value"],"title":"NodeInputCompiledFunctionCallValue"},"SecretEnum":{"type":"string","enum":["SECRET"],"title":"SecretEnum"},"VellumSecret":{"type":"object","properties":{"name":{"type":"string"}},"required":["name"],"title":"VellumSecret"},"NodeInputCompiledSecretValue":{"type":"object","properties":{"node_input_id":{"type":"string"},"key":{"type":"string"},"type":{"$ref":"#/components/schemas/SecretEnum"},"value":{"$ref":"#/components/schemas/VellumSecret"}},"required":["node_input_id","key","type","value"],"title":"NodeInputCompiledSecretValue"},"NodeInputCompiledAudioValue":{"type":"object","properties":{"node_input_id":{"type":"string"},"key":{"type":"string"},"type":{"$ref":"#/components/schemas/AudioEnum"},"value":{"oneOf":[{"$ref":"#/components/schemas/VellumAudio"},{"type":"null"}]}},"required":["node_input_id","key","type","value"],"title":"NodeInputCompiledAudioValue"},"NodeInputCompiledVideoValue":{"type":"object","properties":{"node_input_id":{"type":"string"},"key":{"type":"string"},"type":{"$ref":"#/components/schemas/VideoEnum"},"value":{"oneOf":[{"$ref":"#/components/schemas/VellumVideo"},{"type":"null"}]}},"required":["node_input_id","key","type","value"],"title":"NodeInputCompiledVideoValue"},"NodeInputCompiledImageValue":{"type":"object","properties":{"node_input_id":{"type":"string"},"key":{"type":"string"},"type":{"$ref":"#/components/schemas/ImageEnum"},"value":{"oneOf":[{"$ref":"#/components/schemas/VellumImage"},{"type":"null"}]}},"required":["node_input_id","key","type","value"],"title":"NodeInputCompiledImageValue"},"NodeInputCompiledDocumentValue":{"type":"object","properties":{"node_input_id":{"type":"string"},"key":{"type":"string"},"type":{"$ref":"#/components/schemas/DocumentEnum"},"value":{"oneOf":[{"$ref":"#/components/schemas/VellumDocument"},{"type":"null"}]}},"required":["node_input_id","key","type","value"],"title":"NodeInputCompiledDocumentValue"},"NodeInputVariableCompiledValue":{"oneOf":[{"$ref":"#/components/schemas/NodeInputCompiledStringValue"},{"$ref":"#/components/schemas/NodeInputCompiledNumberValue"},{"$ref":"#/components/schemas/NodeInputCompiledJsonValue"},{"$ref":"#/components/schemas/NodeInputCompiledChatHistoryValue"},{"$ref":"#/components/schemas/NodeInputCompiledSearchResultsValue"},{"$ref":"#/components/schemas/NodeInputCompiledErrorValue"},{"$ref":"#/components/schemas/NodeInputCompiledArrayValue"},{"$ref":"#/components/schemas/NodeInputCompiledFunctionCallValue"},{"$ref":"#/components/schemas/NodeInputCompiledSecretValue"},{"$ref":"#/components/schemas/NodeInputCompiledAudioValue"},{"$ref":"#/components/schemas/NodeInputCompiledVideoValue"},{"$ref":"#/components/schemas/NodeInputCompiledImageValue"},{"$ref":"#/components/schemas/NodeInputCompiledDocumentValue"}],"title":"NodeInputVariableCompiledValue"},"InitiatedWorkflowNodeResultEvent":{"type":"object","properties":{"id":{"type":"string"},"node_id":{"type":"string"},"node_result_id":{"type":"string"},"state":{"$ref":"#/components/schemas/InitiatedEnum"},"ts":{"type":["string","null"],"format":"date-time"},"data":{"oneOf":[{"$ref":"#/components/schemas/WorkflowNodeResultData"},{"type":"null"}]},"source_execution_id":{"type":["string","null"]},"input_values":{"type":["array","null"],"items":{"$ref":"#/components/schemas/NodeInputVariableCompiledValue"}}},"required":["id","node_id","node_result_id","state","data"],"description":"An event that indicates that the node has initiated its execution.","title":"InitiatedWorkflowNodeResultEvent"},"NodeOutputCompiledStringValue":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/StringEnum"},"value":{"type":["string","null"]},"node_output_id":{"type":"string"},"state":{"$ref":"#/components/schemas/WorkflowNodeResultEventState"}},"required":["type","value","node_output_id"],"description":"An output returned by a node that is of type STRING.","title":"NodeOutputCompiledStringValue"},"NodeOutputCompiledNumberValue":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/NumberEnum"},"value":{"type":["number","null"],"format":"double"},"node_output_id":{"type":"string"},"state":{"$ref":"#/components/schemas/WorkflowNodeResultEventState"}},"required":["type","value","node_output_id"],"description":"An output returned by a node that is of type NUMBER.","title":"NodeOutputCompiledNumberValue"},"NodeOutputCompiledJsonValue":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/JsonEnum"},"value":{"oneOf":[{"description":"Any type"},{"type":"null"}]},"node_output_id":{"type":"string"},"state":{"$ref":"#/components/schemas/WorkflowNodeResultEventState"}},"required":["type","value","node_output_id"],"description":"An output returned by a node that is of type JSON.","title":"NodeOutputCompiledJsonValue"},"NodeOutputCompiledChatHistoryValue":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/ChatHistoryEnum"},"value":{"type":["array","null"],"items":{"$ref":"#/components/schemas/ChatMessage"}},"node_output_id":{"type":"string"},"state":{"$ref":"#/components/schemas/WorkflowNodeResultEventState"}},"required":["type","value","node_output_id"],"description":"An output returned by a node that is of type CHAT_HISTORY.","title":"NodeOutputCompiledChatHistoryValue"},"NodeOutputCompiledSearchResultsValue":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/SearchResultsEnum"},"value":{"type":["array","null"],"items":{"$ref":"#/components/schemas/SearchResult"}},"node_output_id":{"type":"string"},"state":{"$ref":"#/components/schemas/WorkflowNodeResultEventState"}},"required":["type","value","node_output_id"],"description":"An output returned by a node that is of type SEARCH_RESULTS.","title":"NodeOutputCompiledSearchResultsValue"},"NodeOutputCompiledErrorValue":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/ErrorEnum"},"value":{"oneOf":[{"$ref":"#/components/schemas/VellumError"},{"type":"null"}]},"node_output_id":{"type":"string"},"state":{"$ref":"#/components/schemas/WorkflowNodeResultEventState"}},"required":["type","value","node_output_id"],"description":"An output returned by a node that is of type ERROR.","title":"NodeOutputCompiledErrorValue"},"NodeOutputCompiledArrayValue":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/ArrayEnum"},"value":{"type":["array","null"],"items":{"$ref":"#/components/schemas/VellumValue"}},"node_output_id":{"type":"string"},"state":{"$ref":"#/components/schemas/WorkflowNodeResultEventState"}},"required":["type","value","node_output_id"],"description":"An output returned by a node that is of type ARRAY.","title":"NodeOutputCompiledArrayValue"},"NodeOutputCompiledFunctionCallValue":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/FunctionCallEnum"},"value":{"oneOf":[{"$ref":"#/components/schemas/FunctionCall"},{"type":"null"}]},"node_output_id":{"type":"string"},"state":{"$ref":"#/components/schemas/WorkflowNodeResultEventState"}},"required":["type","value","node_output_id"],"description":"An output returned by a node that is of type FUNCTION_CALL.","title":"NodeOutputCompiledFunctionCallValue"},"NodeOutputCompiledThinkingValue":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/ThinkingEnum"},"value":{"oneOf":[{"$ref":"#/components/schemas/StringVellumValue"},{"type":"null"}]},"node_output_id":{"type":"string"},"state":{"$ref":"#/components/schemas/WorkflowNodeResultEventState"}},"required":["type","value","node_output_id"],"description":"An output returned by a node that is of type THINKING.","title":"NodeOutputCompiledThinkingValue"},"NodeOutputCompiledValue":{"oneOf":[{"$ref":"#/components/schemas/NodeOutputCompiledStringValue"},{"$ref":"#/components/schemas/NodeOutputCompiledNumberValue"},{"$ref":"#/components/schemas/NodeOutputCompiledJsonValue"},{"$ref":"#/components/schemas/NodeOutputCompiledChatHistoryValue"},{"$ref":"#/components/schemas/NodeOutputCompiledSearchResultsValue"},{"$ref":"#/components/schemas/NodeOutputCompiledErrorValue"},{"$ref":"#/components/schemas/NodeOutputCompiledArrayValue"},{"$ref":"#/components/schemas/NodeOutputCompiledFunctionCallValue"},{"$ref":"#/components/schemas/NodeOutputCompiledThinkingValue"}],"title":"NodeOutputCompiledValue"},"StreamingWorkflowNodeResultEvent":{"type":"object","properties":{"id":{"type":"string"},"node_id":{"type":"string"},"node_result_id":{"type":"string"},"state":{"$ref":"#/components/schemas/StreamingEnum"},"ts":{"type":["string","null"],"format":"date-time"},"data":{"oneOf":[{"$ref":"#/components/schemas/WorkflowNodeResultData"},{"type":"null"}]},"source_execution_id":{"type":["string","null"]},"output":{"oneOf":[{"$ref":"#/components/schemas/NodeOutputCompiledValue"},{"type":"null"}]},"output_index":{"type":["integer","null"]}},"required":["id","node_id","node_result_id","state","data"],"description":"An event that indicates that the node has execution is in progress.","title":"StreamingWorkflowNodeResultEvent"},"FulfilledWorkflowNodeResultEvent":{"type":"object","properties":{"id":{"type":"string"},"node_id":{"type":"string"},"node_result_id":{"type":"string"},"state":{"$ref":"#/components/schemas/FulfilledEnum"},"ts":{"type":["string","null"],"format":"date-time"},"data":{"oneOf":[{"$ref":"#/components/schemas/WorkflowNodeResultData"},{"type":"null"}]},"source_execution_id":{"type":["string","null"]},"output_values":{"type":"array","items":{"$ref":"#/components/schemas/NodeOutputCompiledValue"}},"mocked":{"type":"boolean"}},"required":["id","node_id","node_result_id","state","data","output_values"],"description":"An event that indicates that the node has fulfilled its execution.","title":"FulfilledWorkflowNodeResultEvent"},"RejectedWorkflowNodeResultEvent":{"type":"object","properties":{"id":{"type":"string"},"node_id":{"type":"string"},"node_result_id":{"type":"string"},"state":{"$ref":"#/components/schemas/RejectedEnum"},"ts":{"type":["string","null"],"format":"date-time"},"data":{"oneOf":[{"$ref":"#/components/schemas/WorkflowNodeResultData"},{"type":"null"}]},"source_execution_id":{"type":["string","null"]},"error":{"$ref":"#/components/schemas/WorkflowEventError"}},"required":["id","node_id","node_result_id","state","data","error"],"description":"An event that indicates that the node has rejected its execution.","title":"RejectedWorkflowNodeResultEvent"},"WorkflowNodeResultEvent":{"oneOf":[{"$ref":"#/components/schemas/InitiatedWorkflowNodeResultEvent"},{"$ref":"#/components/schemas/StreamingWorkflowNodeResultEvent"},{"$ref":"#/components/schemas/FulfilledWorkflowNodeResultEvent"},{"$ref":"#/components/schemas/RejectedWorkflowNodeResultEvent"}],"title":"WorkflowNodeResultEvent"},"WorkflowExecutionNodeResultEvent":{"type":"object","properties":{"execution_id":{"type":"string"},"run_id":{"type":["string","null"]},"external_id":{"type":["string","null"]},"type":{"$ref":"#/components/schemas/NodeEnum"},"data":{"$ref":"#/components/schemas/WorkflowNodeResultEvent"}},"required":["execution_id","type","data"],"description":"A NODE-level event emitted from the workflow's execution.","title":"WorkflowExecutionNodeResultEvent"},"WorkflowStreamEvent":{"oneOf":[{"$ref":"#/components/schemas/WorkflowExecutionWorkflowResultEvent"},{"$ref":"#/components/schemas/WorkflowExecutionNodeResultEvent"}],"title":"WorkflowStreamEvent"},"CheckWorkflowExecutionStatusError":{"type":"object","properties":{"message":{"type":["string","null"]},"code":{"oneOf":[{"$ref":"#/components/schemas/WorkflowExecutionEventErrorCode"},{"type":"null"}]}},"title":"CheckWorkflowExecutionStatusError"},"CheckWorkflowExecutionStatusResponse":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/WorkflowResultEventState"},"outputs":{"type":["object","null"],"additionalProperties":{"description":"Any type"}},"error":{"oneOf":[{"$ref":"#/components/schemas/CheckWorkflowExecutionStatusError"},{"type":"null"}]},"execution_id":{"type":"string"},"execution_detail_url":{"type":["string","null"]}},"required":["status","execution_id"],"description":"Response serializer for workflow execution status check.","title":"CheckWorkflowExecutionStatusResponse"},"CheckWorkflowExecutionStatusErrorResponse":{"type":"object","properties":{"detail":{"type":"string"}},"required":["detail"],"description":"Error response for workflow execution status check.","title":"CheckWorkflowExecutionStatusErrorResponse"},"WorkflowExecutionActualStringRequest":{"type":"object","properties":{"output_id":{"type":["string","null"],"format":"uuid","description":"The Vellum-generated ID of a workflow output. Must provide either this or output_key. output_key is typically preferred."},"output_key":{"type":["string","null"],"description":"The user-defined name of a workflow output. Must provide either this or output_id. Should correspond to the `Name` specified in a Final Output Node. Generally preferred over output_id."},"quality":{"type":["number","null"],"format":"double","description":"Optionally provide a decimal number between 0.0 and 1.0 (inclusive) representing the quality of the output. 0 is the worst, 1 is the best."},"metadata":{"type":["object","null"],"additionalProperties":{"description":"Any type"},"description":"Optionally provide additional metadata about the feedback submission."},"timestamp":{"type":["number","null"],"format":"double","description":"Optionally provide the timestamp representing when this feedback was collected. Used for reporting purposes."},"output_type":{"$ref":"#/components/schemas/StringEnum","description":"The variable type of the output that this actual is being submitted for."},"desired_output_value":{"type":["string","null"],"description":"Optionally provide the value that the output ideally should have been."}},"required":["output_type"],"title":"WorkflowExecutionActualStringRequest"},"WorkflowExecutionActualJsonRequest":{"type":"object","properties":{"output_id":{"type":["string","null"],"format":"uuid","description":"The Vellum-generated ID of a workflow output. Must provide either this or output_key. output_key is typically preferred."},"output_key":{"type":["string","null"],"description":"The user-defined name of a workflow output. Must provide either this or output_id. Should correspond to the `Name` specified in a Final Output Node. Generally preferred over output_id."},"quality":{"type":["number","null"],"format":"double","description":"Optionally provide a decimal number between 0.0 and 1.0 (inclusive) representing the quality of the output. 0 is the worst, 1 is the best."},"metadata":{"type":["object","null"],"additionalProperties":{"description":"Any type"},"description":"Optionally provide additional metadata about the feedback submission."},"timestamp":{"type":["number","null"],"format":"double","description":"Optionally provide the timestamp representing when this feedback was collected. Used for reporting purposes."},"output_type":{"$ref":"#/components/schemas/JsonEnum","description":"The variable type of the output that this actual is being submitted for."},"desired_output_value":{"type":["object","null"],"additionalProperties":{"description":"Any type"},"description":"Optionally provide the value that the output ideally should have been."}},"required":["output_type"],"title":"WorkflowExecutionActualJsonRequest"},"WorkflowExecutionActualChatHistoryRequest":{"type":"object","properties":{"output_id":{"type":["string","null"],"format":"uuid","description":"The Vellum-generated ID of a workflow output. Must provide either this or output_key. output_key is typically preferred."},"output_key":{"type":["string","null"],"description":"The user-defined name of a workflow output. Must provide either this or output_id. Should correspond to the `Name` specified in a Final Output Node. Generally preferred over output_id."},"quality":{"type":["number","null"],"format":"double","description":"Optionally provide a decimal number between 0.0 and 1.0 (inclusive) representing the quality of the output. 0 is the worst, 1 is the best."},"metadata":{"type":["object","null"],"additionalProperties":{"description":"Any type"},"description":"Optionally provide additional metadata about the feedback submission."},"timestamp":{"type":["number","null"],"format":"double","description":"Optionally provide the timestamp representing when this feedback was collected. Used for reporting purposes."},"output_type":{"$ref":"#/components/schemas/ChatHistoryEnum","description":"The variable type of the output that this actual is being submitted for."},"desired_output_value":{"type":["array","null"],"items":{"$ref":"#/components/schemas/ChatMessageRequest"},"description":"Optionally provide the value that the output ideally should have been."}},"required":["output_type"],"title":"WorkflowExecutionActualChatHistoryRequest"},"SubmitWorkflowExecutionActualRequest":{"oneOf":[{"$ref":"#/components/schemas/WorkflowExecutionActualStringRequest"},{"$ref":"#/components/schemas/WorkflowExecutionActualJsonRequest"},{"$ref":"#/components/schemas/WorkflowExecutionActualChatHistoryRequest"}],"title":"SubmitWorkflowExecutionActualRequest"},"SubmitWorkflowExecutionActualsRequest":{"type":"object","properties":{"actuals":{"type":"array","items":{"$ref":"#/components/schemas/SubmitWorkflowExecutionActualRequest"},"description":"Feedback regarding the quality of an output on a previously executed workflow."},"execution_id":{"type":["string","null"],"format":"uuid","description":"The Vellum-generated ID of a previously executed workflow. Must provide either this or external_id."},"external_id":{"type":["string","null"],"description":"The external ID that was originally provided by when executing the workflow, if applicable, that you'd now like to submit actuals for. Must provide either this or execution_id."}},"required":["actuals"],"title":"SubmitWorkflowExecutionActualsRequest"},"submit-workflow-execution-actuals_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"submit-workflow-execution-actuals_Response_200"},"DeploySandboxWorkflowRequest":{"type":"object","properties":{"workflow_deployment_id":{"type":["string","null"],"format":"uuid","description":"The Vellum-generated ID of the Workflow Deployment you'd like to update. Cannot specify both this and workflow_deployment_name. Leave null to create a new Workflow Deployment."},"workflow_deployment_name":{"type":["string","null"],"description":"The unique name of the Workflow Deployment you'd like to either create or update. Cannot specify both this and workflow_deployment_id. If provided and matches an existing Workflow Deployment, that Workflow Deployment will be updated. Otherwise, a new Prompt Deployment will be created."},"label":{"type":["string","null"],"description":"In the event that a new Workflow Deployment is created, this will be the label it's given."},"release_tags":{"type":["array","null"],"items":{"type":"string"},"description":"Optionally provide the release tags that you'd like to be associated with the latest release of the created/updated Prompt Deployment."},"release_description":{"type":["string","null"],"default":"","description":"Optionally provide a description that details what's new in this Release."}},"title":"DeploySandboxWorkflowRequest"},"WorkflowDisplayIcon":{"type":"object","properties":{"src":{"type":["string","null"]},"color":{"type":["string","null"]}},"description":"Icon to be used alongside a Workflow","title":"WorkflowDisplayIcon"},"WorkflowDeploymentDisplayData":{"type":"object","properties":{"icon":{"oneOf":[{"$ref":"#/components/schemas/WorkflowDisplayIcon"},{"type":"null"}],"description":"The icon associated with this Workflow Deployment."}},"description":"Workflow Deployment display data","title":"WorkflowDeploymentDisplayData"},"WorkflowDeploymentRead":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","description":"A name that uniquely identifies this workflow deployment within its workspace"},"label":{"type":"string","description":"A human-readable label for the workflow deployment"},"status":{"$ref":"#/components/schemas/EntityStatus","description":"The current status of the workflow deployment\n\n* `ACTIVE` - Active\n* `ARCHIVED` - Archived\n* `PENDING_DELETION` - Pending Deletion"},"environment":{"oneOf":[{"$ref":"#/components/schemas/EnvironmentEnum"},{"type":"null"}],"description":"Deprecated. The value returned will always be 'PRODUCTION'."},"created":{"type":"string","format":"date-time"},"last_deployed_on":{"type":"string","format":"date-time"},"last_deployed_history_item_id":{"type":"string","format":"uuid","description":"The ID of the history item associated with this Workflow Deployment's LATEST Release Tag"},"input_variables":{"type":"array","items":{"$ref":"#/components/schemas/VellumVariable"},"description":"The input variables this Workflow Deployment expects to receive values for when it is executed."},"output_variables":{"type":"array","items":{"$ref":"#/components/schemas/VellumVariable"},"description":"The output variables this Workflow Deployment produces values for when it's executed."},"description":{"type":["string","null"],"description":"A human-readable description of the workflow deployment"},"display_data":{"oneOf":[{"$ref":"#/components/schemas/WorkflowDeploymentDisplayData"},{"type":"null"}],"description":"Information used to display this Workflow Deployment."}},"required":["id","name","label","created","last_deployed_on","last_deployed_history_item_id","input_variables","output_variables"],"description":"A Workflow Deployment's full details.","title":"WorkflowDeploymentRead"},"ExecuteWorkflowDeploymentStreamRequest":{"type":"object","properties":{"inputs":{"type":"object","additionalProperties":{"description":"Any type"},"description":"A mapping from input name to value."},"trigger":{"type":["string","null"],"description":"The name or ID of a workflow trigger to use for this execution. If not specified, then a default manual trigger will be chosen."},"release_tag":{"type":["string","null"],"description":"Optionally specify a release tag if you want to pin to a specific release of the Workflow Deployment"},"external_id":{"type":["string","null"],"description":"Optionally include a unique identifier for tracking purposes. Must be unique within a given Workspace."},"metadata":{"type":["object","null"],"additionalProperties":{"description":"Any type"},"description":"Arbitrary JSON metadata associated with this request. Can be used to capture additional monitoring data such as user id, session id, etc. for future analysis."},"previous_execution_id":{"type":["string","null"],"format":"uuid","description":"The ID of a previous workflow execution to reference for context."}},"description":"The request to execute a Workflow Deployment stream.","title":"ExecuteWorkflowDeploymentStreamRequest"},"SpanLinkTypeEnum":{"type":"string","enum":["TRIGGERED_BY","PREVIOUS_SPAN","ROOT_SPAN"],"description":"* `TRIGGERED_BY` - TRIGGERED_BY\n* `PREVIOUS_SPAN` - PREVIOUS_SPAN\n* `ROOT_SPAN` - ROOT_SPAN","title":"SpanLinkTypeEnum"},"SpanLink":{"type":"object","properties":{"trace_id":{"type":"string","format":"uuid"},"type":{"$ref":"#/components/schemas/SpanLinkTypeEnum"},"span_context":{"$ref":"#/components/schemas/ParentContext"}},"required":["trace_id","type","span_context"],"title":"SpanLink"},"VellumCodeResourceDefinition":{"type":"object","properties":{"name":{"type":"string"},"module":{"type":"array","items":{"type":"string"},"description":"The module that this resource is defined in."},"exclude_from_monitoring":{"type":["boolean","null"],"description":"Whether this node should be excluded from monitoring views."},"id":{"type":"string","format":"uuid"}},"required":["name","module","id"],"title":"VellumCodeResourceDefinition"},"WorkflowParentContext":{"type":"object","properties":{"parent":{"oneOf":[{"$ref":"#/components/schemas/ParentContext"},{"type":"null"}]},"links":{"type":["array","null"],"items":{"$ref":"#/components/schemas/SpanLink"}},"workflow_definition":{"$ref":"#/components/schemas/VellumCodeResourceDefinition"},"type":{"$ref":"#/components/schemas/WorkflowEnum"},"span_id":{"type":"string","format":"uuid"}},"required":["workflow_definition","type","span_id"],"title":"WorkflowParentContext"},"WorkflowNodeEnum":{"type":"string","enum":["WORKFLOW_NODE"],"title":"WorkflowNodeEnum"},"NodeParentContext":{"type":"object","properties":{"parent":{"oneOf":[{"$ref":"#/components/schemas/ParentContext"},{"type":"null"}]},"links":{"type":["array","null"],"items":{"$ref":"#/components/schemas/SpanLink"}},"node_definition":{"$ref":"#/components/schemas/VellumCodeResourceDefinition"},"type":{"$ref":"#/components/schemas/WorkflowNodeEnum"},"span_id":{"type":"string","format":"uuid"}},"required":["node_definition","type","span_id"],"title":"NodeParentContext"},"WorkflowReleaseTagEnum":{"type":"string","enum":["WORKFLOW_RELEASE_TAG"],"title":"WorkflowReleaseTagEnum"},"WorkflowDeploymentParentContext":{"type":"object","properties":{"parent":{"oneOf":[{"$ref":"#/components/schemas/ParentContext"},{"type":"null"}]},"links":{"type":["array","null"],"items":{"$ref":"#/components/schemas/SpanLink"}},"type":{"$ref":"#/components/schemas/WorkflowReleaseTagEnum"},"span_id":{"type":"string","format":"uuid"},"deployment_id":{"type":"string","format":"uuid"},"deployment_name":{"type":"string"},"deployment_history_item_id":{"type":"string","format":"uuid"},"release_tag_id":{"type":"string","format":"uuid"},"release_tag_name":{"type":"string"},"external_id":{"type":["string","null"]},"metadata":{"type":["object","null"],"additionalProperties":{"description":"Any type"}},"workflow_version_id":{"type":"string","format":"uuid"}},"required":["type","span_id","deployment_id","deployment_name","deployment_history_item_id","release_tag_id","release_tag_name","workflow_version_id"],"title":"WorkflowDeploymentParentContext"},"WorkflowSandboxEnum":{"type":"string","enum":["WORKFLOW_SANDBOX"],"title":"WorkflowSandboxEnum"},"WorkflowSandboxParentContext":{"type":"object","properties":{"parent":{"oneOf":[{"$ref":"#/components/schemas/ParentContext"},{"type":"null"}]},"links":{"type":["array","null"],"items":{"$ref":"#/components/schemas/SpanLink"}},"type":{"$ref":"#/components/schemas/WorkflowSandboxEnum"},"span_id":{"type":"string","format":"uuid"},"sandbox_id":{"type":"string","format":"uuid"},"sandbox_history_item_id":{"type":"string","format":"uuid"},"scenario_id":{"type":"string","format":"uuid"}},"required":["type","span_id","sandbox_id","sandbox_history_item_id","scenario_id"],"title":"WorkflowSandboxParentContext"},"PromptReleaseTagEnum":{"type":"string","enum":["PROMPT_RELEASE_TAG"],"title":"PromptReleaseTagEnum"},"PromptDeploymentParentContext":{"type":"object","properties":{"parent":{"oneOf":[{"$ref":"#/components/schemas/ParentContext"},{"type":"null"}]},"links":{"type":["array","null"],"items":{"$ref":"#/components/schemas/SpanLink"}},"type":{"$ref":"#/components/schemas/PromptReleaseTagEnum"},"span_id":{"type":"string","format":"uuid"},"deployment_id":{"type":"string","format":"uuid"},"deployment_name":{"type":"string"},"deployment_history_item_id":{"type":"string","format":"uuid"},"release_tag_id":{"type":"string","format":"uuid"},"release_tag_name":{"type":"string"},"external_id":{"type":["string","null"]},"metadata":{"type":["object","null"],"additionalProperties":{"description":"Any type"}},"prompt_version_id":{"type":"string","format":"uuid"}},"required":["type","span_id","deployment_id","deployment_name","deployment_history_item_id","release_tag_id","release_tag_name","prompt_version_id"],"title":"PromptDeploymentParentContext"},"ApiRequestEnum":{"type":"string","enum":["API_REQUEST"],"title":"ApiRequestEnum"},"ApiActorTypeEnum":{"type":"string","enum":["ANONYMOUS","WORKSPACE_API_KEY","ENVIRONMENT_API_KEY","JWT","SERVICE_TOKEN"],"description":"* `ANONYMOUS` - ANONYMOUS\n* `WORKSPACE_API_KEY` - WORKSPACE_API_KEY\n* `ENVIRONMENT_API_KEY` - ENVIRONMENT_API_KEY\n* `JWT` - JWT\n* `SERVICE_TOKEN` - SERVICE_TOKEN","title":"ApiActorTypeEnum"},"APIRequestParentContext":{"type":"object","properties":{"parent":{"oneOf":[{"$ref":"#/components/schemas/ParentContext"},{"type":"null"}]},"links":{"type":["array","null"],"items":{"$ref":"#/components/schemas/SpanLink"}},"type":{"$ref":"#/components/schemas/ApiRequestEnum"},"span_id":{"type":"string","format":"uuid"},"api_actor_id":{"type":["string","null"]},"api_actor_type":{"oneOf":[{"$ref":"#/components/schemas/ApiActorTypeEnum"},{"type":"null"}]},"api_actor_label":{"type":["string","null"]}},"required":["type","span_id"],"title":"APIRequestParentContext"},"ExternalEnum":{"type":"string","enum":["EXTERNAL"],"title":"ExternalEnum"},"ExternalParentContext":{"type":"object","properties":{"parent":{"oneOf":[{"$ref":"#/components/schemas/ParentContext"},{"type":"null"}]},"links":{"type":["array","null"],"items":{"$ref":"#/components/schemas/SpanLink"}},"type":{"$ref":"#/components/schemas/ExternalEnum"},"span_id":{"type":"string","format":"uuid"}},"required":["type","span_id"],"title":"ExternalParentContext"},"ScheduledEnum":{"type":"string","enum":["SCHEDULED"],"title":"ScheduledEnum"},"ScheduledTriggerContext":{"type":"object","properties":{"parent":{"oneOf":[{"$ref":"#/components/schemas/ParentContext"},{"type":"null"}]},"links":{"type":["array","null"],"items":{"$ref":"#/components/schemas/SpanLink"}},"type":{"$ref":"#/components/schemas/ScheduledEnum"},"trigger_id":{"type":["string","null"],"format":"uuid"},"span_id":{"type":"string","format":"uuid"}},"required":["type","span_id"],"title":"ScheduledTriggerContext"},"IntegrationEnum":{"type":"string","enum":["INTEGRATION"],"title":"IntegrationEnum"},"IntegrationTriggerContext":{"type":"object","properties":{"parent":{"oneOf":[{"$ref":"#/components/schemas/ParentContext"},{"type":"null"}]},"links":{"type":["array","null"],"items":{"$ref":"#/components/schemas/SpanLink"}},"type":{"$ref":"#/components/schemas/IntegrationEnum"},"trigger_id":{"type":["string","null"],"format":"uuid"},"span_id":{"type":"string","format":"uuid"}},"required":["type","span_id"],"title":"IntegrationTriggerContext"},"ParentContext":{"oneOf":[{"$ref":"#/components/schemas/WorkflowParentContext"},{"$ref":"#/components/schemas/NodeParentContext"},{"$ref":"#/components/schemas/WorkflowDeploymentParentContext"},{"$ref":"#/components/schemas/WorkflowSandboxParentContext"},{"$ref":"#/components/schemas/PromptDeploymentParentContext"},{"$ref":"#/components/schemas/APIRequestParentContext"},{"$ref":"#/components/schemas/ExternalParentContext"},{"$ref":"#/components/schemas/ScheduledTriggerContext"},{"$ref":"#/components/schemas/IntegrationTriggerContext"}],"title":"ParentContext"},"node.execution.initiatedEnum":{"type":"string","enum":["node.execution.initiated"],"title":"node.execution.initiatedEnum"},"NodeExecutionInitiatedBody":{"type":"object","properties":{"node_definition":{"$ref":"#/components/schemas/VellumCodeResourceDefinition"},"inputs":{"type":"object","additionalProperties":{"description":"Any type"}}},"required":["node_definition","inputs"],"title":"NodeExecutionInitiatedBody"},"ApiVersionEnum":{"type":"string","enum":["2024-10-25","2025-07-30"],"description":"* `2024-10-25` - V2024_10_25\n* `2025-07-30` - V2025_07_30","title":"ApiVersionEnum"},"NodeExecutionInitiatedEvent":{"type":"object","properties":{"parent":{"oneOf":[{"$ref":"#/components/schemas/ParentContext"},{"type":"null"}]},"links":{"type":["array","null"],"items":{"$ref":"#/components/schemas/SpanLink"}},"name":{"$ref":"#/components/schemas/node.execution.initiatedEnum"},"body":{"$ref":"#/components/schemas/NodeExecutionInitiatedBody"},"id":{"type":"string","format":"uuid"},"timestamp":{"type":"string","format":"date-time"},"api_version":{"$ref":"#/components/schemas/ApiVersionEnum"},"trace_id":{"type":"string","format":"uuid"},"span_id":{"type":"string","format":"uuid"}},"required":["name","body","id","timestamp","trace_id","span_id"],"title":"NodeExecutionInitiatedEvent"},"node.execution.streamingEnum":{"type":"string","enum":["node.execution.streaming"],"title":"node.execution.streamingEnum"},"BaseOutput":{"type":"object","properties":{"value":{"oneOf":[{"description":"Any type"},{"type":"null"}]},"delta":{"oneOf":[{"description":"Any type"},{"type":"null"}]},"name":{"type":"string"}},"required":["name"],"title":"BaseOutput"},"NodeExecutionStreamingBody":{"type":"object","properties":{"node_definition":{"$ref":"#/components/schemas/VellumCodeResourceDefinition"},"output":{"$ref":"#/components/schemas/BaseOutput"}},"required":["node_definition","output"],"title":"NodeExecutionStreamingBody"},"NodeExecutionStreamingEvent":{"type":"object","properties":{"parent":{"oneOf":[{"$ref":"#/components/schemas/ParentContext"},{"type":"null"}]},"links":{"type":["array","null"],"items":{"$ref":"#/components/schemas/SpanLink"}},"name":{"$ref":"#/components/schemas/node.execution.streamingEnum"},"body":{"$ref":"#/components/schemas/NodeExecutionStreamingBody"},"id":{"type":"string","format":"uuid"},"timestamp":{"type":"string","format":"date-time"},"api_version":{"$ref":"#/components/schemas/ApiVersionEnum"},"trace_id":{"type":"string","format":"uuid"},"span_id":{"type":"string","format":"uuid"}},"required":["name","body","id","timestamp","trace_id","span_id"],"title":"NodeExecutionStreamingEvent"},"node.execution.fulfilledEnum":{"type":"string","enum":["node.execution.fulfilled"],"title":"node.execution.fulfilledEnum"},"InvokedPort":{"type":"object","properties":{"name":{"type":"string"}},"required":["name"],"title":"InvokedPort"},"NodeExecutionFulfilledBody":{"type":"object","properties":{"node_definition":{"$ref":"#/components/schemas/VellumCodeResourceDefinition"},"invoked_ports":{"type":["array","null"],"items":{"$ref":"#/components/schemas/InvokedPort"}},"outputs":{"type":"object","additionalProperties":{"description":"Any type"}},"mocked":{"type":["boolean","null"]},"redacted":{"type":["boolean","null"]}},"required":["node_definition","outputs"],"title":"NodeExecutionFulfilledBody"},"NodeExecutionFulfilledEvent":{"type":"object","properties":{"parent":{"oneOf":[{"$ref":"#/components/schemas/ParentContext"},{"type":"null"}]},"links":{"type":["array","null"],"items":{"$ref":"#/components/schemas/SpanLink"}},"name":{"$ref":"#/components/schemas/node.execution.fulfilledEnum"},"body":{"$ref":"#/components/schemas/NodeExecutionFulfilledBody"},"id":{"type":"string","format":"uuid"},"timestamp":{"type":"string","format":"date-time"},"api_version":{"$ref":"#/components/schemas/ApiVersionEnum"},"trace_id":{"type":"string","format":"uuid"},"span_id":{"type":"string","format":"uuid"}},"required":["name","body","id","timestamp","trace_id","span_id"],"title":"NodeExecutionFulfilledEvent"},"node.execution.rejectedEnum":{"type":"string","enum":["node.execution.rejected"],"title":"node.execution.rejectedEnum"},"VellumSdkErrorRawData":{"oneOf":[{"type":"object","additionalProperties":{"description":"Any type"}},{"type":"string"}],"title":"VellumSdkErrorRawData"},"VellumSdkErrorCodeEnum":{"type":"string","enum":["INVALID_WORKFLOW","INVALID_INPUTS","INVALID_OUTPUTS","INVALID_STATE","INVALID_CODE","INVALID_TEMPLATE","INTERNAL_ERROR","PROVIDER_CREDENTIALS_UNAVAILABLE","INTEGRATION_CREDENTIALS_UNAVAILABLE","PROVIDER_ERROR","PROVIDER_QUOTA_EXCEEDED","USER_DEFINED_ERROR","WORKFLOW_CANCELLED","WORKFLOW_TIMEOUT","NODE_CANCELLED","NODE_TIMEOUT","NODE_EXECUTION"],"description":"* `INVALID_WORKFLOW` - INVALID_WORKFLOW\n* `INVALID_INPUTS` - INVALID_INPUTS\n* `INVALID_OUTPUTS` - INVALID_OUTPUTS\n* `INVALID_STATE` - INVALID_STATE\n* `INVALID_CODE` - INVALID_CODE\n* `INVALID_TEMPLATE` - INVALID_TEMPLATE\n* `INTERNAL_ERROR` - INTERNAL_ERROR\n* `PROVIDER_CREDENTIALS_UNAVAILABLE` - PROVIDER_CREDENTIALS_UNAVAILABLE\n* `INTEGRATION_CREDENTIALS_UNAVAILABLE` - INTEGRATION_CREDENTIALS_UNAVAILABLE\n* `PROVIDER_ERROR` - PROVIDER_ERROR\n* `PROVIDER_QUOTA_EXCEEDED` - PROVIDER_QUOTA_EXCEEDED\n* `USER_DEFINED_ERROR` - USER_DEFINED_ERROR\n* `WORKFLOW_CANCELLED` - WORKFLOW_CANCELLED\n* `WORKFLOW_TIMEOUT` - WORKFLOW_TIMEOUT\n* `NODE_CANCELLED` - NODE_CANCELLED\n* `NODE_TIMEOUT` - NODE_TIMEOUT\n* `NODE_EXECUTION` - NODE_EXECUTION","title":"VellumSdkErrorCodeEnum"},"VellumSdkError":{"type":"object","properties":{"message":{"type":"string"},"raw_data":{"oneOf":[{"$ref":"#/components/schemas/VellumSdkErrorRawData"},{"type":"null"}]},"code":{"$ref":"#/components/schemas/VellumSdkErrorCodeEnum"}},"required":["message","code"],"title":"VellumSdkError"},"NodeExecutionRejectedBody":{"type":"object","properties":{"node_definition":{"$ref":"#/components/schemas/VellumCodeResourceDefinition"},"error":{"$ref":"#/components/schemas/VellumSdkError"},"stacktrace":{"type":["string","null"]}},"required":["node_definition","error"],"title":"NodeExecutionRejectedBody"},"NodeExecutionRejectedEvent":{"type":"object","properties":{"parent":{"oneOf":[{"$ref":"#/components/schemas/ParentContext"},{"type":"null"}]},"links":{"type":["array","null"],"items":{"$ref":"#/components/schemas/SpanLink"}},"name":{"$ref":"#/components/schemas/node.execution.rejectedEnum"},"body":{"$ref":"#/components/schemas/NodeExecutionRejectedBody"},"id":{"type":"string","format":"uuid"},"timestamp":{"type":"string","format":"date-time"},"api_version":{"$ref":"#/components/schemas/ApiVersionEnum"},"trace_id":{"type":"string","format":"uuid"},"span_id":{"type":"string","format":"uuid"}},"required":["name","body","id","timestamp","trace_id","span_id"],"title":"NodeExecutionRejectedEvent"},"node.execution.pausedEnum":{"type":"string","enum":["node.execution.paused"],"title":"node.execution.pausedEnum"},"NodeExecutionPausedBody":{"type":"object","properties":{"node_definition":{"$ref":"#/components/schemas/VellumCodeResourceDefinition"}},"required":["node_definition"],"title":"NodeExecutionPausedBody"},"NodeExecutionPausedEvent":{"type":"object","properties":{"parent":{"oneOf":[{"$ref":"#/components/schemas/ParentContext"},{"type":"null"}]},"links":{"type":["array","null"],"items":{"$ref":"#/components/schemas/SpanLink"}},"name":{"$ref":"#/components/schemas/node.execution.pausedEnum"},"body":{"$ref":"#/components/schemas/NodeExecutionPausedBody"},"id":{"type":"string","format":"uuid"},"timestamp":{"type":"string","format":"date-time"},"api_version":{"$ref":"#/components/schemas/ApiVersionEnum"},"trace_id":{"type":"string","format":"uuid"},"span_id":{"type":"string","format":"uuid"}},"required":["name","body","id","timestamp","trace_id","span_id"],"title":"NodeExecutionPausedEvent"},"node.execution.resumedEnum":{"type":"string","enum":["node.execution.resumed"],"title":"node.execution.resumedEnum"},"NodeExecutionResumedBody":{"type":"object","properties":{"node_definition":{"$ref":"#/components/schemas/VellumCodeResourceDefinition"}},"required":["node_definition"],"title":"NodeExecutionResumedBody"},"NodeExecutionResumedEvent":{"type":"object","properties":{"parent":{"oneOf":[{"$ref":"#/components/schemas/ParentContext"},{"type":"null"}]},"links":{"type":["array","null"],"items":{"$ref":"#/components/schemas/SpanLink"}},"name":{"$ref":"#/components/schemas/node.execution.resumedEnum"},"body":{"$ref":"#/components/schemas/NodeExecutionResumedBody"},"id":{"type":"string","format":"uuid"},"timestamp":{"type":"string","format":"date-time"},"api_version":{"$ref":"#/components/schemas/ApiVersionEnum"},"trace_id":{"type":"string","format":"uuid"},"span_id":{"type":"string","format":"uuid"}},"required":["name","body","id","timestamp","trace_id","span_id"],"title":"NodeExecutionResumedEvent"},"node.execution.logEnum":{"type":"string","enum":["node.execution.log"],"title":"node.execution.logEnum"},"SeverityEnum":{"type":"string","enum":["DEBUG","INFO","WARNING","ERROR"],"description":"* `DEBUG` - DEBUG\n* `INFO` - INFO\n* `WARNING` - WARNING\n* `ERROR` - ERROR","title":"SeverityEnum"},"NodeExecutionLogBody":{"type":"object","properties":{"node_definition":{"$ref":"#/components/schemas/VellumCodeResourceDefinition"},"message":{"type":"string"},"attributes":{"type":["object","null"],"additionalProperties":{"description":"Any type"}},"severity":{"$ref":"#/components/schemas/SeverityEnum"}},"required":["node_definition","message","severity"],"title":"NodeExecutionLogBody"},"NodeExecutionLogEvent":{"type":"object","properties":{"parent":{"oneOf":[{"$ref":"#/components/schemas/ParentContext"},{"type":"null"}]},"links":{"type":["array","null"],"items":{"$ref":"#/components/schemas/SpanLink"}},"name":{"$ref":"#/components/schemas/node.execution.logEnum"},"body":{"$ref":"#/components/schemas/NodeExecutionLogBody"},"id":{"type":"string","format":"uuid"},"timestamp":{"type":"string","format":"date-time"},"api_version":{"$ref":"#/components/schemas/ApiVersionEnum"},"trace_id":{"type":"string","format":"uuid"},"span_id":{"type":"string","format":"uuid"}},"required":["name","body","id","timestamp","trace_id","span_id"],"title":"NodeExecutionLogEvent"},"workflow.execution.initiatedEnum":{"type":"string","enum":["workflow.execution.initiated"],"title":"workflow.execution.initiatedEnum"},"WorkflowExecutionInitiatedBody":{"type":"object","properties":{"workflow_definition":{"$ref":"#/components/schemas/VellumCodeResourceDefinition"},"inputs":{"type":"object","additionalProperties":{"description":"Any type"}},"trigger":{"oneOf":[{"$ref":"#/components/schemas/VellumCodeResourceDefinition"},{"type":"null"}]}},"required":["workflow_definition","inputs"],"title":"WorkflowExecutionInitiatedBody"},"WorkflowExecutionInitiatedEvent":{"type":"object","properties":{"parent":{"oneOf":[{"$ref":"#/components/schemas/ParentContext"},{"type":"null"}]},"links":{"type":["array","null"],"items":{"$ref":"#/components/schemas/SpanLink"}},"name":{"$ref":"#/components/schemas/workflow.execution.initiatedEnum"},"body":{"$ref":"#/components/schemas/WorkflowExecutionInitiatedBody"},"id":{"type":"string","format":"uuid"},"timestamp":{"type":"string","format":"date-time"},"api_version":{"$ref":"#/components/schemas/ApiVersionEnum"},"trace_id":{"type":"string","format":"uuid"},"span_id":{"type":"string","format":"uuid"}},"required":["name","body","id","timestamp","trace_id","span_id"],"title":"WorkflowExecutionInitiatedEvent"},"workflow.execution.streamingEnum":{"type":"string","enum":["workflow.execution.streaming"],"title":"workflow.execution.streamingEnum"},"WorkflowExecutionStreamingBody":{"type":"object","properties":{"workflow_definition":{"$ref":"#/components/schemas/VellumCodeResourceDefinition"},"output":{"$ref":"#/components/schemas/BaseOutput"}},"required":["workflow_definition","output"],"title":"WorkflowExecutionStreamingBody"},"WorkflowExecutionStreamingEvent":{"type":"object","properties":{"parent":{"oneOf":[{"$ref":"#/components/schemas/ParentContext"},{"type":"null"}]},"links":{"type":["array","null"],"items":{"$ref":"#/components/schemas/SpanLink"}},"name":{"$ref":"#/components/schemas/workflow.execution.streamingEnum"},"body":{"$ref":"#/components/schemas/WorkflowExecutionStreamingBody"},"id":{"type":"string","format":"uuid"},"timestamp":{"type":"string","format":"date-time"},"api_version":{"$ref":"#/components/schemas/ApiVersionEnum"},"trace_id":{"type":"string","format":"uuid"},"span_id":{"type":"string","format":"uuid"}},"required":["name","body","id","timestamp","trace_id","span_id"],"title":"WorkflowExecutionStreamingEvent"},"workflow.execution.rejectedEnum":{"type":"string","enum":["workflow.execution.rejected"],"title":"workflow.execution.rejectedEnum"},"WorkflowExecutionRejectedBody":{"type":"object","properties":{"workflow_definition":{"$ref":"#/components/schemas/VellumCodeResourceDefinition"},"error":{"$ref":"#/components/schemas/VellumSdkError"},"stacktrace":{"type":["string","null"]}},"required":["workflow_definition","error"],"title":"WorkflowExecutionRejectedBody"},"WorkflowExecutionRejectedEvent":{"type":"object","properties":{"parent":{"oneOf":[{"$ref":"#/components/schemas/ParentContext"},{"type":"null"}]},"links":{"type":["array","null"],"items":{"$ref":"#/components/schemas/SpanLink"}},"name":{"$ref":"#/components/schemas/workflow.execution.rejectedEnum"},"body":{"$ref":"#/components/schemas/WorkflowExecutionRejectedBody"},"id":{"type":"string","format":"uuid"},"timestamp":{"type":"string","format":"date-time"},"api_version":{"$ref":"#/components/schemas/ApiVersionEnum"},"trace_id":{"type":"string","format":"uuid"},"span_id":{"type":"string","format":"uuid"}},"required":["name","body","id","timestamp","trace_id","span_id"],"title":"WorkflowExecutionRejectedEvent"},"workflow.execution.fulfilledEnum":{"type":"string","enum":["workflow.execution.fulfilled"],"title":"workflow.execution.fulfilledEnum"},"WorkflowExecutionFulfilledBody":{"type":"object","properties":{"workflow_definition":{"$ref":"#/components/schemas/VellumCodeResourceDefinition"},"outputs":{"type":"object","additionalProperties":{"description":"Any type"}},"final_state":{"type":["object","null"],"additionalProperties":{"description":"Any type"}},"server_metadata":{"type":["object","null"],"additionalProperties":{"description":"Any type"}},"redacted":{"type":["boolean","null"]}},"required":["workflow_definition","outputs"],"title":"WorkflowExecutionFulfilledBody"},"WorkflowExecutionFulfilledEvent":{"type":"object","properties":{"parent":{"oneOf":[{"$ref":"#/components/schemas/ParentContext"},{"type":"null"}]},"links":{"type":["array","null"],"items":{"$ref":"#/components/schemas/SpanLink"}},"name":{"$ref":"#/components/schemas/workflow.execution.fulfilledEnum"},"body":{"$ref":"#/components/schemas/WorkflowExecutionFulfilledBody"},"id":{"type":"string","format":"uuid"},"timestamp":{"type":"string","format":"date-time"},"api_version":{"$ref":"#/components/schemas/ApiVersionEnum"},"trace_id":{"type":"string","format":"uuid"},"span_id":{"type":"string","format":"uuid"}},"required":["name","body","id","timestamp","trace_id","span_id"],"title":"WorkflowExecutionFulfilledEvent"},"workflow.execution.pausedEnum":{"type":"string","enum":["workflow.execution.paused"],"title":"workflow.execution.pausedEnum"},"CodeResourceDefinition":{"type":"object","properties":{"name":{"type":"string","description":"The name of the resource, typically a class name."},"module":{"type":"array","items":{"type":"string"},"description":"The module that this resource is defined in."}},"required":["name","module"],"description":"The definition of a resource defined in code.","title":"CodeResourceDefinition"},"ExternalInputDescriptor":{"type":"object","properties":{"types":{"type":"array","items":{"$ref":"#/components/schemas/CodeResourceDefinition"}},"inputs_class":{"oneOf":[{"$ref":"#/components/schemas/CodeResourceDefinition"},{"type":"null"}]},"instance":{"oneOf":[{"description":"Any type"},{"type":"null"}]},"name":{"type":"string"}},"required":["types","name"],"title":"ExternalInputDescriptor"},"WorkflowExecutionPausedBody":{"type":"object","properties":{"workflow_definition":{"$ref":"#/components/schemas/VellumCodeResourceDefinition"},"external_inputs":{"type":"array","items":{"$ref":"#/components/schemas/ExternalInputDescriptor"}}},"required":["workflow_definition","external_inputs"],"title":"WorkflowExecutionPausedBody"},"WorkflowExecutionPausedEvent":{"type":"object","properties":{"parent":{"oneOf":[{"$ref":"#/components/schemas/ParentContext"},{"type":"null"}]},"links":{"type":["array","null"],"items":{"$ref":"#/components/schemas/SpanLink"}},"name":{"$ref":"#/components/schemas/workflow.execution.pausedEnum"},"body":{"$ref":"#/components/schemas/WorkflowExecutionPausedBody"},"id":{"type":"string","format":"uuid"},"timestamp":{"type":"string","format":"date-time"},"api_version":{"$ref":"#/components/schemas/ApiVersionEnum"},"trace_id":{"type":"string","format":"uuid"},"span_id":{"type":"string","format":"uuid"}},"required":["name","body","id","timestamp","trace_id","span_id"],"title":"WorkflowExecutionPausedEvent"},"workflow.execution.resumedEnum":{"type":"string","enum":["workflow.execution.resumed"],"title":"workflow.execution.resumedEnum"},"WorkflowExecutionResumedBody":{"type":"object","properties":{"workflow_definition":{"$ref":"#/components/schemas/VellumCodeResourceDefinition"}},"required":["workflow_definition"],"title":"WorkflowExecutionResumedBody"},"WorkflowExecutionResumedEvent":{"type":"object","properties":{"parent":{"oneOf":[{"$ref":"#/components/schemas/ParentContext"},{"type":"null"}]},"links":{"type":["array","null"],"items":{"$ref":"#/components/schemas/SpanLink"}},"name":{"$ref":"#/components/schemas/workflow.execution.resumedEnum"},"body":{"$ref":"#/components/schemas/WorkflowExecutionResumedBody"},"id":{"type":"string","format":"uuid"},"timestamp":{"type":"string","format":"date-time"},"api_version":{"$ref":"#/components/schemas/ApiVersionEnum"},"trace_id":{"type":"string","format":"uuid"},"span_id":{"type":"string","format":"uuid"}},"required":["name","body","id","timestamp","trace_id","span_id"],"title":"WorkflowExecutionResumedEvent"},"workflow.execution.snapshottedEnum":{"type":"string","enum":["workflow.execution.snapshotted"],"title":"workflow.execution.snapshottedEnum"},"WorkflowExecutionSnapshottedBody":{"type":"object","properties":{"workflow_definition":{"$ref":"#/components/schemas/VellumCodeResourceDefinition"},"edited_by":{"oneOf":[{"$ref":"#/components/schemas/VellumCodeResourceDefinition"},{"type":"null"}]},"state":{"type":"object","additionalProperties":{"description":"Any type"}}},"required":["workflow_definition","state"],"title":"WorkflowExecutionSnapshottedBody"},"WorkflowExecutionSnapshottedEvent":{"type":"object","properties":{"parent":{"oneOf":[{"$ref":"#/components/schemas/ParentContext"},{"type":"null"}]},"links":{"type":["array","null"],"items":{"$ref":"#/components/schemas/SpanLink"}},"name":{"$ref":"#/components/schemas/workflow.execution.snapshottedEnum"},"body":{"$ref":"#/components/schemas/WorkflowExecutionSnapshottedBody"},"id":{"type":"string","format":"uuid"},"timestamp":{"type":"string","format":"date-time"},"api_version":{"$ref":"#/components/schemas/ApiVersionEnum"},"trace_id":{"type":"string","format":"uuid"},"span_id":{"type":"string","format":"uuid"}},"required":["name","body","id","timestamp","trace_id","span_id"],"title":"WorkflowExecutionSnapshottedEvent"},"WorkflowEvent":{"oneOf":[{"$ref":"#/components/schemas/NodeExecutionInitiatedEvent"},{"$ref":"#/components/schemas/NodeExecutionStreamingEvent"},{"$ref":"#/components/schemas/NodeExecutionFulfilledEvent"},{"$ref":"#/components/schemas/NodeExecutionRejectedEvent"},{"$ref":"#/components/schemas/NodeExecutionPausedEvent"},{"$ref":"#/components/schemas/NodeExecutionResumedEvent"},{"$ref":"#/components/schemas/NodeExecutionLogEvent"},{"$ref":"#/components/schemas/WorkflowExecutionInitiatedEvent"},{"$ref":"#/components/schemas/WorkflowExecutionStreamingEvent"},{"$ref":"#/components/schemas/WorkflowExecutionRejectedEvent"},{"$ref":"#/components/schemas/WorkflowExecutionFulfilledEvent"},{"$ref":"#/components/schemas/WorkflowExecutionPausedEvent"},{"$ref":"#/components/schemas/WorkflowExecutionResumedEvent"},{"$ref":"#/components/schemas/WorkflowExecutionSnapshottedEvent"}],"title":"WorkflowEvent"},"V1WorkflowDeploymentsGetParametersStatus":{"type":"string","enum":["ACTIVE","ARCHIVED","PENDING_DELETION"],"title":"V1WorkflowDeploymentsGetParametersStatus"},"SlimWorkflowDeployment":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","description":"A name that uniquely identifies this workflow deployment within its workspace"},"label":{"type":"string","description":"A human-readable label for the workflow deployment"},"status":{"$ref":"#/components/schemas/EntityStatus","description":"The current status of the workflow deployment\n\n* `ACTIVE` - Active\n* `ARCHIVED` - Archived\n* `PENDING_DELETION` - Pending Deletion"},"environment":{"oneOf":[{"$ref":"#/components/schemas/EnvironmentEnum"},{"type":"null"}],"description":"Deprecated. The value returned will always be 'PRODUCTION'."},"created":{"type":"string","format":"date-time"},"last_deployed_on":{"type":"string","format":"date-time"},"input_variables":{"type":"array","items":{"$ref":"#/components/schemas/VellumVariable"},"description":"The input variables this Workflow Deployment expects to receive values for when it is executed."},"output_variables":{"type":"array","items":{"$ref":"#/components/schemas/VellumVariable"},"description":"The output variables this Workflow Deployment will produce when it is executed."},"description":{"type":["string","null"],"description":"A human-readable description of the workflow deployment"}},"required":["id","name","label","created","last_deployed_on","input_variables","output_variables"],"description":"A subset of a Workflow Deployment's full details.","title":"SlimWorkflowDeployment"},"PaginatedSlimWorkflowDeploymentList":{"type":"object","properties":{"count":{"type":"integer"},"next":{"type":["string","null"],"format":"uri"},"previous":{"type":["string","null"],"format":"uri"},"results":{"type":"array","items":{"$ref":"#/components/schemas/SlimWorkflowDeployment"}}},"title":"PaginatedSlimWorkflowDeploymentList"},"IntegrationName":{"type":"string","enum":["SLACK","NOTION","GOOGLE","CALENDLY","CANVA","CLICKUP","CODA","HUBSPOT","INTERCOM","INSTAGRAM","LINEAR","LINKUP","LISTENNOTES","LMNT","LINKEDIN","MAILCHIMP","MIRO","MEM0","MONDAY","NEON","OUTLOOK","MICROSOFT_TEAMS","GITHUB","GOOGLE_SHEETS","GOOGLE_CALENDAR","GOOGLE_CLASSROOM","GOOGLE_DRIVE","GMAIL","GOOGLE_ADS","GOOGLE_ANALYTICS","GOOGLE_BIGQUERY","GOOGLE_DOCS","GOOGLE_PHOTOS","GOOGLE_SEARCH_CONSOLE","GOOGLE_SLIDES","GOOGLE_TASKS","ACCULYNX","AFFINITY","AGENCYZOOM","AHREFS","AIRTABLE","APOLLO","ASANA","ATLASSIAN","BITBUCKET","BOX","BREVO","BREX","BROWSERBASE_TOOL","CAL","CANVAS","ELEVENLABS","EXA","GAMMA","GITLAB","GONG","FIRECRAWL","FIGMA","FIREFLIES","GOOGLE_MAPS","GOOGLEMEET","HEYGEN","JIRA","JUNGLESCOUT","KLAVIYO","PAGERDUTY","PARSERA","PEOPLEDATALABS","PERPLEXITY","POSTHOG","PRODUCTBOARD","QUICKBOOKS","REDDIT","SALESFORCE","SEMRUSH","SEMANTICSCHOLAR","SENDGRID","SERPAPI","SHARE_POINT","SHOPIFY","SHORTCUT","SLACKBOT","SPOTIFY","STRIPE","SUPABASE","TAVILY","TELEGRAM","TIKTOK","TODOIST","WEBFLOW","YOUSEARCH","ZENDESK","ZENROWS","DROPBOX","EVENTBRITE","FACEBOOK","CONFLUENCE","COINBASE","DISCORD","DOCUSIGN","TRELLO","TWITTER","HEYREACH","ACTIVE_CAMPAIGN","CUSTOMER_IO","SEGMENT","WHATSAPP","YOUTUBE"],"description":"* `SLACK` - Slack\n* `NOTION` - Notion\n* `GOOGLE` - Google\n* `CALENDLY` - Calendly\n* `CANVA` - Canva\n* `CLICKUP` - ClickUp\n* `CODA` - Coda\n* `HUBSPOT` - Hubspot\n* `INTERCOM` - Intercom\n* `INSTAGRAM` - Instagram\n* `LINEAR` - Linear\n* `LINKUP` - Linkup\n* `LISTENNOTES` - Listen Notes\n* `LMNT` - LMNT\n* `LINKEDIN` - LinkedIn\n* `MAILCHIMP` - Mailchimp\n* `MIRO` - Miro\n* `MEM0` - Mem0\n* `MONDAY` - Monday\n* `NEON` - Neon\n* `OUTLOOK` - Outlook\n* `MICROSOFT_TEAMS` - Microsoft Teams\n* `GITHUB` - Github\n* `GOOGLE_SHEETS` - Google Sheets\n* `GOOGLE_CALENDAR` - Google Calendar\n* `GOOGLE_CLASSROOM` - Google Classroom\n* `GOOGLE_DRIVE` - Google Drive\n* `GMAIL` - Gmail\n* `GOOGLE_ADS` - Google Ads\n* `GOOGLE_ANALYTICS` - Google Analytics\n* `GOOGLE_BIGQUERY` - Google BigQuery\n* `GOOGLE_DOCS` - Google Docs\n* `GOOGLE_PHOTOS` - Google Photos\n* `GOOGLE_SEARCH_CONSOLE` - Google Search Console\n* `GOOGLE_SLIDES` - Google Slides\n* `GOOGLE_TASKS` - Google Tasks\n* `ACCULYNX` - AccuLynx\n* `AFFINITY` - Affinity\n* `AGENCYZOOM` - AgencyZoom\n* `AHREFS` - Ahrefs\n* `AIRTABLE` - Airtable\n* `APOLLO` - Apollo\n* `ASANA` - Asana\n* `ATLASSIAN` - Atlassian\n* `BITBUCKET` - Bitbucket\n* `BOX` - Box\n* `BREVO` - Brevo\n* `BREX` - Brex\n* `BROWSERBASE_TOOL` - Browserbase Tool\n* `CAL` - Cal\n* `CANVAS` - Canvas\n* `ELEVENLABS` - ElevenLabs\n* `EXA` - Exa\n* `GAMMA` - Gamma\n* `GITLAB` - Gitlab\n* `GONG` - Gong\n* `FIRECRAWL` - Firecrawl\n* `FIGMA` - Figma\n* `FIREFLIES` - Fireflies\n* `GOOGLE_MAPS` - Google Maps\n* `GOOGLEMEET` - Google Meet\n* `HEYGEN` - HeyGen\n* `JIRA` - Jira\n* `JUNGLESCOUT` - Jungle Scout\n* `KLAVIYO` - Klaviyo\n* `PAGERDUTY` - PagerDuty\n* `PARSERA` - Parsera\n* `PEOPLEDATALABS` - People Data Labs\n* `PERPLEXITY` - Perplexity\n* `POSTHOG` - PostHog\n* `PRODUCTBOARD` - Productboard\n* `QUICKBOOKS` - QuickBooks\n* `REDDIT` - Reddit\n* `SALESFORCE` - Salesforce\n* `SEMRUSH` - Semrush\n* `SEMANTICSCHOLAR` - Semantic Scholar\n* `SENDGRID` - SendGrid\n* `SERPAPI` - Serp Api\n* `SHARE_POINT` - SharePoint\n* `SHOPIFY` - Shopify\n* `SHORTCUT` - Shortcut\n* `SLACKBOT` - Slackbot\n* `SPOTIFY` - Spotify\n* `STRIPE` - Stripe\n* `SUPABASE` - Supabase\n* `TAVILY` - Tavily\n* `TELEGRAM` - Telegram\n* `TIKTOK` - TikTok\n* `TODOIST` - Todoist\n* `WEBFLOW` - Webflow\n* `YOUSEARCH` - You Search\n* `ZENDESK` - Zendesk\n* `ZENROWS` - ZenRows\n* `DROPBOX` - Dropbox\n* `EVENTBRITE` - Eventbrite\n* `FACEBOOK` - Facebook\n* `CONFLUENCE` - Confluence\n* `COINBASE` - Coinbase\n* `DISCORD` - Discord\n* `DOCUSIGN` - DocuSign\n* `TRELLO` - Trello\n* `TWITTER` - Twitter\n* `HEYREACH` - HeyReach\n* `ACTIVE_CAMPAIGN` - Active Campaign\n* `CUSTOMER_IO` - Customer.io\n* `SEGMENT` - Segment\n* `WHATSAPP` - WhatsApp\n* `YOUTUBE` - YouTube","title":"IntegrationName"},"WorkflowIntegrationDependency":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/IntegrationEnum"},"name":{"$ref":"#/components/schemas/IntegrationName"},"provider":{"type":"string"},"label":{"type":["string","null"]}},"required":["type","name","provider"],"title":"WorkflowIntegrationDependency"},"ModelProviderEnum":{"type":"string","enum":["MODEL_PROVIDER"],"title":"ModelProviderEnum"},"MLModelHostingInterface":{"type":"string","enum":["ANTHROPIC","AWS_BEDROCK","AZURE_AI_FOUNDRY","AZURE_OPENAI","BASETEN","CEREBRAS","COHERE","CUSTOM","DEEP_SEEK","FIREWORKS_AI","GOOGLE","GOOGLE_VERTEX_AI","GROQ","HUGGINGFACE","IBM_WATSONX","MISTRAL_AI","MOSAICML","MYSTIC","NVIDIA","OPENAI","OPEN_ROUTER","OPENPIPE","PERPLEXITY","PYQ","REPLICATE","SAMBANOVA","TOGETHER_AI","X_AI","FASTWEB","SWISSCOM"],"description":"* `ANTHROPIC` - Anthropic\n* `AWS_BEDROCK` - AWS Bedrock\n* `AZURE_AI_FOUNDRY` - Azure AI Foundry\n* `AZURE_OPENAI` - Azure OpenAI\n* `BASETEN` - BaseTen\n* `CEREBRAS` - Cerebras\n* `COHERE` - Cohere\n* `CUSTOM` - Custom\n* `DEEP_SEEK` - DeepSeek\n* `FIREWORKS_AI` - Fireworks AI\n* `GOOGLE` - Google\n* `GOOGLE_VERTEX_AI` - Google Vertex AI\n* `GROQ` - Groq\n* `HUGGINGFACE` - HuggingFace\n* `IBM_WATSONX` - IBM WatsonX\n* `MISTRAL_AI` - Mistral AI\n* `MOSAICML` - MosaicML\n* `MYSTIC` - Mystic\n* `NVIDIA` - NVIDIA\n* `OPENAI` - OpenAI\n* `OPEN_ROUTER` - Open Router\n* `OPENPIPE` - OpenPipe\n* `PERPLEXITY` - Perplexity\n* `PYQ` - Pyq\n* `REPLICATE` - Replicate\n* `SAMBANOVA` - SambaNova\n* `TOGETHER_AI` - Together AI\n* `X_AI` - xAI\n* `FASTWEB` - Fastweb\n* `SWISSCOM` - Swisscom","title":"MLModelHostingInterface"},"WorkflowModelProviderDependency":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/ModelProviderEnum"},"name":{"$ref":"#/components/schemas/MLModelHostingInterface"},"label":{"type":["string","null"]},"model_name":{"type":"string"}},"required":["type","name","model_name"],"title":"WorkflowModelProviderDependency"},"WorkflowDependency":{"oneOf":[{"$ref":"#/components/schemas/WorkflowIntegrationDependency"},{"$ref":"#/components/schemas/WorkflowModelProviderDependency"}],"title":"WorkflowDependency"},"WorkflowDeploymentReleaseWorkflowVersion":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"input_variables":{"type":"array","items":{"$ref":"#/components/schemas/VellumVariable"}},"output_variables":{"type":"array","items":{"$ref":"#/components/schemas/VellumVariable"}},"dependencies":{"type":["array","null"],"items":{"$ref":"#/components/schemas/WorkflowDependency"}}},"required":["id","input_variables","output_variables"],"description":"The workflow version associated with a workflow deployment release.","title":"WorkflowDeploymentReleaseWorkflowVersion"},"WorkflowDeploymentReleaseWorkflowDeployment":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"}},"required":["id","name"],"title":"WorkflowDeploymentReleaseWorkflowDeployment"},"WorkflowDeploymentRelease":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"created":{"type":"string","format":"date-time"},"environment":{"$ref":"#/components/schemas/ReleaseEnvironment"},"created_by":{"oneOf":[{"$ref":"#/components/schemas/ReleaseCreatedBy"},{"type":"null"}]},"workflow_version":{"$ref":"#/components/schemas/WorkflowDeploymentReleaseWorkflowVersion"},"deployment":{"$ref":"#/components/schemas/WorkflowDeploymentReleaseWorkflowDeployment"},"description":{"type":"string"},"release_tags":{"type":"array","items":{"$ref":"#/components/schemas/ReleaseReleaseTag"}},"reviews":{"type":"array","items":{"$ref":"#/components/schemas/SlimReleaseReview"}}},"required":["id","created","environment","created_by","workflow_version","deployment","release_tags","reviews"],"title":"WorkflowDeploymentRelease"},"PaginatedWorkflowDeploymentReleaseList":{"type":"object","properties":{"count":{"type":"integer"},"next":{"type":["string","null"],"format":"uri"},"previous":{"type":["string","null"],"format":"uri"},"results":{"type":"array","items":{"$ref":"#/components/schemas/WorkflowDeploymentRelease"}}},"title":"PaginatedWorkflowDeploymentReleaseList"},"WorkflowReleaseTagWorkflowDeploymentHistoryItem":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"timestamp":{"type":"string","format":"date-time"}},"required":["id","timestamp"],"title":"WorkflowReleaseTagWorkflowDeploymentHistoryItem"},"WorkflowReleaseTagRead":{"type":"object","properties":{"name":{"type":"string","description":"The name of the Release Tag"},"source":{"$ref":"#/components/schemas/ReleaseTagSource","description":"The source of how the Release Tag was originally created\n\n* `SYSTEM` - System\n* `USER` - User"},"history_item":{"$ref":"#/components/schemas/WorkflowReleaseTagWorkflowDeploymentHistoryItem","description":"Deprecated. Reference the `release` field instead."},"release":{"$ref":"#/components/schemas/ReleaseTagRelease","description":"The Release that this Release Tag points to."}},"required":["name","source","history_item","release"],"title":"WorkflowReleaseTagRead"},"V1WorkflowDeploymentsIdReleaseTagsGetParametersSource":{"type":"string","enum":["SYSTEM","USER"],"title":"V1WorkflowDeploymentsIdReleaseTagsGetParametersSource"},"PaginatedWorkflowReleaseTagReadList":{"type":"object","properties":{"count":{"type":"integer"},"next":{"type":["string","null"],"format":"uri"},"previous":{"type":["string","null"],"format":"uri"},"results":{"type":"array","items":{"$ref":"#/components/schemas/WorkflowReleaseTagRead"}}},"title":"PaginatedWorkflowReleaseTagReadList"},"PatchedWorkflowReleaseTagUpdateRequest":{"type":"object","properties":{"history_item_id":{"type":"string","format":"uuid","description":"The ID of the Workflow Deployment History Item to tag"}},"title":"PatchedWorkflowReleaseTagUpdateRequest"},"WorkflowDeploymentHistoryItem":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"workflow_deployment_id":{"type":"string","format":"uuid"},"timestamp":{"type":"string","format":"date-time"},"label":{"type":"string","description":"A human-readable label for the workflow deployment"},"name":{"type":"string","description":"A name that uniquely identifies this workflow deployment within its workspace"},"input_variables":{"type":"array","items":{"$ref":"#/components/schemas/VellumVariable"}},"output_variables":{"type":"array","items":{"$ref":"#/components/schemas/VellumVariable"}},"description":{"type":["string","null"],"description":"A human-readable description of the workflow deployment"}},"required":["id","workflow_deployment_id","timestamp","label","name","input_variables","output_variables"],"title":"WorkflowDeploymentHistoryItem"},"WorkflowInitializationError":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"description":"Workflow initialization error.","title":"WorkflowInitializationError"},"WorkflowError":{"oneOf":[{"$ref":"#/components/schemas/WorkflowEventError"},{"$ref":"#/components/schemas/WorkflowInitializationError"}],"title":"WorkflowError"},"MLModelUsageWrapper":{"type":"object","properties":{"ml_model_name":{"type":"string"},"ml_model_usage":{"$ref":"#/components/schemas/MLModelUsage"}},"required":["ml_model_name","ml_model_usage"],"title":"MLModelUsageWrapper"},"WorkflowExecutionUsageCalculationErrorCodeEnum":{"type":"string","enum":["UNKNOWN","DEPENDENCIES_FAILED","NO_USAGE_CALCULATED","INTERNAL_SERVER_ERROR"],"description":"* `UNKNOWN` - UNKNOWN\n* `DEPENDENCIES_FAILED` - DEPENDENCIES_FAILED\n* `NO_USAGE_CALCULATED` - NO_USAGE_CALCULATED\n* `INTERNAL_SERVER_ERROR` - INTERNAL_SERVER_ERROR","title":"WorkflowExecutionUsageCalculationErrorCodeEnum"},"WorkflowExecutionUsageCalculationError":{"type":"object","properties":{"code":{"$ref":"#/components/schemas/WorkflowExecutionUsageCalculationErrorCodeEnum"},"message":{"type":"string"}},"required":["code","message"],"title":"WorkflowExecutionUsageCalculationError"},"WorkflowExecutionUsageResult":{"type":"object","properties":{"usage":{"type":["array","null"],"items":{"$ref":"#/components/schemas/MLModelUsageWrapper"}},"cost":{"type":["array","null"],"items":{"$ref":"#/components/schemas/Price"}},"error":{"oneOf":[{"$ref":"#/components/schemas/WorkflowExecutionUsageCalculationError"},{"type":"null"}]}},"title":"WorkflowExecutionUsageResult"},"WorkflowExecutionActual":{"type":"object","properties":{"output":{"$ref":"#/components/schemas/ExecutionVellumValue"},"timestamp":{"type":"string","format":"date-time"},"quality":{"type":["number","null"],"format":"double"},"metadata":{"type":["object","null"],"additionalProperties":{"description":"Any type"}}},"required":["output","timestamp","metadata"],"title":"WorkflowExecutionActual"},"WorkflowExecutionViewOnlineEvalMetricResult":{"type":"object","properties":{"outputs":{"type":"array","items":{"$ref":"#/components/schemas/ExecutionVellumValue"}},"label":{"type":"string"},"metric_id":{"type":"string","format":"uuid"}},"required":["outputs","label","metric_id"],"title":"WorkflowExecutionViewOnlineEvalMetricResult"},"SlimWorkflowExecutionRead":{"type":"object","properties":{"span_id":{"type":"string","format":"uuid"},"start":{"type":"string","format":"date-time"},"end":{"type":["string","null"],"format":"date-time"},"inputs":{"type":"array","items":{"$ref":"#/components/schemas/ExecutionVellumValue"}},"outputs":{"type":"array","items":{"$ref":"#/components/schemas/ExecutionVellumValue"}},"error":{"oneOf":[{"$ref":"#/components/schemas/WorkflowError"},{"type":"null"}]},"usage_results":{"type":["array","null"],"items":{"$ref":"#/components/schemas/WorkflowExecutionUsageResult"}},"parent_context":{"oneOf":[{"$ref":"#/components/schemas/WorkflowDeploymentParentContext"},{"type":"null"}]},"latest_actual":{"oneOf":[{"$ref":"#/components/schemas/WorkflowExecutionActual"},{"type":"null"}]},"metric_results":{"type":"array","items":{"$ref":"#/components/schemas/WorkflowExecutionViewOnlineEvalMetricResult"}}},"required":["span_id","start","end","inputs","outputs","error","usage_results","parent_context","latest_actual","metric_results"],"title":"SlimWorkflowExecutionRead"},"WorkflowDeploymentEventExecutionsResponse":{"type":"object","properties":{"count":{"type":"integer"},"results":{"type":"array","items":{"$ref":"#/components/schemas/SlimWorkflowExecutionRead"}}},"required":["count","results"],"title":"WorkflowDeploymentEventExecutionsResponse"},"workflow.executionEnum":{"type":"string","enum":["workflow.execution"],"title":"workflow.executionEnum"},"VellumWorkflowExecutionEvent":{"oneOf":[{"$ref":"#/components/schemas/WorkflowExecutionInitiatedEvent"},{"$ref":"#/components/schemas/WorkflowExecutionStreamingEvent"},{"$ref":"#/components/schemas/WorkflowExecutionFulfilledEvent"},{"$ref":"#/components/schemas/WorkflowExecutionRejectedEvent"},{"$ref":"#/components/schemas/WorkflowExecutionPausedEvent"},{"$ref":"#/components/schemas/WorkflowExecutionResumedEvent"},{"$ref":"#/components/schemas/WorkflowExecutionSnapshottedEvent"}],"title":"VellumWorkflowExecutionEvent"},"WorkflowExecutionSpanAttributes":{"type":"object","properties":{"label":{"type":"string"},"workflow_id":{"type":"string","format":"uuid"}},"required":["label","workflow_id"],"title":"WorkflowExecutionSpanAttributes"},"WorkflowExecutionUsageCalculationFulfilledBody":{"type":"object","properties":{"usage":{"type":"array","items":{"$ref":"#/components/schemas/MLModelUsageWrapper"}},"cost":{"type":"array","items":{"$ref":"#/components/schemas/Price"}}},"required":["usage","cost"],"title":"WorkflowExecutionUsageCalculationFulfilledBody"},"WorkflowExecutionSpan":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/workflow.executionEnum"},"events":{"type":"array","items":{"$ref":"#/components/schemas/VellumWorkflowExecutionEvent"}},"attributes":{"$ref":"#/components/schemas/WorkflowExecutionSpanAttributes"},"usage_result":{"oneOf":[{"$ref":"#/components/schemas/WorkflowExecutionUsageCalculationFulfilledBody"},{"type":"null"}]},"span_id":{"type":"string","format":"uuid"},"start_ts":{"type":"string","format":"date-time"},"end_ts":{"type":"string","format":"date-time"},"parent_span_id":{"type":["string","null"],"format":"uuid"}},"required":["name","events","attributes","span_id","start_ts","end_ts","parent_span_id"],"title":"WorkflowExecutionSpan"},"node.executionEnum":{"type":"string","enum":["node.execution"],"title":"node.executionEnum"},"VellumNodeExecutionEvent":{"oneOf":[{"$ref":"#/components/schemas/NodeExecutionInitiatedEvent"},{"$ref":"#/components/schemas/NodeExecutionStreamingEvent"},{"$ref":"#/components/schemas/NodeExecutionFulfilledEvent"},{"$ref":"#/components/schemas/NodeExecutionRejectedEvent"},{"$ref":"#/components/schemas/NodeExecutionPausedEvent"},{"$ref":"#/components/schemas/NodeExecutionResumedEvent"},{"$ref":"#/components/schemas/NodeExecutionLogEvent"}],"title":"VellumNodeExecutionEvent"},"NodeExecutionSpanAttributes":{"type":"object","properties":{"label":{"type":"string"},"filepath":{"type":["string","null"]},"node_id":{"type":"string","format":"uuid"}},"required":["label","node_id"],"title":"NodeExecutionSpanAttributes"},"NodeExecutionSpan":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/node.executionEnum"},"events":{"type":"array","items":{"$ref":"#/components/schemas/VellumNodeExecutionEvent"}},"attributes":{"$ref":"#/components/schemas/NodeExecutionSpanAttributes"},"usage_result":{"oneOf":[{"$ref":"#/components/schemas/WorkflowExecutionUsageCalculationFulfilledBody"},{"type":"null"}]},"span_id":{"type":"string","format":"uuid"},"start_ts":{"type":"string","format":"date-time"},"end_ts":{"type":"string","format":"date-time"},"parent_span_id":{"type":["string","null"],"format":"uuid"}},"required":["name","events","attributes","span_id","start_ts","end_ts","parent_span_id"],"title":"NodeExecutionSpan"},"VellumSpan":{"oneOf":[{"$ref":"#/components/schemas/WorkflowExecutionSpan"},{"$ref":"#/components/schemas/NodeExecutionSpan"}],"title":"VellumSpan"},"WorkflowEventExecutionRead":{"type":"object","properties":{"span_id":{"type":"string","format":"uuid"},"start":{"type":"string","format":"date-time"},"end":{"type":["string","null"],"format":"date-time"},"inputs":{"type":"array","items":{"$ref":"#/components/schemas/ExecutionVellumValue"}},"outputs":{"type":"array","items":{"$ref":"#/components/schemas/ExecutionVellumValue"}},"error":{"oneOf":[{"$ref":"#/components/schemas/WorkflowError"},{"type":"null"}]},"usage_results":{"type":["array","null"],"items":{"$ref":"#/components/schemas/WorkflowExecutionUsageResult"}},"parent_context":{"oneOf":[{"$ref":"#/components/schemas/WorkflowDeploymentParentContext"},{"type":"null"}]},"latest_actual":{"oneOf":[{"$ref":"#/components/schemas/WorkflowExecutionActual"},{"type":"null"}]},"metric_results":{"type":"array","items":{"$ref":"#/components/schemas/WorkflowExecutionViewOnlineEvalMetricResult"}},"spans":{"type":"array","items":{"$ref":"#/components/schemas/VellumSpan"}},"state":{"type":["object","null"],"additionalProperties":{"description":"Any type"}}},"required":["span_id","start","end","inputs","outputs","error","usage_results","parent_context","latest_actual","metric_results","spans"],"title":"WorkflowEventExecutionRead"},"ErrorDetailResponse":{"type":"object","properties":{"detail":{"type":"string","description":"Message informing the user of the error."}},"required":["detail"],"title":"ErrorDetailResponse"},"UpdateActiveWorkspaceResponse":{"type":"object","properties":{"update_active_workspace_id":{"type":["string","null"],"format":"uuid","description":"The id of the workspace that the user should update to, or null if no workspace change needed."},"update_active_environment_id":{"type":["string","null"],"format":"uuid","description":"The id of the environment that the user should update to, or null if no environment change needed."},"is_staff":{"type":"boolean","description":"Whether or not the user is a staff member of Vellum."}},"required":["update_active_workspace_id","update_active_environment_id"],"title":"UpdateActiveWorkspaceResponse"},"WorkflowExecutionDetail":{"type":"object","properties":{"span_id":{"type":"string","format":"uuid"},"parent_context":{"oneOf":[{"$ref":"#/components/schemas/ParentContext"},{"type":"null"}]},"start":{"type":"string","format":"date-time"},"end":{"type":["string","null"],"format":"date-time"},"inputs":{"type":"array","items":{"$ref":"#/components/schemas/ExecutionVellumValue"}},"outputs":{"type":"array","items":{"$ref":"#/components/schemas/ExecutionVellumValue"}},"error":{"oneOf":[{"$ref":"#/components/schemas/WorkflowError"},{"type":"null"}]},"usage_results":{"type":["array","null"],"items":{"$ref":"#/components/schemas/WorkflowExecutionUsageResult"}},"spans":{"type":"array","items":{"$ref":"#/components/schemas/VellumSpan"}},"state":{"type":["object","null"],"additionalProperties":{"description":"Any type"}}},"required":["span_id","parent_context","start","end","inputs","outputs","error","usage_results","spans"],"title":"WorkflowExecutionDetail"},"CreateWorkflowEventRequest0":{"type":"array","items":{"$ref":"#/components/schemas/WorkflowEvent"},"title":"CreateWorkflowEventRequest0"},"CreateWorkflowEventRequest":{"oneOf":[{"$ref":"#/components/schemas/CreateWorkflowEventRequest0"},{"$ref":"#/components/schemas/WorkflowEvent"}],"title":"CreateWorkflowEventRequest"},"EventCreateResponse":{"type":"object","properties":{"success":{"type":"boolean","default":true,"description":"Indicates whether the event was published successfully."},"count":{"type":"integer","description":"Number of events processed"}},"required":["count"],"description":"Response serializer for successful event creation.","title":"EventCreateResponse"},"SearchWeightsRequest":{"type":"object","properties":{"semantic_similarity":{"type":"number","format":"double","default":0.8,"description":"The relative weight to give to semantic similarity"},"keywords":{"type":"number","format":"double","default":0.2,"description":"The relative weight to give to keywords"}},"title":"SearchWeightsRequest"},"SearchResultMergingRequest":{"type":"object","properties":{"enabled":{"type":"boolean","default":true,"description":"Whether to enable merging results"}},"title":"SearchResultMergingRequest"},"MetadataFilterRuleCombinator":{"type":"string","enum":["and","or"],"description":"* `and` - AND\n* `or` - OR","title":"MetadataFilterRuleCombinator"},"LogicalOperator":{"type":"string","enum":["=","!=","<",">","<=",">=","contains","beginsWith","endsWith","doesNotContain","doesNotBeginWith","doesNotEndWith","null","notNull","in","notIn","between","notBetween","concat","+","-","blank","notBlank","coalesce","accessField","parseJson","and","or","isError","length"],"description":"* `=` - EQUALS\n* `!=` - DOES_NOT_EQUAL\n* `<` - LESS_THAN\n* `>` - GREATER_THAN\n* `<=` - LESS_THAN_OR_EQUAL_TO\n* `>=` - GREATER_THAN_OR_EQUAL_TO\n* `contains` - CONTAINS\n* `beginsWith` - BEGINS_WITH\n* `endsWith` - ENDS_WITH\n* `doesNotContain` - DOES_NOT_CONTAIN\n* `doesNotBeginWith` - DOES_NOT_BEGIN_WITH\n* `doesNotEndWith` - DOES_NOT_END_WITH\n* `null` - NULL\n* `notNull` - NOT_NULL\n* `in` - IN\n* `notIn` - NOT_IN\n* `between` - BETWEEN\n* `notBetween` - NOT_BETWEEN\n* `concat` - CONCAT\n* `+` - ADD\n* `-` - MINUS\n* `blank` - BLANK\n* `notBlank` - NOT_BLANK\n* `coalesce` - COALESCE\n* `accessField` - ACCESS_FIELD\n* `parseJson` - PARSE_JSON\n* `and` - AND\n* `or` - OR\n* `isError` - IS_ERROR\n* `length` - LENGTH","title":"LogicalOperator"},"MetadataFilterRuleRequest":{"type":"object","properties":{"combinator":{"oneOf":[{"$ref":"#/components/schemas/MetadataFilterRuleCombinator"},{"type":"null"}]},"negated":{"type":["boolean","null"]},"rules":{"type":["array","null"],"items":{"$ref":"#/components/schemas/MetadataFilterRuleRequest"}},"field":{"type":["string","null"]},"operator":{"oneOf":[{"$ref":"#/components/schemas/LogicalOperator"},{"type":"null"}]},"value":{"type":["string","null"]}},"title":"MetadataFilterRuleRequest"},"MetadataFilterConfigRequest":{"type":"object","properties":{"combinator":{"oneOf":[{"$ref":"#/components/schemas/MetadataFilterRuleCombinator"},{"type":"null"}]},"negated":{"type":["boolean","null"]},"rules":{"type":["array","null"],"items":{"$ref":"#/components/schemas/MetadataFilterRuleRequest"}},"field":{"type":["string","null"]},"operator":{"oneOf":[{"$ref":"#/components/schemas/LogicalOperator"},{"type":"null"}]},"value":{"type":["string","null"]}},"description":"A deprecated pattern for filtering on metadata. Please use MetadataFilters instead.","title":"MetadataFilterConfigRequest"},"LogicalConditionEnum":{"type":"string","enum":["LOGICAL_CONDITION"],"title":"LogicalConditionEnum"},"StringVellumValueRequest":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/StringEnum"},"value":{"type":["string","null"]}},"required":["type","value"],"description":"A value representing a string.","title":"StringVellumValueRequest"},"NumberVellumValueRequest":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/NumberEnum"},"value":{"type":["number","null"],"format":"double"}},"required":["type","value"],"description":"A value representing a number.","title":"NumberVellumValueRequest"},"JsonVellumValueRequest":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/JsonEnum"},"value":{"oneOf":[{"description":"Any type"},{"type":"null"}]}},"required":["type","value"],"description":"A value representing a JSON object.","title":"JsonVellumValueRequest"},"AudioVellumValueRequest":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/AudioEnum"},"value":{"oneOf":[{"$ref":"#/components/schemas/VellumAudioRequest"},{"type":"null"}]}},"required":["type","value"],"description":"A base Vellum primitive value representing audio.","title":"AudioVellumValueRequest"},"VideoVellumValueRequest":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/VideoEnum"},"value":{"oneOf":[{"$ref":"#/components/schemas/VellumVideoRequest"},{"type":"null"}]}},"required":["type","value"],"description":"A base Vellum primitive value representing a video.","title":"VideoVellumValueRequest"},"ImageVellumValueRequest":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/ImageEnum"},"value":{"oneOf":[{"$ref":"#/components/schemas/VellumImageRequest"},{"type":"null"}]}},"required":["type","value"],"description":"A base Vellum primitive value representing an image.","title":"ImageVellumValueRequest"},"DocumentVellumValueRequest":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/DocumentEnum"},"value":{"oneOf":[{"$ref":"#/components/schemas/VellumDocumentRequest"},{"type":"null"}]}},"required":["type","value"],"description":"A base Vellum primitive value representing a document.","title":"DocumentVellumValueRequest"},"FunctionCallRequest":{"type":"object","properties":{"arguments":{"type":"object","additionalProperties":{"description":"Any type"}},"id":{"type":["string","null"]},"name":{"type":"string"}},"required":["arguments","name"],"description":"The final resolved function call value.","title":"FunctionCallRequest"},"FunctionCallVellumValueRequest":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/FunctionCallEnum"},"value":{"oneOf":[{"$ref":"#/components/schemas/FunctionCallRequest"},{"type":"null"}]}},"required":["type","value"],"description":"A value representing a Function Call.","title":"FunctionCallVellumValueRequest"},"VellumErrorRequest":{"type":"object","properties":{"code":{"$ref":"#/components/schemas/VellumErrorCodeEnum"},"message":{"type":"string"},"raw_data":{"type":["object","null"],"additionalProperties":{"description":"Any type"}}},"required":["code","message"],"title":"VellumErrorRequest"},"ErrorVellumValueRequest":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/ErrorEnum"},"value":{"oneOf":[{"$ref":"#/components/schemas/VellumErrorRequest"},{"type":"null"}]}},"required":["type","value"],"description":"A value representing an Error.","title":"ErrorVellumValueRequest"},"ArrayVellumValueRequest":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/ArrayEnum"},"value":{"type":["array","null"],"items":{"$ref":"#/components/schemas/VellumValueRequest"}}},"required":["type","value"],"description":"A value representing an array of Vellum variable values.","title":"ArrayVellumValueRequest"},"ChatHistoryVellumValueRequest":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/ChatHistoryEnum"},"value":{"type":["array","null"],"items":{"$ref":"#/components/schemas/ChatMessageRequest"}}},"required":["type","value"],"description":"A value representing Chat History.","title":"ChatHistoryVellumValueRequest"},"SearchResultDocumentRequest":{"type":"object","properties":{"id":{"type":["string","null"],"format":"uuid","description":"The ID of the document."},"label":{"type":"string","description":"The human-readable name for the document."},"external_id":{"type":["string","null"],"description":"The unique ID of the document as represented in an external system and specified when it was originally uploaded."},"metadata":{"type":["object","null"],"additionalProperties":{"description":"Any type"},"description":"A previously supplied JSON object containing metadata that can be filtered on when searching."}},"required":["label"],"title":"SearchResultDocumentRequest"},"PdfSearchResultMetaSourceRequest":{"type":"object","properties":{"document_type":{"$ref":"#/components/schemas/PdfEnum"},"start_page_num":{"type":["integer","null"],"description":"The 1-indexed page number where the chunk starts in the document. Only available for supported chunking strategies and document types."},"end_page_num":{"type":["integer","null"],"description":"The 1-indexed page number where the chunk ends in the document. Only available for supported chunking strategies and document types."}},"required":["document_type","start_page_num","end_page_num"],"description":"The source of a search result from a PDF document.","title":"PdfSearchResultMetaSourceRequest"},"SearchResultMetaSourceRequest":{"oneOf":[{"$ref":"#/components/schemas/PdfSearchResultMetaSourceRequest"}],"title":"SearchResultMetaSourceRequest"},"SearchResultMetaRequest":{"type":"object","properties":{"source":{"oneOf":[{"$ref":"#/components/schemas/SearchResultMetaSourceRequest"},{"type":"null"}]}},"title":"SearchResultMetaRequest"},"SearchResultRequest":{"type":"object","properties":{"text":{"type":"string","description":"The text of the chunk that matched the search query."},"score":{"type":"number","format":"double","description":"A score representing how well the chunk matches the search query."},"keywords":{"type":"array","items":{"type":"string"}},"document":{"$ref":"#/components/schemas/SearchResultDocumentRequest","description":"The document that contains the chunk that matched the search query."},"meta":{"oneOf":[{"$ref":"#/components/schemas/SearchResultMetaRequest"},{"type":"null"}],"description":"Additional information about the search result."}},"required":["text","score","keywords","document"],"title":"SearchResultRequest"},"SearchResultsVellumValueRequest":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/SearchResultsEnum"},"value":{"type":["array","null"],"items":{"$ref":"#/components/schemas/SearchResultRequest"}}},"required":["type","value"],"description":"A value representing Search Results.","title":"SearchResultsVellumValueRequest"},"ThinkingVellumValueRequest":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/ThinkingEnum"},"value":{"oneOf":[{"$ref":"#/components/schemas/StringVellumValueRequest"},{"type":"null"}]}},"required":["type","value"],"description":"A value representing Thinking mode output.","title":"ThinkingVellumValueRequest"},"VellumValueRequest":{"oneOf":[{"$ref":"#/components/schemas/StringVellumValueRequest"},{"$ref":"#/components/schemas/NumberVellumValueRequest"},{"$ref":"#/components/schemas/JsonVellumValueRequest"},{"$ref":"#/components/schemas/AudioVellumValueRequest"},{"$ref":"#/components/schemas/VideoVellumValueRequest"},{"$ref":"#/components/schemas/ImageVellumValueRequest"},{"$ref":"#/components/schemas/DocumentVellumValueRequest"},{"$ref":"#/components/schemas/FunctionCallVellumValueRequest"},{"$ref":"#/components/schemas/ErrorVellumValueRequest"},{"$ref":"#/components/schemas/ArrayVellumValueRequest"},{"$ref":"#/components/schemas/ChatHistoryVellumValueRequest"},{"$ref":"#/components/schemas/SearchResultsVellumValueRequest"},{"$ref":"#/components/schemas/ThinkingVellumValueRequest"}],"title":"VellumValueRequest"},"VellumValueLogicalConditionRequest":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/LogicalConditionEnum"},"lhs_variable":{"$ref":"#/components/schemas/VellumValueRequest"},"operator":{"$ref":"#/components/schemas/LogicalOperator"},"rhs_variable":{"$ref":"#/components/schemas/VellumValueRequest"}},"required":["type","lhs_variable","operator","rhs_variable"],"description":"A basic condition comparing two Vellum values.","title":"VellumValueLogicalConditionRequest"},"LogicalConditionGroupEnum":{"type":"string","enum":["LOGICAL_CONDITION_GROUP"],"title":"LogicalConditionGroupEnum"},"ConditionCombinator":{"type":"string","enum":["OR","AND"],"description":"* `OR` - OR\n* `AND` - AND","title":"ConditionCombinator"},"VellumValueLogicalConditionGroupRequest":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/LogicalConditionGroupEnum"},"conditions":{"type":"array","items":{"$ref":"#/components/schemas/VellumValueLogicalExpressionRequest"}},"combinator":{"$ref":"#/components/schemas/ConditionCombinator"},"negated":{"type":"boolean"}},"required":["type","conditions","combinator","negated"],"description":"A higher-order condition that combines one or more basic conditions or other higher-order conditions.","title":"VellumValueLogicalConditionGroupRequest"},"VellumValueLogicalExpressionRequest":{"oneOf":[{"$ref":"#/components/schemas/VellumValueLogicalConditionRequest"},{"$ref":"#/components/schemas/VellumValueLogicalConditionGroupRequest"}],"title":"VellumValueLogicalExpressionRequest"},"MetadataFiltersRequest":{"oneOf":[{"$ref":"#/components/schemas/MetadataFilterConfigRequest"},{"$ref":"#/components/schemas/VellumValueLogicalExpressionRequest"}],"title":"MetadataFiltersRequest"},"SearchFiltersRequest":{"type":"object","properties":{"external_ids":{"type":["array","null"],"items":{"type":"string"},"description":"The document external IDs to filter by"},"metadata":{"oneOf":[{"$ref":"#/components/schemas/MetadataFiltersRequest"},{"type":"null"}],"description":"The metadata filters to apply to the search"}},"title":"SearchFiltersRequest"},"SearchRequestOptionsRequest":{"type":"object","properties":{"limit":{"type":["integer","null"],"default":10,"description":"The maximum number of results to return."},"weights":{"oneOf":[{"$ref":"#/components/schemas/SearchWeightsRequest"},{"type":"null"}],"description":"The weights to use for the search. Must add up to 1.0."},"result_merging":{"oneOf":[{"$ref":"#/components/schemas/SearchResultMergingRequest"},{"type":"null"}],"description":"The configuration for merging results."},"filters":{"oneOf":[{"$ref":"#/components/schemas/SearchFiltersRequest"},{"type":"null"}],"description":"The filters to apply to the search."}},"title":"SearchRequestOptionsRequest"},"SearchRequestBodyRequest":{"type":"object","properties":{"index_id":{"type":["string","null"],"format":"uuid","description":"The ID of the index to search against. Must provide either this, index_name or document_index."},"index_name":{"type":["string","null"],"description":"The name of the index to search against. Must provide either this, index_id or document_index."},"query":{"type":"string","description":"The query to search for."},"options":{"oneOf":[{"$ref":"#/components/schemas/SearchRequestOptionsRequest"},{"type":"null"}],"description":"Configuration options for the search."},"document_index":{"type":["string","null"],"description":"Either the index name or index ID to search against. Must provide either this, index_id or index_name."}},"required":["query"],"title":"SearchRequestBodyRequest"},"SearchResponse":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/SearchResult"},"description":"The results of the search. Each result represents a chunk that matches the search query."}},"required":["results"],"title":"SearchResponse"},"SearchErrorResponse":{"type":"object","properties":{"detail":{"type":"string","description":"Details about why the request failed."}},"required":["detail"],"title":"SearchErrorResponse"},"document-indexes_add_document_Response_204":{"type":"object","properties":{},"description":"Empty response body","title":"document-indexes_add_document_Response_204"},"AddOpenaiApiKeyEnum":{"type":"boolean","description":"* `True` - True","title":"AddOpenaiApiKeyEnum"},"OpenAIVectorizerConfigRequest":{"type":"object","properties":{"add_openai_api_key":{"$ref":"#/components/schemas/AddOpenaiApiKeyEnum"}},"description":"Configuration for using an OpenAI vectorizer.","title":"OpenAIVectorizerConfigRequest"},"text-embedding-3-smallEnum":{"type":"string","enum":["text-embedding-3-small"],"title":"text-embedding-3-smallEnum"},"OpenAIVectorizerTextEmbedding3SmallRequest":{"type":"object","properties":{"config":{"$ref":"#/components/schemas/OpenAIVectorizerConfigRequest"},"model_name":{"$ref":"#/components/schemas/text-embedding-3-smallEnum"}},"required":["config","model_name"],"description":"OpenAI vectorizer for text-embedding-3-small.","title":"OpenAIVectorizerTextEmbedding3SmallRequest"},"text-embedding-3-largeEnum":{"type":"string","enum":["text-embedding-3-large"],"title":"text-embedding-3-largeEnum"},"OpenAIVectorizerTextEmbedding3LargeRequest":{"type":"object","properties":{"config":{"$ref":"#/components/schemas/OpenAIVectorizerConfigRequest"},"model_name":{"$ref":"#/components/schemas/text-embedding-3-largeEnum"}},"required":["config","model_name"],"description":"OpenAI vectorizer for text-embedding-3-large.","title":"OpenAIVectorizerTextEmbedding3LargeRequest"},"text-embedding-ada-002Enum":{"type":"string","enum":["text-embedding-ada-002"],"title":"text-embedding-ada-002Enum"},"OpenAIVectorizerTextEmbeddingAda002Request":{"type":"object","properties":{"config":{"$ref":"#/components/schemas/OpenAIVectorizerConfigRequest"},"model_name":{"$ref":"#/components/schemas/text-embedding-ada-002Enum"}},"required":["config","model_name"],"description":"OpenAI vectorizer for text-embedding-ada-002.","title":"OpenAIVectorizerTextEmbeddingAda002Request"},"intfloat-multilingual-e5-largeEnum":{"type":"string","enum":["intfloat/multilingual-e5-large"],"title":"intfloat-multilingual-e5-largeEnum"},"BasicVectorizerIntfloatMultilingualE5LargeRequest":{"type":"object","properties":{"config":{"type":["object","null"],"additionalProperties":{"description":"Any type"}},"model_name":{"$ref":"#/components/schemas/intfloat-multilingual-e5-largeEnum"}},"required":["model_name"],"description":"Basic vectorizer for intfloat/multilingual-e5-large.","title":"BasicVectorizerIntfloatMultilingualE5LargeRequest"},"sentence-transformers-multi-qa-mpnet-base-cos-v1Enum":{"type":"string","enum":["sentence-transformers/multi-qa-mpnet-base-cos-v1"],"title":"sentence-transformers-multi-qa-mpnet-base-cos-v1Enum"},"BasicVectorizerSentenceTransformersMultiQaMpnetBaseCosV1Request":{"type":"object","properties":{"config":{"type":["object","null"],"additionalProperties":{"description":"Any type"}},"model_name":{"$ref":"#/components/schemas/sentence-transformers-multi-qa-mpnet-base-cos-v1Enum"}},"required":["model_name"],"description":"Basic vectorizer for sentence-transformers/multi-qa-mpnet-base-cos-v1.","title":"BasicVectorizerSentenceTransformersMultiQaMpnetBaseCosV1Request"},"sentence-transformers-multi-qa-mpnet-base-dot-v1Enum":{"type":"string","enum":["sentence-transformers/multi-qa-mpnet-base-dot-v1"],"title":"sentence-transformers-multi-qa-mpnet-base-dot-v1Enum"},"BasicVectorizerSentenceTransformersMultiQaMpnetBaseDotV1Request":{"type":"object","properties":{"model_name":{"$ref":"#/components/schemas/sentence-transformers-multi-qa-mpnet-base-dot-v1Enum"},"config":{"type":["object","null"],"additionalProperties":{"description":"Any type"}}},"required":["model_name"],"description":"Basic vectorizer for sentence-transformers/multi-qa-mpnet-base-dot-v1.","title":"BasicVectorizerSentenceTransformersMultiQaMpnetBaseDotV1Request"},"hkunlp-instructor-xlEnum":{"type":"string","enum":["hkunlp/instructor-xl"],"title":"hkunlp-instructor-xlEnum"},"InstructorVectorizerConfigRequest":{"type":"object","properties":{"instruction_domain":{"type":"string"},"instruction_query_text_type":{"type":"string"},"instruction_document_text_type":{"type":"string"}},"required":["instruction_domain","instruction_query_text_type","instruction_document_text_type"],"description":"Configuration for using an Instructor vectorizer.","title":"InstructorVectorizerConfigRequest"},"HkunlpInstructorXlVectorizerRequest":{"type":"object","properties":{"model_name":{"$ref":"#/components/schemas/hkunlp-instructor-xlEnum"},"config":{"$ref":"#/components/schemas/InstructorVectorizerConfigRequest"}},"required":["model_name","config"],"description":"Vectorizer for hkunlp/instructor-xl.","title":"HkunlpInstructorXlVectorizerRequest"},"text-embedding-004Enum":{"type":"string","enum":["text-embedding-004"],"title":"text-embedding-004Enum"},"GoogleVertexAIVectorizerConfigRequest":{"type":"object","properties":{"project_id":{"type":"string"},"region":{"type":"string"}},"required":["project_id","region"],"title":"GoogleVertexAIVectorizerConfigRequest"},"GoogleVertexAIVectorizerTextEmbedding004Request":{"type":"object","properties":{"model_name":{"$ref":"#/components/schemas/text-embedding-004Enum"},"config":{"$ref":"#/components/schemas/GoogleVertexAIVectorizerConfigRequest"}},"required":["model_name","config"],"title":"GoogleVertexAIVectorizerTextEmbedding004Request"},"text-multilingual-embedding-002Enum":{"type":"string","enum":["text-multilingual-embedding-002"],"title":"text-multilingual-embedding-002Enum"},"GoogleVertexAIVectorizerTextMultilingualEmbedding002Request":{"type":"object","properties":{"model_name":{"$ref":"#/components/schemas/text-multilingual-embedding-002Enum"},"config":{"$ref":"#/components/schemas/GoogleVertexAIVectorizerConfigRequest"}},"required":["model_name","config"],"title":"GoogleVertexAIVectorizerTextMultilingualEmbedding002Request"},"gemini-embedding-001Enum":{"type":"string","enum":["gemini-embedding-001"],"title":"gemini-embedding-001Enum"},"GoogleVertexAIVectorizerGeminiEmbedding001Request":{"type":"object","properties":{"model_name":{"$ref":"#/components/schemas/gemini-embedding-001Enum"},"config":{"$ref":"#/components/schemas/GoogleVertexAIVectorizerConfigRequest"}},"required":["model_name","config"],"title":"GoogleVertexAIVectorizerGeminiEmbedding001Request"},"baai-bge-small-en-v1.5Enum":{"type":"string","enum":["BAAI/bge-small-en-v1.5"],"title":"baai-bge-small-en-v1.5Enum"},"FastEmbedVectorizerBAAIBgeSmallEnV15Request":{"type":"object","properties":{"model_name":{"$ref":"#/components/schemas/baai-bge-small-en-v1.5Enum"}},"required":["model_name"],"description":"FastEmbed vectorizer for BAAI/bge-small-en-v1.5.","title":"FastEmbedVectorizerBAAIBgeSmallEnV15Request"},"private-vectorizerEnum":{"type":"string","enum":["private-vectorizer"],"title":"private-vectorizerEnum"},"PrivateVectorizerRequest":{"type":"object","properties":{"model_name":{"$ref":"#/components/schemas/private-vectorizerEnum"}},"required":["model_name"],"description":"Serializer for private vectorizer.","title":"PrivateVectorizerRequest"},"IndexingConfigVectorizerRequest":{"oneOf":[{"$ref":"#/components/schemas/OpenAIVectorizerTextEmbedding3SmallRequest"},{"$ref":"#/components/schemas/OpenAIVectorizerTextEmbedding3LargeRequest"},{"$ref":"#/components/schemas/OpenAIVectorizerTextEmbeddingAda002Request"},{"$ref":"#/components/schemas/BasicVectorizerIntfloatMultilingualE5LargeRequest"},{"$ref":"#/components/schemas/BasicVectorizerSentenceTransformersMultiQaMpnetBaseCosV1Request"},{"$ref":"#/components/schemas/BasicVectorizerSentenceTransformersMultiQaMpnetBaseDotV1Request"},{"$ref":"#/components/schemas/HkunlpInstructorXlVectorizerRequest"},{"$ref":"#/components/schemas/GoogleVertexAIVectorizerTextEmbedding004Request"},{"$ref":"#/components/schemas/GoogleVertexAIVectorizerTextMultilingualEmbedding002Request"},{"$ref":"#/components/schemas/GoogleVertexAIVectorizerGeminiEmbedding001Request"},{"$ref":"#/components/schemas/FastEmbedVectorizerBAAIBgeSmallEnV15Request"},{"$ref":"#/components/schemas/PrivateVectorizerRequest"}],"title":"IndexingConfigVectorizerRequest"},"reducto-chunkerEnum":{"type":"string","enum":["reducto-chunker"],"title":"reducto-chunkerEnum"},"ReductoChunkerConfigRequest":{"type":"object","properties":{"character_limit":{"type":"integer","default":1000}},"description":"Configuration for Reducto chunking","title":"ReductoChunkerConfigRequest"},"ReductoChunkingRequest":{"type":"object","properties":{"chunker_name":{"$ref":"#/components/schemas/reducto-chunkerEnum"},"chunker_config":{"$ref":"#/components/schemas/ReductoChunkerConfigRequest"}},"required":["chunker_name"],"description":"Reducto chunking","title":"ReductoChunkingRequest"},"sentence-chunkerEnum":{"type":"string","enum":["sentence-chunker"],"title":"sentence-chunkerEnum"},"SentenceChunkerConfigRequest":{"type":"object","properties":{"character_limit":{"type":"integer","default":1000},"min_overlap_ratio":{"type":"number","format":"double","default":0.5}},"description":"Configuration for sentence chunking","title":"SentenceChunkerConfigRequest"},"SentenceChunkingRequest":{"type":"object","properties":{"chunker_name":{"$ref":"#/components/schemas/sentence-chunkerEnum"},"chunker_config":{"$ref":"#/components/schemas/SentenceChunkerConfigRequest"}},"required":["chunker_name"],"description":"Sentence chunking","title":"SentenceChunkingRequest"},"token-overlapping-window-chunkerEnum":{"type":"string","enum":["token-overlapping-window-chunker"],"title":"token-overlapping-window-chunkerEnum"},"TokenOverlappingWindowChunkerConfigRequest":{"type":"object","properties":{"token_limit":{"type":"integer","default":250},"overlap_ratio":{"type":"number","format":"double","default":0.5}},"description":"Configuration for token overlapping window chunking","title":"TokenOverlappingWindowChunkerConfigRequest"},"TokenOverlappingWindowChunkingRequest":{"type":"object","properties":{"chunker_name":{"$ref":"#/components/schemas/token-overlapping-window-chunkerEnum"},"chunker_config":{"$ref":"#/components/schemas/TokenOverlappingWindowChunkerConfigRequest"}},"required":["chunker_name"],"description":"Token overlapping window chunking","title":"TokenOverlappingWindowChunkingRequest"},"delimiter-chunkerEnum":{"type":"string","enum":["delimiter-chunker"],"title":"delimiter-chunkerEnum"},"DelimiterChunkerConfigRequest":{"type":"object","properties":{"delimiter":{"type":"string","default":"\\n\\n"},"is_regex":{"type":"boolean","default":false}},"title":"DelimiterChunkerConfigRequest"},"DelimiterChunkingRequest":{"type":"object","properties":{"chunker_name":{"$ref":"#/components/schemas/delimiter-chunkerEnum"},"chunker_config":{"$ref":"#/components/schemas/DelimiterChunkerConfigRequest"}},"required":["chunker_name"],"title":"DelimiterChunkingRequest"},"DocumentIndexChunkingRequest":{"oneOf":[{"$ref":"#/components/schemas/ReductoChunkingRequest"},{"$ref":"#/components/schemas/SentenceChunkingRequest"},{"$ref":"#/components/schemas/TokenOverlappingWindowChunkingRequest"},{"$ref":"#/components/schemas/DelimiterChunkingRequest"}],"title":"DocumentIndexChunkingRequest"},"DocumentIndexIndexingConfigRequest":{"type":"object","properties":{"vectorizer":{"$ref":"#/components/schemas/IndexingConfigVectorizerRequest"},"chunking":{"oneOf":[{"$ref":"#/components/schemas/DocumentIndexChunkingRequest"},{"type":"null"}]}},"required":["vectorizer"],"title":"DocumentIndexIndexingConfigRequest"},"DocumentIndexCreateRequest":{"type":"object","properties":{"label":{"type":"string","description":"A human-readable label for the document index"},"name":{"type":"string","description":"A name that uniquely identifies this index within its workspace"},"status":{"$ref":"#/components/schemas/EntityStatus","description":"The current status of the document index\n\n* `ACTIVE` - Active\n* `ARCHIVED` - Archived\n* `PENDING_DELETION` - Pending Deletion"},"indexing_config":{"$ref":"#/components/schemas/DocumentIndexIndexingConfigRequest"},"copy_documents_from_index_id":{"type":"string","format":"uuid","description":"Optionally specify the id of a document index from which you'd like to copy and re-index its documents into this newly created index"}},"required":["label","name","indexing_config"],"title":"DocumentIndexCreateRequest"},"OpenAIVectorizerConfig":{"type":"object","properties":{"add_openai_api_key":{"$ref":"#/components/schemas/AddOpenaiApiKeyEnum"}},"description":"Configuration for using an OpenAI vectorizer.","title":"OpenAIVectorizerConfig"},"OpenAIVectorizerTextEmbedding3Small":{"type":"object","properties":{"config":{"$ref":"#/components/schemas/OpenAIVectorizerConfig"},"model_name":{"$ref":"#/components/schemas/text-embedding-3-smallEnum"}},"required":["config","model_name"],"description":"OpenAI vectorizer for text-embedding-3-small.","title":"OpenAIVectorizerTextEmbedding3Small"},"OpenAIVectorizerTextEmbedding3Large":{"type":"object","properties":{"config":{"$ref":"#/components/schemas/OpenAIVectorizerConfig"},"model_name":{"$ref":"#/components/schemas/text-embedding-3-largeEnum"}},"required":["config","model_name"],"description":"OpenAI vectorizer for text-embedding-3-large.","title":"OpenAIVectorizerTextEmbedding3Large"},"OpenAIVectorizerTextEmbeddingAda002":{"type":"object","properties":{"config":{"$ref":"#/components/schemas/OpenAIVectorizerConfig"},"model_name":{"$ref":"#/components/schemas/text-embedding-ada-002Enum"}},"required":["config","model_name"],"description":"OpenAI vectorizer for text-embedding-ada-002.","title":"OpenAIVectorizerTextEmbeddingAda002"},"BasicVectorizerIntfloatMultilingualE5Large":{"type":"object","properties":{"config":{"type":["object","null"],"additionalProperties":{"description":"Any type"}},"model_name":{"$ref":"#/components/schemas/intfloat-multilingual-e5-largeEnum"}},"required":["model_name"],"description":"Basic vectorizer for intfloat/multilingual-e5-large.","title":"BasicVectorizerIntfloatMultilingualE5Large"},"BasicVectorizerSentenceTransformersMultiQaMpnetBaseCosV1":{"type":"object","properties":{"config":{"type":["object","null"],"additionalProperties":{"description":"Any type"}},"model_name":{"$ref":"#/components/schemas/sentence-transformers-multi-qa-mpnet-base-cos-v1Enum"}},"required":["model_name"],"description":"Basic vectorizer for sentence-transformers/multi-qa-mpnet-base-cos-v1.","title":"BasicVectorizerSentenceTransformersMultiQaMpnetBaseCosV1"},"BasicVectorizerSentenceTransformersMultiQaMpnetBaseDotV1":{"type":"object","properties":{"model_name":{"$ref":"#/components/schemas/sentence-transformers-multi-qa-mpnet-base-dot-v1Enum"},"config":{"type":["object","null"],"additionalProperties":{"description":"Any type"}}},"required":["model_name"],"description":"Basic vectorizer for sentence-transformers/multi-qa-mpnet-base-dot-v1.","title":"BasicVectorizerSentenceTransformersMultiQaMpnetBaseDotV1"},"InstructorVectorizerConfig":{"type":"object","properties":{"instruction_domain":{"type":"string"},"instruction_query_text_type":{"type":"string"},"instruction_document_text_type":{"type":"string"}},"required":["instruction_domain","instruction_query_text_type","instruction_document_text_type"],"description":"Configuration for using an Instructor vectorizer.","title":"InstructorVectorizerConfig"},"HkunlpInstructorXlVectorizer":{"type":"object","properties":{"model_name":{"$ref":"#/components/schemas/hkunlp-instructor-xlEnum"},"config":{"$ref":"#/components/schemas/InstructorVectorizerConfig"}},"required":["model_name","config"],"description":"Vectorizer for hkunlp/instructor-xl.","title":"HkunlpInstructorXlVectorizer"},"GoogleVertexAIVectorizerConfig":{"type":"object","properties":{"project_id":{"type":"string"},"region":{"type":"string"}},"required":["project_id","region"],"title":"GoogleVertexAIVectorizerConfig"},"GoogleVertexAIVectorizerTextEmbedding004":{"type":"object","properties":{"model_name":{"$ref":"#/components/schemas/text-embedding-004Enum"},"config":{"$ref":"#/components/schemas/GoogleVertexAIVectorizerConfig"}},"required":["model_name","config"],"title":"GoogleVertexAIVectorizerTextEmbedding004"},"GoogleVertexAIVectorizerTextMultilingualEmbedding002":{"type":"object","properties":{"model_name":{"$ref":"#/components/schemas/text-multilingual-embedding-002Enum"},"config":{"$ref":"#/components/schemas/GoogleVertexAIVectorizerConfig"}},"required":["model_name","config"],"title":"GoogleVertexAIVectorizerTextMultilingualEmbedding002"},"GoogleVertexAIVectorizerGeminiEmbedding001":{"type":"object","properties":{"model_name":{"$ref":"#/components/schemas/gemini-embedding-001Enum"},"config":{"$ref":"#/components/schemas/GoogleVertexAIVectorizerConfig"}},"required":["model_name","config"],"title":"GoogleVertexAIVectorizerGeminiEmbedding001"},"FastEmbedVectorizerBAAIBgeSmallEnV15":{"type":"object","properties":{"model_name":{"$ref":"#/components/schemas/baai-bge-small-en-v1.5Enum"}},"required":["model_name"],"description":"FastEmbed vectorizer for BAAI/bge-small-en-v1.5.","title":"FastEmbedVectorizerBAAIBgeSmallEnV15"},"PrivateVectorizer":{"type":"object","properties":{"model_name":{"$ref":"#/components/schemas/private-vectorizerEnum"}},"required":["model_name"],"description":"Serializer for private vectorizer.","title":"PrivateVectorizer"},"IndexingConfigVectorizer":{"oneOf":[{"$ref":"#/components/schemas/OpenAIVectorizerTextEmbedding3Small"},{"$ref":"#/components/schemas/OpenAIVectorizerTextEmbedding3Large"},{"$ref":"#/components/schemas/OpenAIVectorizerTextEmbeddingAda002"},{"$ref":"#/components/schemas/BasicVectorizerIntfloatMultilingualE5Large"},{"$ref":"#/components/schemas/BasicVectorizerSentenceTransformersMultiQaMpnetBaseCosV1"},{"$ref":"#/components/schemas/BasicVectorizerSentenceTransformersMultiQaMpnetBaseDotV1"},{"$ref":"#/components/schemas/HkunlpInstructorXlVectorizer"},{"$ref":"#/components/schemas/GoogleVertexAIVectorizerTextEmbedding004"},{"$ref":"#/components/schemas/GoogleVertexAIVectorizerTextMultilingualEmbedding002"},{"$ref":"#/components/schemas/GoogleVertexAIVectorizerGeminiEmbedding001"},{"$ref":"#/components/schemas/FastEmbedVectorizerBAAIBgeSmallEnV15"},{"$ref":"#/components/schemas/PrivateVectorizer"}],"title":"IndexingConfigVectorizer"},"ReductoChunkerConfig":{"type":"object","properties":{"character_limit":{"type":"integer","default":1000}},"description":"Configuration for Reducto chunking","title":"ReductoChunkerConfig"},"ReductoChunking":{"type":"object","properties":{"chunker_name":{"$ref":"#/components/schemas/reducto-chunkerEnum"},"chunker_config":{"$ref":"#/components/schemas/ReductoChunkerConfig"}},"required":["chunker_name"],"description":"Reducto chunking","title":"ReductoChunking"},"SentenceChunkerConfig":{"type":"object","properties":{"character_limit":{"type":"integer","default":1000},"min_overlap_ratio":{"type":"number","format":"double","default":0.5}},"description":"Configuration for sentence chunking","title":"SentenceChunkerConfig"},"SentenceChunking":{"type":"object","properties":{"chunker_name":{"$ref":"#/components/schemas/sentence-chunkerEnum"},"chunker_config":{"$ref":"#/components/schemas/SentenceChunkerConfig"}},"required":["chunker_name"],"description":"Sentence chunking","title":"SentenceChunking"},"TokenOverlappingWindowChunkerConfig":{"type":"object","properties":{"token_limit":{"type":"integer","default":250},"overlap_ratio":{"type":"number","format":"double","default":0.5}},"description":"Configuration for token overlapping window chunking","title":"TokenOverlappingWindowChunkerConfig"},"TokenOverlappingWindowChunking":{"type":"object","properties":{"chunker_name":{"$ref":"#/components/schemas/token-overlapping-window-chunkerEnum"},"chunker_config":{"$ref":"#/components/schemas/TokenOverlappingWindowChunkerConfig"}},"required":["chunker_name"],"description":"Token overlapping window chunking","title":"TokenOverlappingWindowChunking"},"DelimiterChunkerConfig":{"type":"object","properties":{"delimiter":{"type":"string","default":"\\n\\n"},"is_regex":{"type":"boolean","default":false}},"title":"DelimiterChunkerConfig"},"DelimiterChunking":{"type":"object","properties":{"chunker_name":{"$ref":"#/components/schemas/delimiter-chunkerEnum"},"chunker_config":{"$ref":"#/components/schemas/DelimiterChunkerConfig"}},"required":["chunker_name"],"title":"DelimiterChunking"},"DocumentIndexChunking":{"oneOf":[{"$ref":"#/components/schemas/ReductoChunking"},{"$ref":"#/components/schemas/SentenceChunking"},{"$ref":"#/components/schemas/TokenOverlappingWindowChunking"},{"$ref":"#/components/schemas/DelimiterChunking"}],"title":"DocumentIndexChunking"},"DocumentIndexIndexingConfig":{"type":"object","properties":{"vectorizer":{"$ref":"#/components/schemas/IndexingConfigVectorizer"},"chunking":{"oneOf":[{"$ref":"#/components/schemas/DocumentIndexChunking"},{"type":"null"}]}},"required":["vectorizer"],"title":"DocumentIndexIndexingConfig"},"DocumentIndexRead":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"created":{"type":"string","format":"date-time"},"label":{"type":"string","description":"A human-readable label for the document index"},"name":{"type":"string","description":"A name that uniquely identifies this index within its workspace"},"status":{"$ref":"#/components/schemas/EntityStatus","description":"The current status of the document index\n\n* `ACTIVE` - Active\n* `ARCHIVED` - Archived\n* `PENDING_DELETION` - Pending Deletion"},"indexing_config":{"$ref":"#/components/schemas/DocumentIndexIndexingConfig"}},"required":["id","created","label","name","indexing_config"],"title":"DocumentIndexRead"},"V1DocumentIndexesGetParametersStatus":{"type":"string","enum":["ACTIVE","ARCHIVED","PENDING_DELETION"],"title":"V1DocumentIndexesGetParametersStatus"},"PaginatedDocumentIndexReadList":{"type":"object","properties":{"count":{"type":"integer"},"next":{"type":["string","null"],"format":"uri"},"previous":{"type":["string","null"],"format":"uri"},"results":{"type":"array","items":{"$ref":"#/components/schemas/DocumentIndexRead"}}},"title":"PaginatedDocumentIndexReadList"},"PatchedDocumentIndexUpdateRequest":{"type":"object","properties":{"label":{"type":"string","description":"A human-readable label for the document index"},"status":{"$ref":"#/components/schemas/EntityStatus","description":"The current status of the document index\n\n* `ACTIVE` - Active\n* `ARCHIVED` - Archived\n* `PENDING_DELETION` - Pending Deletion"}},"title":"PatchedDocumentIndexUpdateRequest"},"DocumentIndexUpdateRequest":{"type":"object","properties":{"label":{"type":"string","description":"A human-readable label for the document index"},"status":{"$ref":"#/components/schemas/EntityStatus","description":"The current status of the document index\n\n* `ACTIVE` - Active\n* `ARCHIVED` - Archived\n* `PENDING_DELETION` - Pending Deletion"}},"required":["label"],"title":"DocumentIndexUpdateRequest"},"document-indexes_destroy_Response_204":{"type":"object","properties":{},"description":"Empty response body","title":"document-indexes_destroy_Response_204"},"document-indexes_remove_document_Response_204":{"type":"object","properties":{},"description":"Empty response body","title":"document-indexes_remove_document_Response_204"},"UploadDocumentResponse":{"type":"object","properties":{"document_id":{"type":"string","format":"uuid","description":"The ID of the newly created document."}},"required":["document_id"],"title":"UploadDocumentResponse"},"UploadDocumentErrorResponse":{"type":"object","properties":{"detail":{"type":"string"}},"required":["detail"],"title":"UploadDocumentErrorResponse"},"DocumentProcessingState":{"type":"string","enum":["QUEUED","PROCESSING","PROCESSED","FAILED","UNKNOWN"],"description":"* `QUEUED` - Queued\n* `PROCESSING` - Processing\n* `PROCESSED` - Processed\n* `FAILED` - Failed\n* `UNKNOWN` - Unknown","title":"DocumentProcessingState"},"DocumentStatus":{"type":"string","enum":["ACTIVE"],"description":"* `ACTIVE` - Active","title":"DocumentStatus"},"IndexingStateEnum":{"type":"string","enum":["AWAITING_PROCESSING","QUEUED","INDEXING","INDEXED","FAILED"],"description":"* `AWAITING_PROCESSING` - Awaiting Processing\n* `QUEUED` - Queued\n* `INDEXING` - Indexing\n* `INDEXED` - Indexed\n* `FAILED` - Failed","title":"IndexingStateEnum"},"DocumentDocumentToDocumentIndex":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Vellum-generated ID that uniquely identifies this link."},"environment_document_index_id":{"type":"string","format":"uuid","description":"Vellum-generated ID that uniquely identifies the environment index this document is included in."},"document_index_id":{"type":["string","null"],"format":"uuid","description":"Vellum-generated ID that uniquely identifies the index this document is included in."},"indexing_state":{"$ref":"#/components/schemas/IndexingStateEnum","description":"An enum value representing where this document is along its indexing lifecycle for this index.\n\n* `AWAITING_PROCESSING` - Awaiting Processing\n* `QUEUED` - Queued\n* `INDEXING` - Indexing\n* `INDEXED` - Indexed\n* `FAILED` - Failed"},"extracted_text_file_url":{"type":["string","null"]},"processing_state":{"type":["string","null"]}},"required":["id","environment_document_index_id","document_index_id","extracted_text_file_url","processing_state"],"description":"A detailed representation of the link between a Document and a Document Index it's a member of.","title":"DocumentDocumentToDocumentIndex"},"DocumentRead":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"external_id":{"type":["string","null"],"description":"The unique id of this document as it exists in the user's system."},"last_uploaded_at":{"type":"string","format":"date-time"},"label":{"type":"string","description":"A human-readable label for the document. Defaults to the originally uploaded file's file name."},"processing_state":{"$ref":"#/components/schemas/DocumentProcessingState"},"status":{"$ref":"#/components/schemas/DocumentStatus","description":"The current status of the document\n\n* `ACTIVE` - Active"},"keywords":{"type":"array","items":{"type":"string"},"description":"A list of keywords that'll be associated with the document. Used as part of keyword search."},"original_file_url":{"type":["string","null"]},"document_to_document_indexes":{"type":"array","items":{"$ref":"#/components/schemas/DocumentDocumentToDocumentIndex"}},"metadata":{"type":["object","null"],"additionalProperties":{"description":"Any type"},"description":"A previously supplied JSON object containing metadata that can be filtered on when searching."}},"required":["id","last_uploaded_at","label","processing_state","original_file_url","document_to_document_indexes"],"title":"DocumentRead"},"ProcessingFailureReasonEnum":{"type":"string","enum":["EXCEEDED_CHARACTER_LIMIT","INVALID_FILE","INVALID_CREDENTIALS"],"description":"* `EXCEEDED_CHARACTER_LIMIT` - Exceeded Character Limit\n* `INVALID_FILE` - Invalid File\n* `INVALID_CREDENTIALS` - Invalid Credentials","title":"ProcessingFailureReasonEnum"},"SlimDocumentDocumentToDocumentIndex":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Vellum-generated ID that uniquely identifies this link."},"environment_document_index_id":{"type":"string","format":"uuid","description":"Vellum-generated ID that uniquely identifies the environment index this document is included in."},"document_index_id":{"type":["string","null"],"format":"uuid","description":"Vellum-generated ID that uniquely identifies the index this document is included in."},"indexing_state":{"$ref":"#/components/schemas/IndexingStateEnum","description":"An enum value representing where this document is along its indexing lifecycle for this index.\n\n* `AWAITING_PROCESSING` - Awaiting Processing\n* `QUEUED` - Queued\n* `INDEXING` - Indexing\n* `INDEXED` - Indexed\n* `FAILED` - Failed"},"processing_state":{"type":["string","null"]}},"required":["id","environment_document_index_id","document_index_id","processing_state"],"description":"A slim representation of the link between a Document and a Document Index it's a member of.","title":"SlimDocumentDocumentToDocumentIndex"},"SlimDocument":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Vellum-generated ID that uniquely identifies this document."},"external_id":{"type":["string","null"],"description":"The external ID that was originally provided when uploading the document."},"last_uploaded_at":{"type":"string","format":"date-time","description":"A timestamp representing when this document was most recently uploaded."},"label":{"type":"string","description":"Human-friendly name for this document."},"processing_state":{"$ref":"#/components/schemas/DocumentProcessingState"},"processing_failure_reason":{"oneOf":[{"$ref":"#/components/schemas/ProcessingFailureReasonEnum"},{"type":"null"}],"description":"An enum value representing why the document could not be processed. Is null unless processing_state is FAILED.\n\n* `EXCEEDED_CHARACTER_LIMIT` - Exceeded Character Limit\n* `INVALID_FILE` - Invalid File\n* `INVALID_CREDENTIALS` - Invalid Credentials"},"status":{"$ref":"#/components/schemas/DocumentStatus","description":"The document's current status.\n\n* `ACTIVE` - Active"},"keywords":{"type":"array","items":{"type":"string"},"description":"A list of keywords associated with this document. Originally provided when uploading the document."},"metadata":{"type":["object","null"],"additionalProperties":{"description":"Any type"},"description":"A previously supplied JSON object containing metadata that can be filtered on when searching."},"document_to_document_indexes":{"type":"array","items":{"$ref":"#/components/schemas/SlimDocumentDocumentToDocumentIndex"}}},"required":["id","last_uploaded_at","label","processing_state","document_to_document_indexes"],"title":"SlimDocument"},"PaginatedSlimDocumentList":{"type":"object","properties":{"count":{"type":"integer"},"next":{"type":["string","null"],"format":"uri"},"previous":{"type":["string","null"],"format":"uri"},"results":{"type":"array","items":{"$ref":"#/components/schemas/SlimDocument"}}},"title":"PaginatedSlimDocumentList"},"documents_destroy_Response_204":{"type":"object","properties":{},"description":"Empty response body","title":"documents_destroy_Response_204"},"UploadedFileRead":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"file_url":{"type":["string","null"],"description":"A signed URL to download the uploaded file."}},"required":["id","file_url"],"description":"Represents a file that has been uploaded to a Vellum Workspace.","title":"UploadedFileRead"},"TestCaseStringVariableValue":{"type":"object","properties":{"variable_id":{"type":"string"},"name":{"type":"string"},"type":{"$ref":"#/components/schemas/StringEnum"},"value":{"type":["string","null"]}},"required":["variable_id","name","type","value"],"description":"A string value for a variable in a Test Case.","title":"TestCaseStringVariableValue"},"TestCaseNumberVariableValue":{"type":"object","properties":{"variable_id":{"type":"string"},"name":{"type":"string"},"type":{"$ref":"#/components/schemas/NumberEnum"},"value":{"type":["number","null"],"format":"double"}},"required":["variable_id","name","type","value"],"description":"A numerical value for a variable in a Test Case.","title":"TestCaseNumberVariableValue"},"TestCaseJsonVariableValue":{"type":"object","properties":{"variable_id":{"type":"string"},"name":{"type":"string"},"type":{"$ref":"#/components/schemas/JsonEnum"},"value":{"oneOf":[{"description":"Any type"},{"type":"null"}]}},"required":["variable_id","name","type","value"],"description":"A JSON value for a variable in a Test Case.","title":"TestCaseJsonVariableValue"},"TestCaseChatHistoryVariableValue":{"type":"object","properties":{"variable_id":{"type":"string"},"name":{"type":"string"},"type":{"$ref":"#/components/schemas/ChatHistoryEnum"},"value":{"type":["array","null"],"items":{"$ref":"#/components/schemas/ChatMessage"}}},"required":["variable_id","name","type","value"],"description":"A chat history value for a variable in a Test Case.","title":"TestCaseChatHistoryVariableValue"},"TestCaseSearchResultsVariableValue":{"type":"object","properties":{"variable_id":{"type":"string"},"name":{"type":"string"},"type":{"$ref":"#/components/schemas/SearchResultsEnum"},"value":{"type":["array","null"],"items":{"$ref":"#/components/schemas/SearchResult"}}},"required":["variable_id","name","type","value"],"description":"A search results value for a variable in a Test Case.","title":"TestCaseSearchResultsVariableValue"},"TestCaseErrorVariableValue":{"type":"object","properties":{"variable_id":{"type":"string"},"name":{"type":"string"},"type":{"$ref":"#/components/schemas/ErrorEnum"},"value":{"oneOf":[{"$ref":"#/components/schemas/VellumError"},{"type":"null"}]}},"required":["variable_id","name","type","value"],"description":"An error value for a variable in a Test Case.","title":"TestCaseErrorVariableValue"},"TestCaseFunctionCallVariableValue":{"type":"object","properties":{"variable_id":{"type":"string"},"name":{"type":"string"},"type":{"$ref":"#/components/schemas/FunctionCallEnum"},"value":{"oneOf":[{"$ref":"#/components/schemas/FunctionCall"},{"type":"null"}]}},"required":["variable_id","name","type","value"],"description":"A function call value for a variable in a Test Case.","title":"TestCaseFunctionCallVariableValue"},"TestCaseArrayVariableValue":{"type":"object","properties":{"variable_id":{"type":"string"},"name":{"type":"string"},"type":{"$ref":"#/components/schemas/ArrayEnum"},"value":{"type":["array","null"],"items":{"$ref":"#/components/schemas/VellumValue"}}},"required":["variable_id","name","type","value"],"description":"An Array value for a variable in a Test Case.","title":"TestCaseArrayVariableValue"},"TestCaseAudioVariableValue":{"type":"object","properties":{"variable_id":{"type":"string"},"name":{"type":"string"},"type":{"$ref":"#/components/schemas/AudioEnum"},"value":{"oneOf":[{"$ref":"#/components/schemas/VellumAudio"},{"type":"null"}]}},"required":["variable_id","name","type","value"],"description":"An audio value for a variable in a Test Case.","title":"TestCaseAudioVariableValue"},"TestCaseImageVariableValue":{"type":"object","properties":{"variable_id":{"type":"string"},"name":{"type":"string"},"type":{"$ref":"#/components/schemas/ImageEnum"},"value":{"oneOf":[{"$ref":"#/components/schemas/VellumImage"},{"type":"null"}]}},"required":["variable_id","name","type","value"],"description":"An image value for a variable in a Test Case.","title":"TestCaseImageVariableValue"},"TestCaseVideoVariableValue":{"type":"object","properties":{"variable_id":{"type":"string"},"name":{"type":"string"},"type":{"$ref":"#/components/schemas/VideoEnum"},"value":{"oneOf":[{"$ref":"#/components/schemas/VellumVideo"},{"type":"null"}]}},"required":["variable_id","name","type","value"],"description":"A video value for a variable in a Test Case.","title":"TestCaseVideoVariableValue"},"TestCaseDocumentVariableValue":{"type":"object","properties":{"variable_id":{"type":"string"},"name":{"type":"string"},"type":{"$ref":"#/components/schemas/DocumentEnum"},"value":{"oneOf":[{"$ref":"#/components/schemas/VellumDocument"},{"type":"null"}]}},"required":["variable_id","name","type","value"],"description":"A document value for a variable in a Test Case.","title":"TestCaseDocumentVariableValue"},"TestCaseVariableValue":{"oneOf":[{"$ref":"#/components/schemas/TestCaseStringVariableValue"},{"$ref":"#/components/schemas/TestCaseNumberVariableValue"},{"$ref":"#/components/schemas/TestCaseJsonVariableValue"},{"$ref":"#/components/schemas/TestCaseChatHistoryVariableValue"},{"$ref":"#/components/schemas/TestCaseSearchResultsVariableValue"},{"$ref":"#/components/schemas/TestCaseErrorVariableValue"},{"$ref":"#/components/schemas/TestCaseFunctionCallVariableValue"},{"$ref":"#/components/schemas/TestCaseArrayVariableValue"},{"$ref":"#/components/schemas/TestCaseAudioVariableValue"},{"$ref":"#/components/schemas/TestCaseImageVariableValue"},{"$ref":"#/components/schemas/TestCaseVideoVariableValue"},{"$ref":"#/components/schemas/TestCaseDocumentVariableValue"}],"title":"TestCaseVariableValue"},"TestSuiteTestCase":{"type":"object","properties":{"id":{"type":"string"},"external_id":{"type":["string","null"]},"label":{"type":["string","null"]},"input_values":{"type":"array","items":{"$ref":"#/components/schemas/TestCaseVariableValue"}},"evaluation_values":{"type":"array","items":{"$ref":"#/components/schemas/TestCaseVariableValue"}}},"required":["input_values","evaluation_values"],"title":"TestSuiteTestCase"},"PaginatedTestSuiteTestCaseList":{"type":"object","properties":{"count":{"type":"integer"},"next":{"type":["string","null"],"format":"uri"},"previous":{"type":["string","null"],"format":"uri"},"results":{"type":"array","items":{"$ref":"#/components/schemas/TestSuiteTestCase"}}},"required":["count","next","previous","results"],"title":"PaginatedTestSuiteTestCaseList"},"NamedTestCaseStringVariableValueRequest":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/StringEnum"},"value":{"type":["string","null"]},"name":{"type":"string"}},"required":["type","value","name"],"description":"Named Test Case value that is of type STRING","title":"NamedTestCaseStringVariableValueRequest"},"NamedTestCaseNumberVariableValueRequest":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/NumberEnum"},"value":{"type":["number","null"],"format":"double"},"name":{"type":"string"}},"required":["type","value","name"],"description":"Named Test Case value that is of type NUMBER","title":"NamedTestCaseNumberVariableValueRequest"},"NamedTestCaseJsonVariableValueRequest":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/JsonEnum"},"value":{"oneOf":[{"description":"Any type"},{"type":"null"}]},"name":{"type":"string"}},"required":["type","value","name"],"description":"Named Test Case value that is of type JSON","title":"NamedTestCaseJsonVariableValueRequest"},"NamedTestCaseChatHistoryVariableValueRequest":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/ChatHistoryEnum"},"value":{"type":["array","null"],"items":{"$ref":"#/components/schemas/ChatMessageRequest"}},"name":{"type":"string"}},"required":["type","value","name"],"description":"Named Test Case value that is of type CHAT_HISTORY","title":"NamedTestCaseChatHistoryVariableValueRequest"},"NamedTestCaseSearchResultsVariableValueRequest":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/SearchResultsEnum"},"value":{"type":["array","null"],"items":{"$ref":"#/components/schemas/SearchResultRequest"}},"name":{"type":"string"}},"required":["type","value","name"],"description":"Named Test Case value that is of type SEARCH_RESULTS","title":"NamedTestCaseSearchResultsVariableValueRequest"},"NamedTestCaseErrorVariableValueRequest":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/ErrorEnum"},"value":{"oneOf":[{"$ref":"#/components/schemas/VellumErrorRequest"},{"type":"null"}]},"name":{"type":"string"}},"required":["type","value","name"],"description":"Named Test Case value that is of type ERROR","title":"NamedTestCaseErrorVariableValueRequest"},"NamedTestCaseFunctionCallVariableValueRequest":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/FunctionCallEnum"},"value":{"oneOf":[{"$ref":"#/components/schemas/FunctionCallRequest"},{"type":"null"}]},"name":{"type":"string"}},"required":["type","value","name"],"description":"Named Test Case value that is of type FUNCTION_CALL","title":"NamedTestCaseFunctionCallVariableValueRequest"},"NamedTestCaseArrayVariableValueRequest":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/ArrayEnum"},"value":{"type":["array","null"],"items":{"$ref":"#/components/schemas/VellumValueRequest"}},"name":{"type":"string"}},"required":["type","value","name"],"description":"Named Test Case value that is of type ARRAY","title":"NamedTestCaseArrayVariableValueRequest"},"NamedTestCaseAudioVariableValueRequest":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/AudioEnum"},"value":{"oneOf":[{"$ref":"#/components/schemas/VellumAudioRequest"},{"type":"null"}]},"name":{"type":"string"}},"required":["type","value","name"],"description":"Named Test Case value that is of type AUDIO","title":"NamedTestCaseAudioVariableValueRequest"},"NamedTestCaseVideoVariableValueRequest":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/VideoEnum"},"value":{"oneOf":[{"$ref":"#/components/schemas/VellumVideoRequest"},{"type":"null"}]},"name":{"type":"string"}},"required":["type","value","name"],"title":"NamedTestCaseVideoVariableValueRequest"},"NamedTestCaseImageVariableValueRequest":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/ImageEnum"},"value":{"oneOf":[{"$ref":"#/components/schemas/VellumImageRequest"},{"type":"null"}]},"name":{"type":"string"}},"required":["type","value","name"],"title":"NamedTestCaseImageVariableValueRequest"},"NamedTestCaseDocumentVariableValueRequest":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/DocumentEnum"},"value":{"oneOf":[{"$ref":"#/components/schemas/VellumDocumentRequest"},{"type":"null"}]},"name":{"type":"string"}},"required":["type","value","name"],"title":"NamedTestCaseDocumentVariableValueRequest"},"NamedTestCaseVariableValueRequest":{"oneOf":[{"$ref":"#/components/schemas/NamedTestCaseStringVariableValueRequest"},{"$ref":"#/components/schemas/NamedTestCaseNumberVariableValueRequest"},{"$ref":"#/components/schemas/NamedTestCaseJsonVariableValueRequest"},{"$ref":"#/components/schemas/NamedTestCaseChatHistoryVariableValueRequest"},{"$ref":"#/components/schemas/NamedTestCaseSearchResultsVariableValueRequest"},{"$ref":"#/components/schemas/NamedTestCaseErrorVariableValueRequest"},{"$ref":"#/components/schemas/NamedTestCaseFunctionCallVariableValueRequest"},{"$ref":"#/components/schemas/NamedTestCaseArrayVariableValueRequest"},{"$ref":"#/components/schemas/NamedTestCaseAudioVariableValueRequest"},{"$ref":"#/components/schemas/NamedTestCaseVideoVariableValueRequest"},{"$ref":"#/components/schemas/NamedTestCaseImageVariableValueRequest"},{"$ref":"#/components/schemas/NamedTestCaseDocumentVariableValueRequest"}],"title":"NamedTestCaseVariableValueRequest"},"UpsertTestSuiteTestCaseRequest":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The Vellum-generated ID of an existing Test Case whose data you'd like to replace. If specified and no Test Case exists with this ID, a 404 will be returned."},"external_id":{"type":"string","description":"An ID external to Vellum that uniquely identifies the Test Case that you'd like to create/update. If there's a match on a Test Case that was previously created with the same external_id, it will be updated. Otherwise, a new Test Case will be created with this value as its external_id. If no external_id is specified, then a new Test Case will always be created."},"label":{"type":["string","null"],"description":"A human-readable label used to convey the intention of this Test Case"},"input_values":{"type":"array","items":{"$ref":"#/components/schemas/NamedTestCaseVariableValueRequest"},"description":"Values for each of the Test Case's input variables"},"evaluation_values":{"type":"array","items":{"$ref":"#/components/schemas/NamedTestCaseVariableValueRequest"},"description":"Values for each of the Test Case's evaluation variables"}},"required":["input_values","evaluation_values"],"title":"UpsertTestSuiteTestCaseRequest"},"CreateEnum":{"type":"string","enum":["CREATE"],"title":"CreateEnum"},"CreateTestSuiteTestCaseRequest":{"type":"object","properties":{"label":{"type":["string","null"],"description":"A human-readable label used to convey the intention of this Test Case"},"input_values":{"type":"array","items":{"$ref":"#/components/schemas/NamedTestCaseVariableValueRequest"},"description":"Values for each of the Test Case's input variables"},"evaluation_values":{"type":"array","items":{"$ref":"#/components/schemas/NamedTestCaseVariableValueRequest"},"description":"Values for each of the Test Case's evaluation variables"},"external_id":{"type":["string","null"],"description":"Optionally provide an ID that uniquely identifies this Test Case in your system. Useful for updating this Test Cases data after initial creation. Cannot be changed later."}},"required":["input_values","evaluation_values"],"description":"Information about the Test Case to create","title":"CreateTestSuiteTestCaseRequest"},"TestSuiteTestCaseCreateBulkOperationRequest":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"An ID representing this specific operation. Can later be used to look up information about the operation's success in the response."},"type":{"$ref":"#/components/schemas/CreateEnum"},"data":{"$ref":"#/components/schemas/CreateTestSuiteTestCaseRequest"}},"required":["id","type","data"],"description":"A bulk operation that represents the creation of a Test Case.","title":"TestSuiteTestCaseCreateBulkOperationRequest"},"ReplaceEnum":{"type":"string","enum":["REPLACE"],"title":"ReplaceEnum"},"ReplaceTestSuiteTestCaseRequest":{"type":"object","properties":{"id":{"type":["string","null"],"format":"uuid","description":"The Vellum-generated ID of the Test Case whose data you'd like to replace. Must specify either this or external_id."},"external_id":{"type":["string","null"],"description":"The ID that was originally provided upon Test Case creation that uniquely identifies the Test Case whose data you'd like to replace. Must specify either this of id."},"label":{"type":["string","null"],"description":"A human-readable label used to convey the intention of this Test Case"},"input_values":{"type":"array","items":{"$ref":"#/components/schemas/NamedTestCaseVariableValueRequest"},"description":"Values for each of the Test Case's input variables"},"evaluation_values":{"type":"array","items":{"$ref":"#/components/schemas/NamedTestCaseVariableValueRequest"},"description":"Values for each of the Test Case's evaluation variables"}},"required":["input_values","evaluation_values"],"description":"Information about the Test Case to replace","title":"ReplaceTestSuiteTestCaseRequest"},"TestSuiteTestCaseReplaceBulkOperationRequest":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"An ID representing this specific operation. Can later be used to look up information about the operation's success in the response."},"type":{"$ref":"#/components/schemas/ReplaceEnum"},"data":{"$ref":"#/components/schemas/ReplaceTestSuiteTestCaseRequest"}},"required":["id","type","data"],"description":"A bulk operation that represents the replacing of a Test Case.","title":"TestSuiteTestCaseReplaceBulkOperationRequest"},"UpsertEnum":{"type":"string","enum":["UPSERT"],"title":"UpsertEnum"},"TestSuiteTestCaseUpsertBulkOperationRequest":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"An ID representing this specific operation. Can later be used to look up information about the operation's success in the response."},"type":{"$ref":"#/components/schemas/UpsertEnum"},"data":{"$ref":"#/components/schemas/UpsertTestSuiteTestCaseRequest"}},"required":["id","type","data"],"description":"A bulk operation that represents the upserting of a Test Case.","title":"TestSuiteTestCaseUpsertBulkOperationRequest"},"DeleteEnum":{"type":"string","enum":["DELETE"],"title":"DeleteEnum"},"TestSuiteTestCaseDeleteBulkOperationDataRequest":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"],"title":"TestSuiteTestCaseDeleteBulkOperationDataRequest"},"TestSuiteTestCaseDeleteBulkOperationRequest":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"An ID representing this specific operation. Can later be used to look up information about the operation's success in the response."},"type":{"$ref":"#/components/schemas/DeleteEnum"},"data":{"$ref":"#/components/schemas/TestSuiteTestCaseDeleteBulkOperationDataRequest","description":"Information about the Test Case to delete"}},"required":["id","type","data"],"description":"A bulk operation that represents the deletion of a Test Case.","title":"TestSuiteTestCaseDeleteBulkOperationRequest"},"TestSuiteTestCaseBulkOperationRequest":{"oneOf":[{"$ref":"#/components/schemas/TestSuiteTestCaseCreateBulkOperationRequest"},{"$ref":"#/components/schemas/TestSuiteTestCaseReplaceBulkOperationRequest"},{"$ref":"#/components/schemas/TestSuiteTestCaseUpsertBulkOperationRequest"},{"$ref":"#/components/schemas/TestSuiteTestCaseDeleteBulkOperationRequest"}],"title":"TestSuiteTestCaseBulkOperationRequest"},"CreatedEnum":{"type":"string","enum":["CREATED"],"title":"CreatedEnum"},"TestSuiteTestCaseCreatedBulkResultData":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"],"description":"Information about the Test Case that was created.","title":"TestSuiteTestCaseCreatedBulkResultData"},"TestSuiteTestCaseCreatedBulkResult":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"type":{"$ref":"#/components/schemas/CreatedEnum"},"data":{"$ref":"#/components/schemas/TestSuiteTestCaseCreatedBulkResultData"}},"required":["id","type","data"],"description":"The result of a bulk operation that created a Test Case.","title":"TestSuiteTestCaseCreatedBulkResult"},"ReplacedEnum":{"type":"string","enum":["REPLACED"],"title":"ReplacedEnum"},"TestSuiteTestCaseReplacedBulkResultData":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"],"description":"Information about the Test Case that was replaced","title":"TestSuiteTestCaseReplacedBulkResultData"},"TestSuiteTestCaseReplacedBulkResult":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"An ID that maps back to one of the initially supplied operations. Can be used to determine the result of a given operation."},"type":{"$ref":"#/components/schemas/ReplacedEnum"},"data":{"$ref":"#/components/schemas/TestSuiteTestCaseReplacedBulkResultData"}},"required":["id","type","data"],"description":"The result of a bulk operation that replaced a Test Case.","title":"TestSuiteTestCaseReplacedBulkResult"},"DeletedEnum":{"type":"string","enum":["DELETED"],"title":"DeletedEnum"},"TestSuiteTestCaseDeletedBulkResultData":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"],"description":"Information about the Test Case that was deleted","title":"TestSuiteTestCaseDeletedBulkResultData"},"TestSuiteTestCaseDeletedBulkResult":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"An ID that maps back to one of the initially supplied operations. Can be used to determine the result of a given operation."},"type":{"$ref":"#/components/schemas/DeletedEnum"},"data":{"$ref":"#/components/schemas/TestSuiteTestCaseDeletedBulkResultData"}},"required":["id","type","data"],"description":"The result of a bulk operation that deleted a Test Case.","title":"TestSuiteTestCaseDeletedBulkResult"},"TestSuiteTestCaseRejectedBulkResult":{"type":"object","properties":{"id":{"type":["string","null"],"format":"uuid","description":"An ID that maps back to one of the initially supplied operations. Can be used to determine the result of a given operation."},"type":{"$ref":"#/components/schemas/RejectedEnum"},"data":{"type":"object","additionalProperties":{"description":"Any type"},"description":"Details about the error that occurred"}},"required":["type","data"],"description":"The result of a bulk operation that failed to operate on a Test Case.","title":"TestSuiteTestCaseRejectedBulkResult"},"TestSuiteTestCaseBulkResult":{"oneOf":[{"$ref":"#/components/schemas/TestSuiteTestCaseCreatedBulkResult"},{"$ref":"#/components/schemas/TestSuiteTestCaseReplacedBulkResult"},{"$ref":"#/components/schemas/TestSuiteTestCaseDeletedBulkResult"},{"$ref":"#/components/schemas/TestSuiteTestCaseRejectedBulkResult"}],"title":"TestSuiteTestCaseBulkResult"},"test-suites_delete_test_suite_test_case_Response_204":{"type":"object","properties":{},"description":"Empty response body","title":"test-suites_delete_test_suite_test_case_Response_204"},"TestSuiteRunDeploymentReleaseTagExecConfigTypeEnum":{"type":"string","enum":["DEPLOYMENT_RELEASE_TAG"],"description":"* `DEPLOYMENT_RELEASE_TAG` - DEPLOYMENT_RELEASE_TAG","title":"TestSuiteRunDeploymentReleaseTagExecConfigTypeEnum"},"TestSuiteRunDeploymentReleaseTagExecConfigDataRequest":{"type":"object","properties":{"deployment_id":{"type":"string","format":"uuid","description":"The ID of the Prompt Deployment to run the Test Suite against."},"tag":{"type":"string","default":"LATEST","description":"A tag identifying which release of the Prompt Deployment to run the Test Suite against. Useful for testing past versions of the Prompt Deployment"}},"required":["deployment_id"],"title":"TestSuiteRunDeploymentReleaseTagExecConfigDataRequest"},"TestSuiteRunDeploymentReleaseTagExecConfigRequest":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/TestSuiteRunDeploymentReleaseTagExecConfigTypeEnum"},"data":{"$ref":"#/components/schemas/TestSuiteRunDeploymentReleaseTagExecConfigDataRequest"},"test_case_ids":{"type":["array","null"],"items":{"type":"string"},"description":"Optionally specify a subset of test case ids to run. If not provided, all test cases within the test suite will be run by default."}},"required":["data"],"description":"Execution configuration for running a Test Suite against a Prompt Deployment","title":"TestSuiteRunDeploymentReleaseTagExecConfigRequest"},"TestSuiteRunPromptSandboxExecConfigTypeEnum":{"type":"string","enum":["PROMPT_SANDBOX"],"description":"* `PROMPT_SANDBOX` - PROMPT_SANDBOX","title":"TestSuiteRunPromptSandboxExecConfigTypeEnum"},"TestSuiteRunPromptSandboxExecConfigDataRequest":{"type":"object","properties":{"prompt_sandbox_id":{"type":"string","format":"uuid","description":"The ID of the Prompt Sandbox to run the Test Suite against."},"prompt_variant_id":{"type":"string","format":"uuid","description":"The ID of the Prompt Variant within the Prompt Sandbox that you'd like to run the Test Suite against."}},"required":["prompt_sandbox_id","prompt_variant_id"],"title":"TestSuiteRunPromptSandboxExecConfigDataRequest"},"TestSuiteRunPromptSandboxExecConfigRequest":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/TestSuiteRunPromptSandboxExecConfigTypeEnum"},"data":{"$ref":"#/components/schemas/TestSuiteRunPromptSandboxExecConfigDataRequest"},"test_case_ids":{"type":["array","null"],"items":{"type":"string"},"description":"Optionally specify a subset of test case ids to run. If not provided, all test cases within the test suite will be run by default."}},"required":["data"],"description":"Execution configuration for running a Test Suite against a Prompt Sandbox","title":"TestSuiteRunPromptSandboxExecConfigRequest"},"TestSuiteRunPromptSandboxHistoryItemExecConfigTypeEnum":{"type":"string","enum":["PROMPT_SANDBOX_HISTORY_ITEM"],"description":"* `PROMPT_SANDBOX_HISTORY_ITEM` - PROMPT_SANDBOX_HISTORY_ITEM","title":"TestSuiteRunPromptSandboxHistoryItemExecConfigTypeEnum"},"TestSuiteRunPromptSandboxHistoryItemExecConfigDataRequest":{"type":"object","properties":{"history_item_id":{"type":"string","format":"uuid","description":"The ID of the Prompt Sandbox History Item that the Test Suite will run against."},"prompt_variant_id":{"type":"string","format":"uuid","description":"The ID of the Prompt Variant within the Prompt Sandbox History Item that you'd like to run the Test Suite against."}},"required":["history_item_id","prompt_variant_id"],"title":"TestSuiteRunPromptSandboxHistoryItemExecConfigDataRequest"},"TestSuiteRunPromptSandboxHistoryItemExecConfigRequest":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/TestSuiteRunPromptSandboxHistoryItemExecConfigTypeEnum"},"data":{"$ref":"#/components/schemas/TestSuiteRunPromptSandboxHistoryItemExecConfigDataRequest"},"test_case_ids":{"type":["array","null"],"items":{"type":"string"},"description":"Optionally specify a subset of test case ids to run. If not provided, all test cases within the test suite will be run by default."}},"required":["data"],"description":"Execution configuration for running a Test Suite against a Prompt Sandbox History Item","title":"TestSuiteRunPromptSandboxHistoryItemExecConfigRequest"},"TestSuiteRunWorkflowReleaseTagExecConfigTypeEnum":{"type":"string","enum":["WORKFLOW_RELEASE_TAG"],"description":"* `WORKFLOW_RELEASE_TAG` - WORKFLOW_RELEASE_TAG","title":"TestSuiteRunWorkflowReleaseTagExecConfigTypeEnum"},"TestSuiteRunWorkflowReleaseTagExecConfigDataRequest":{"type":"object","properties":{"workflow_deployment_id":{"type":"string","format":"uuid","description":"The ID of the Workflow Deployment to run the Test Suite against."},"tag":{"type":"string","default":"LATEST","description":"A tag identifying which release of the Workflow Deployment to run the Test Suite against. Useful for testing past versions of the Workflow Deployment"}},"required":["workflow_deployment_id"],"title":"TestSuiteRunWorkflowReleaseTagExecConfigDataRequest"},"TestSuiteRunWorkflowReleaseTagExecConfigRequest":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/TestSuiteRunWorkflowReleaseTagExecConfigTypeEnum"},"data":{"$ref":"#/components/schemas/TestSuiteRunWorkflowReleaseTagExecConfigDataRequest"},"test_case_ids":{"type":["array","null"],"items":{"type":"string"},"description":"Optionally specify a subset of test case ids to run. If not provided, all test cases within the test suite will be run by default."}},"required":["data"],"description":"Execution configuration for running a Test Suite against a Workflow Deployment","title":"TestSuiteRunWorkflowReleaseTagExecConfigRequest"},"TestSuiteRunWorkflowSandboxExecConfigTypeEnum":{"type":"string","enum":["WORKFLOW_SANDBOX"],"description":"* `WORKFLOW_SANDBOX` - WORKFLOW_SANDBOX","title":"TestSuiteRunWorkflowSandboxExecConfigTypeEnum"},"TestSuiteRunWorkflowSandboxExecConfigDataRequest":{"type":"object","properties":{"workflow_sandbox_id":{"type":"string","format":"uuid","description":"The ID of the Workflow Sandbox to run the Test Suite against."}},"required":["workflow_sandbox_id"],"title":"TestSuiteRunWorkflowSandboxExecConfigDataRequest"},"TestSuiteRunWorkflowSandboxExecConfigRequest":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/TestSuiteRunWorkflowSandboxExecConfigTypeEnum"},"data":{"$ref":"#/components/schemas/TestSuiteRunWorkflowSandboxExecConfigDataRequest"},"test_case_ids":{"type":["array","null"],"items":{"type":"string"},"description":"Optionally specify a subset of test case ids to run. If not provided, all test cases within the test suite will be run by default."}},"required":["data"],"description":"Execution configuration for running a Test Suite against a Workflow Sandbox","title":"TestSuiteRunWorkflowSandboxExecConfigRequest"},"TestSuiteRunWorkflowSandboxHistoryItemExecConfigTypeEnum":{"type":"string","enum":["WORKFLOW_SANDBOX_HISTORY_ITEM"],"description":"* `WORKFLOW_SANDBOX_HISTORY_ITEM` - WORKFLOW_SANDBOX_HISTORY_ITEM","title":"TestSuiteRunWorkflowSandboxHistoryItemExecConfigTypeEnum"},"TestSuiteRunWorkflowSandboxHistoryItemExecConfigDataRequest":{"type":"object","properties":{"history_item_id":{"type":"string","format":"uuid","description":"The ID of the Workflow Sandbox History Item that the Test Suite will run against."},"workflow_variant_id":{"type":"string","format":"uuid","description":"The ID of the Workflow Variant within the Workflow Sandbox History Item that you'd like to run the Test Suite against."}},"required":["history_item_id","workflow_variant_id"],"title":"TestSuiteRunWorkflowSandboxHistoryItemExecConfigDataRequest"},"TestSuiteRunWorkflowSandboxHistoryItemExecConfigRequest":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/TestSuiteRunWorkflowSandboxHistoryItemExecConfigTypeEnum"},"data":{"$ref":"#/components/schemas/TestSuiteRunWorkflowSandboxHistoryItemExecConfigDataRequest"},"test_case_ids":{"type":["array","null"],"items":{"type":"string"},"description":"Optionally specify a subset of test case ids to run. If not provided, all test cases within the test suite will be run by default."}},"required":["data"],"description":"Execution configuration for running a Test Suite against a Workflow Sandbox History Item","title":"TestSuiteRunWorkflowSandboxHistoryItemExecConfigRequest"},"ExternalTestCaseExecutionRequest":{"type":"object","properties":{"outputs":{"type":"array","items":{"$ref":"#/components/schemas/NamedTestCaseVariableValueRequest"},"description":"The output values of a callable that was executed against a Test Case outside of Vellum"},"test_case_id":{"type":"string"}},"required":["outputs","test_case_id"],"title":"ExternalTestCaseExecutionRequest"},"TestSuiteRunExternalExecConfigDataRequest":{"type":"object","properties":{"executions":{"type":"array","items":{"$ref":"#/components/schemas/ExternalTestCaseExecutionRequest"},"description":"The executions of some callable external to Vellum whose outputs you would like to evaluate."}},"required":["executions"],"title":"TestSuiteRunExternalExecConfigDataRequest"},"TestSuiteRunExternalExecConfigTypeEnum":{"type":"string","enum":["EXTERNAL"],"description":"* `EXTERNAL` - EXTERNAL","title":"TestSuiteRunExternalExecConfigTypeEnum"},"TestSuiteRunExternalExecConfigRequest":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/TestSuiteRunExternalExecConfigDataRequest"},"test_case_ids":{"type":["array","null"],"items":{"type":"string"},"description":"Optionally specify a subset of test case ids to run. If not provided, all test cases within the test suite will be run by default."},"type":{"$ref":"#/components/schemas/TestSuiteRunExternalExecConfigTypeEnum"}},"required":["data"],"description":"Execution configuration for running a Vellum Test Suite against an external callable","title":"TestSuiteRunExternalExecConfigRequest"},"TestSuiteRunExecConfigRequest":{"oneOf":[{"$ref":"#/components/schemas/TestSuiteRunDeploymentReleaseTagExecConfigRequest"},{"$ref":"#/components/schemas/TestSuiteRunPromptSandboxExecConfigRequest"},{"$ref":"#/components/schemas/TestSuiteRunPromptSandboxHistoryItemExecConfigRequest"},{"$ref":"#/components/schemas/TestSuiteRunWorkflowReleaseTagExecConfigRequest"},{"$ref":"#/components/schemas/TestSuiteRunWorkflowSandboxExecConfigRequest"},{"$ref":"#/components/schemas/TestSuiteRunWorkflowSandboxHistoryItemExecConfigRequest"},{"$ref":"#/components/schemas/TestSuiteRunExternalExecConfigRequest"}],"title":"TestSuiteRunExecConfigRequest"},"TestSuiteRunCreateRequest":{"type":"object","properties":{"test_suite_id":{"type":"string","format":"uuid","description":"The ID of the Test Suite to run. Must provide either this or test_suite_id."},"test_suite_name":{"type":"string","description":"The name of the Test Suite to run. Must provide either this or test_suite_id."},"exec_config":{"$ref":"#/components/schemas/TestSuiteRunExecConfigRequest","description":"Configuration that defines how the Test Suite should be run"}},"required":["exec_config"],"title":"TestSuiteRunCreateRequest"},"TestSuiteRunTestSuite":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"history_item_id":{"type":"string","format":"uuid"},"label":{"type":"string"}},"required":["id","history_item_id","label"],"title":"TestSuiteRunTestSuite"},"TestSuiteRunState":{"type":"string","enum":["QUEUED","RUNNING","COMPLETE","FAILED","CANCELLED"],"description":"* `QUEUED` - Queued\n* `RUNNING` - Running\n* `COMPLETE` - Complete\n* `FAILED` - Failed\n* `CANCELLED` - Cancelled","title":"TestSuiteRunState"},"TestSuiteRunDeploymentReleaseTagExecConfigData":{"type":"object","properties":{"deployment_id":{"type":"string","format":"uuid","description":"The ID of the Prompt Deployment to run the Test Suite against."},"tag":{"type":"string","default":"LATEST","description":"A tag identifying which release of the Prompt Deployment to run the Test Suite against. Useful for testing past versions of the Prompt Deployment"}},"required":["deployment_id"],"title":"TestSuiteRunDeploymentReleaseTagExecConfigData"},"TestSuiteRunDeploymentReleaseTagExecConfig":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/TestSuiteRunDeploymentReleaseTagExecConfigTypeEnum"},"data":{"$ref":"#/components/schemas/TestSuiteRunDeploymentReleaseTagExecConfigData"},"test_case_ids":{"type":["array","null"],"items":{"type":"string"},"description":"Optionally specify a subset of test case ids to run. If not provided, all test cases within the test suite will be run by default."}},"required":["data"],"description":"Execution configuration for running a Test Suite against a Prompt Deployment","title":"TestSuiteRunDeploymentReleaseTagExecConfig"},"TestSuiteRunPromptSandboxHistoryItemExecConfigData":{"type":"object","properties":{"history_item_id":{"type":"string","format":"uuid","description":"The ID of the Prompt Sandbox History Item that the Test Suite will run against."},"prompt_variant_id":{"type":"string","format":"uuid","description":"The ID of the Prompt Variant within the Prompt Sandbox History Item that you'd like to run the Test Suite against."}},"required":["history_item_id","prompt_variant_id"],"title":"TestSuiteRunPromptSandboxHistoryItemExecConfigData"},"TestSuiteRunPromptSandboxHistoryItemExecConfig":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/TestSuiteRunPromptSandboxHistoryItemExecConfigTypeEnum"},"data":{"$ref":"#/components/schemas/TestSuiteRunPromptSandboxHistoryItemExecConfigData"},"test_case_ids":{"type":["array","null"],"items":{"type":"string"},"description":"Optionally specify a subset of test case ids to run. If not provided, all test cases within the test suite will be run by default."}},"required":["data"],"description":"Execution configuration for running a Test Suite against a Prompt Sandbox History Item","title":"TestSuiteRunPromptSandboxHistoryItemExecConfig"},"TestSuiteRunWorkflowReleaseTagExecConfigData":{"type":"object","properties":{"workflow_deployment_id":{"type":"string","format":"uuid","description":"The ID of the Workflow Deployment to run the Test Suite against."},"tag":{"type":"string","default":"LATEST","description":"A tag identifying which release of the Workflow Deployment to run the Test Suite against. Useful for testing past versions of the Workflow Deployment"}},"required":["workflow_deployment_id"],"title":"TestSuiteRunWorkflowReleaseTagExecConfigData"},"TestSuiteRunWorkflowReleaseTagExecConfig":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/TestSuiteRunWorkflowReleaseTagExecConfigTypeEnum"},"data":{"$ref":"#/components/schemas/TestSuiteRunWorkflowReleaseTagExecConfigData"},"test_case_ids":{"type":["array","null"],"items":{"type":"string"},"description":"Optionally specify a subset of test case ids to run. If not provided, all test cases within the test suite will be run by default."}},"required":["data"],"description":"Execution configuration for running a Test Suite against a Workflow Deployment","title":"TestSuiteRunWorkflowReleaseTagExecConfig"},"TestSuiteRunWorkflowSandboxHistoryItemExecConfigData":{"type":"object","properties":{"history_item_id":{"type":"string","format":"uuid","description":"The ID of the Workflow Sandbox History Item that the Test Suite will run against."},"workflow_variant_id":{"type":"string","format":"uuid","description":"The ID of the Workflow Variant within the Workflow Sandbox History Item that you'd like to run the Test Suite against."}},"required":["history_item_id","workflow_variant_id"],"title":"TestSuiteRunWorkflowSandboxHistoryItemExecConfigData"},"TestSuiteRunWorkflowSandboxHistoryItemExecConfig":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/TestSuiteRunWorkflowSandboxHistoryItemExecConfigTypeEnum"},"data":{"$ref":"#/components/schemas/TestSuiteRunWorkflowSandboxHistoryItemExecConfigData"},"test_case_ids":{"type":["array","null"],"items":{"type":"string"},"description":"Optionally specify a subset of test case ids to run. If not provided, all test cases within the test suite will be run by default."}},"required":["data"],"description":"Execution configuration for running a Test Suite against a Workflow Sandbox History Item","title":"TestSuiteRunWorkflowSandboxHistoryItemExecConfig"},"NamedTestCaseStringVariableValue":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/StringEnum"},"value":{"type":["string","null"]},"name":{"type":"string"}},"required":["type","value","name"],"description":"Named Test Case value that is of type STRING","title":"NamedTestCaseStringVariableValue"},"NamedTestCaseNumberVariableValue":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/NumberEnum"},"value":{"type":["number","null"],"format":"double"},"name":{"type":"string"}},"required":["type","value","name"],"description":"Named Test Case value that is of type NUMBER","title":"NamedTestCaseNumberVariableValue"},"NamedTestCaseJsonVariableValue":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/JsonEnum"},"value":{"oneOf":[{"description":"Any type"},{"type":"null"}]},"name":{"type":"string"}},"required":["type","value","name"],"description":"Named Test Case value that is of type JSON","title":"NamedTestCaseJsonVariableValue"},"NamedTestCaseChatHistoryVariableValue":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/ChatHistoryEnum"},"value":{"type":["array","null"],"items":{"$ref":"#/components/schemas/ChatMessage"}},"name":{"type":"string"}},"required":["type","value","name"],"description":"Named Test Case value that is of type CHAT_HISTORY","title":"NamedTestCaseChatHistoryVariableValue"},"NamedTestCaseSearchResultsVariableValue":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/SearchResultsEnum"},"value":{"type":["array","null"],"items":{"$ref":"#/components/schemas/SearchResult"}},"name":{"type":"string"}},"required":["type","value","name"],"description":"Named Test Case value that is of type SEARCH_RESULTS","title":"NamedTestCaseSearchResultsVariableValue"},"NamedTestCaseErrorVariableValue":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/ErrorEnum"},"value":{"oneOf":[{"$ref":"#/components/schemas/VellumError"},{"type":"null"}]},"name":{"type":"string"}},"required":["type","value","name"],"description":"Named Test Case value that is of type ERROR","title":"NamedTestCaseErrorVariableValue"},"NamedTestCaseFunctionCallVariableValue":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/FunctionCallEnum"},"value":{"oneOf":[{"$ref":"#/components/schemas/FunctionCall"},{"type":"null"}]},"name":{"type":"string"}},"required":["type","value","name"],"description":"Named Test Case value that is of type FUNCTION_CALL","title":"NamedTestCaseFunctionCallVariableValue"},"NamedTestCaseArrayVariableValue":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/ArrayEnum"},"value":{"type":["array","null"],"items":{"$ref":"#/components/schemas/VellumValue"}},"name":{"type":"string"}},"required":["type","value","name"],"description":"Named Test Case value that is of type ARRAY","title":"NamedTestCaseArrayVariableValue"},"NamedTestCaseAudioVariableValue":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/AudioEnum"},"value":{"oneOf":[{"$ref":"#/components/schemas/VellumAudio"},{"type":"null"}]},"name":{"type":"string"}},"required":["type","value","name"],"description":"Named Test Case value that is of type AUDIO","title":"NamedTestCaseAudioVariableValue"},"NamedTestCaseVideoVariableValue":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/VideoEnum"},"value":{"oneOf":[{"$ref":"#/components/schemas/VellumVideo"},{"type":"null"}]},"name":{"type":"string"}},"required":["type","value","name"],"title":"NamedTestCaseVideoVariableValue"},"NamedTestCaseImageVariableValue":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/ImageEnum"},"value":{"oneOf":[{"$ref":"#/components/schemas/VellumImage"},{"type":"null"}]},"name":{"type":"string"}},"required":["type","value","name"],"title":"NamedTestCaseImageVariableValue"},"NamedTestCaseDocumentVariableValue":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/DocumentEnum"},"value":{"oneOf":[{"$ref":"#/components/schemas/VellumDocument"},{"type":"null"}]},"name":{"type":"string"}},"required":["type","value","name"],"title":"NamedTestCaseDocumentVariableValue"},"NamedTestCaseVariableValue":{"oneOf":[{"$ref":"#/components/schemas/NamedTestCaseStringVariableValue"},{"$ref":"#/components/schemas/NamedTestCaseNumberVariableValue"},{"$ref":"#/components/schemas/NamedTestCaseJsonVariableValue"},{"$ref":"#/components/schemas/NamedTestCaseChatHistoryVariableValue"},{"$ref":"#/components/schemas/NamedTestCaseSearchResultsVariableValue"},{"$ref":"#/components/schemas/NamedTestCaseErrorVariableValue"},{"$ref":"#/components/schemas/NamedTestCaseFunctionCallVariableValue"},{"$ref":"#/components/schemas/NamedTestCaseArrayVariableValue"},{"$ref":"#/components/schemas/NamedTestCaseAudioVariableValue"},{"$ref":"#/components/schemas/NamedTestCaseVideoVariableValue"},{"$ref":"#/components/schemas/NamedTestCaseImageVariableValue"},{"$ref":"#/components/schemas/NamedTestCaseDocumentVariableValue"}],"title":"NamedTestCaseVariableValue"},"ExternalTestCaseExecution":{"type":"object","properties":{"outputs":{"type":"array","items":{"$ref":"#/components/schemas/NamedTestCaseVariableValue"},"description":"The output values of a callable that was executed against a Test Case outside of Vellum"},"test_case_id":{"type":"string"}},"required":["outputs","test_case_id"],"title":"ExternalTestCaseExecution"},"TestSuiteRunExternalExecConfigData":{"type":"object","properties":{"executions":{"type":"array","items":{"$ref":"#/components/schemas/ExternalTestCaseExecution"},"description":"The executions of some callable external to Vellum whose outputs you would like to evaluate."}},"required":["executions"],"title":"TestSuiteRunExternalExecConfigData"},"TestSuiteRunExternalExecConfig":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/TestSuiteRunExternalExecConfigData"},"test_case_ids":{"type":["array","null"],"items":{"type":"string"},"description":"Optionally specify a subset of test case ids to run. If not provided, all test cases within the test suite will be run by default."},"type":{"$ref":"#/components/schemas/TestSuiteRunExternalExecConfigTypeEnum"}},"required":["data"],"description":"Execution configuration for running a Vellum Test Suite against an external callable","title":"TestSuiteRunExternalExecConfig"},"TestSuiteRunExecConfig":{"oneOf":[{"$ref":"#/components/schemas/TestSuiteRunDeploymentReleaseTagExecConfig"},{"$ref":"#/components/schemas/TestSuiteRunPromptSandboxHistoryItemExecConfig"},{"$ref":"#/components/schemas/TestSuiteRunWorkflowReleaseTagExecConfig"},{"$ref":"#/components/schemas/TestSuiteRunWorkflowSandboxHistoryItemExecConfig"},{"$ref":"#/components/schemas/TestSuiteRunExternalExecConfig"}],"title":"TestSuiteRunExecConfig"},"TestSuiteRunProgress":{"type":"object","properties":{"number_of_requested_test_cases":{"type":"integer"},"number_of_completed_test_cases":{"type":"integer"}},"required":["number_of_requested_test_cases","number_of_completed_test_cases"],"title":"TestSuiteRunProgress"},"TestSuiteRunRead":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"created":{"type":"string","format":"date-time"},"test_suite":{"$ref":"#/components/schemas/TestSuiteRunTestSuite"},"state":{"$ref":"#/components/schemas/TestSuiteRunState","description":"The current state of this run\n\n* `QUEUED` - Queued\n* `RUNNING` - Running\n* `COMPLETE` - Complete\n* `FAILED` - Failed\n* `CANCELLED` - Cancelled"},"exec_config":{"oneOf":[{"$ref":"#/components/schemas/TestSuiteRunExecConfig"},{"type":"null"}],"description":"Configuration that defines how the Test Suite should be run"},"progress":{"$ref":"#/components/schemas/TestSuiteRunProgress"}},"required":["id","created","test_suite","state"],"title":"TestSuiteRunRead"},"TestSuiteRunExecutionStringOutput":{"type":"object","properties":{"name":{"type":"string"},"type":{"$ref":"#/components/schemas/StringEnum"},"value":{"type":["string","null"]},"output_variable_id":{"type":"string","format":"uuid"}},"required":["name","type","value","output_variable_id"],"description":"Execution output of an entity evaluated during a Test Suite Run that is of type STRING","title":"TestSuiteRunExecutionStringOutput"},"TestSuiteRunExecutionNumberOutput":{"type":"object","properties":{"name":{"type":"string"},"type":{"$ref":"#/components/schemas/NumberEnum"},"value":{"type":["number","null"],"format":"double"},"output_variable_id":{"type":"string","format":"uuid"}},"required":["name","type","value","output_variable_id"],"description":"Execution output of an entity evaluated during a Test Suite Run that is of type NUMBER","title":"TestSuiteRunExecutionNumberOutput"},"TestSuiteRunExecutionJsonOutput":{"type":"object","properties":{"name":{"type":"string"},"type":{"$ref":"#/components/schemas/JsonEnum"},"value":{"oneOf":[{"description":"Any type"},{"type":"null"}]},"output_variable_id":{"type":"string","format":"uuid"}},"required":["name","type","value","output_variable_id"],"description":"Execution output of an entity evaluated during a Test Suite Run that is of type JSON","title":"TestSuiteRunExecutionJsonOutput"},"TestSuiteRunExecutionChatHistoryOutput":{"type":"object","properties":{"name":{"type":"string"},"type":{"$ref":"#/components/schemas/ChatHistoryEnum"},"value":{"type":["array","null"],"items":{"$ref":"#/components/schemas/ChatMessage"}},"output_variable_id":{"type":"string","format":"uuid"}},"required":["name","type","value","output_variable_id"],"description":"Execution output of an entity evaluated during a Test Suite Run that is of type CHAT_HISTORY","title":"TestSuiteRunExecutionChatHistoryOutput"},"TestSuiteRunExecutionSearchResultsOutput":{"type":"object","properties":{"name":{"type":"string"},"type":{"$ref":"#/components/schemas/SearchResultsEnum"},"value":{"type":["array","null"],"items":{"$ref":"#/components/schemas/SearchResult"}},"output_variable_id":{"type":"string","format":"uuid"}},"required":["name","type","value","output_variable_id"],"description":"Execution output of an entity evaluated during a Test Suite Run that is of type SEARCH_RESULTS","title":"TestSuiteRunExecutionSearchResultsOutput"},"TestSuiteRunExecutionErrorOutput":{"type":"object","properties":{"name":{"type":"string"},"type":{"$ref":"#/components/schemas/ErrorEnum"},"value":{"oneOf":[{"$ref":"#/components/schemas/VellumError"},{"type":"null"}]},"output_variable_id":{"type":"string","format":"uuid"}},"required":["name","type","value","output_variable_id"],"description":"Execution output of an entity evaluated during a Test Suite Run that is of type ERROR","title":"TestSuiteRunExecutionErrorOutput"},"TestSuiteRunExecutionFunctionCallOutput":{"type":"object","properties":{"name":{"type":"string"},"type":{"$ref":"#/components/schemas/FunctionCallEnum"},"value":{"oneOf":[{"$ref":"#/components/schemas/FunctionCall"},{"type":"null"}]},"output_variable_id":{"type":"string","format":"uuid"}},"required":["name","type","value","output_variable_id"],"description":"Execution output of an entity evaluated during a Test Suite Run that is of type FUNCTION_CALL","title":"TestSuiteRunExecutionFunctionCallOutput"},"TestSuiteRunExecutionArrayOutput":{"type":"object","properties":{"name":{"type":"string"},"type":{"$ref":"#/components/schemas/ArrayEnum"},"value":{"type":["array","null"],"items":{"$ref":"#/components/schemas/VellumValue"}},"output_variable_id":{"type":"string","format":"uuid"}},"required":["name","type","value","output_variable_id"],"description":"Execution output of an entity evaluated during a Test Suite Run that is of type ARRAY","title":"TestSuiteRunExecutionArrayOutput"},"TestSuiteRunExecutionOutput":{"oneOf":[{"$ref":"#/components/schemas/TestSuiteRunExecutionStringOutput"},{"$ref":"#/components/schemas/TestSuiteRunExecutionNumberOutput"},{"$ref":"#/components/schemas/TestSuiteRunExecutionJsonOutput"},{"$ref":"#/components/schemas/TestSuiteRunExecutionChatHistoryOutput"},{"$ref":"#/components/schemas/TestSuiteRunExecutionSearchResultsOutput"},{"$ref":"#/components/schemas/TestSuiteRunExecutionErrorOutput"},{"$ref":"#/components/schemas/TestSuiteRunExecutionFunctionCallOutput"},{"$ref":"#/components/schemas/TestSuiteRunExecutionArrayOutput"}],"title":"TestSuiteRunExecutionOutput"},"TestSuiteRunMetricStringOutputTypeEnum":{"type":"string","enum":["STRING"],"description":"* `STRING` - STRING","title":"TestSuiteRunMetricStringOutputTypeEnum"},"TestSuiteRunMetricStringOutput":{"type":"object","properties":{"value":{"type":["string","null"]},"type":{"$ref":"#/components/schemas/TestSuiteRunMetricStringOutputTypeEnum"},"name":{"type":"string"}},"required":["value","name"],"description":"Output for a test suite run metric that is of type STRING","title":"TestSuiteRunMetricStringOutput"},"TestSuiteRunMetricNumberOutputTypeEnum":{"type":"string","enum":["NUMBER"],"description":"* `NUMBER` - NUMBER","title":"TestSuiteRunMetricNumberOutputTypeEnum"},"TestSuiteRunMetricNumberOutput":{"type":"object","properties":{"value":{"type":["number","null"],"format":"double"},"type":{"$ref":"#/components/schemas/TestSuiteRunMetricNumberOutputTypeEnum"},"name":{"type":"string"}},"required":["value","name"],"description":"Output for a test suite run metric that is of type NUMBER","title":"TestSuiteRunMetricNumberOutput"},"TestSuiteRunMetricJSONOutputTypeEnum":{"type":"string","enum":["JSON"],"description":"* `JSON` - JSON","title":"TestSuiteRunMetricJSONOutputTypeEnum"},"TestSuiteRunMetricJSONOutput":{"type":"object","properties":{"value":{"oneOf":[{"description":"Any type"},{"type":"null"}]},"type":{"$ref":"#/components/schemas/TestSuiteRunMetricJSONOutputTypeEnum"},"name":{"type":"string"}},"required":["value","name"],"description":"Output for a test suite run metric that is of type NUMBER","title":"TestSuiteRunMetricJSONOutput"},"TestSuiteRunMetricErrorOutputTypeEnum":{"type":"string","enum":["ERROR"],"description":"* `ERROR` - ERROR","title":"TestSuiteRunMetricErrorOutputTypeEnum"},"TestSuiteRunMetricErrorOutput":{"type":"object","properties":{"value":{"$ref":"#/components/schemas/VellumError"},"type":{"$ref":"#/components/schemas/TestSuiteRunMetricErrorOutputTypeEnum"},"name":{"type":"string"}},"required":["value","name"],"description":"Output for a test suite run metric that is of type ERROR","title":"TestSuiteRunMetricErrorOutput"},"TestSuiteRunMetricArrayOutputTypeEnum":{"type":"string","enum":["ARRAY"],"description":"* `ARRAY` - ARRAY","title":"TestSuiteRunMetricArrayOutputTypeEnum"},"TestSuiteRunMetricArrayOutput":{"type":"object","properties":{"value":{"type":["array","null"],"items":{"$ref":"#/components/schemas/VellumValue"}},"type":{"$ref":"#/components/schemas/TestSuiteRunMetricArrayOutputTypeEnum"},"name":{"type":"string"}},"required":["value","name"],"description":"Output for a test suite run metric that is of type ARRAY","title":"TestSuiteRunMetricArrayOutput"},"TestSuiteRunMetricOutput":{"oneOf":[{"$ref":"#/components/schemas/TestSuiteRunMetricStringOutput"},{"$ref":"#/components/schemas/TestSuiteRunMetricNumberOutput"},{"$ref":"#/components/schemas/TestSuiteRunMetricJSONOutput"},{"$ref":"#/components/schemas/TestSuiteRunMetricErrorOutput"},{"$ref":"#/components/schemas/TestSuiteRunMetricArrayOutput"}],"title":"TestSuiteRunMetricOutput"},"TestSuiteRunExecutionMetricDefinition":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"},"name":{"type":"string"}},"title":"TestSuiteRunExecutionMetricDefinition"},"TestSuiteRunExecutionMetricResult":{"type":"object","properties":{"metric_id":{"type":"string","format":"uuid"},"outputs":{"type":"array","items":{"$ref":"#/components/schemas/TestSuiteRunMetricOutput"}},"metric_label":{"type":"string"},"metric_definition":{"$ref":"#/components/schemas/TestSuiteRunExecutionMetricDefinition"}},"required":["metric_id","outputs"],"title":"TestSuiteRunExecutionMetricResult"},"TestSuiteRunExecution":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"test_case_id":{"type":"string"},"outputs":{"type":"array","items":{"$ref":"#/components/schemas/TestSuiteRunExecutionOutput"}},"metric_results":{"type":"array","items":{"$ref":"#/components/schemas/TestSuiteRunExecutionMetricResult"}}},"required":["id","test_case_id","outputs","metric_results"],"title":"TestSuiteRunExecution"},"PaginatedTestSuiteRunExecutionList":{"type":"object","properties":{"count":{"type":"integer"},"next":{"type":["string","null"],"format":"uri"},"previous":{"type":["string","null"],"format":"uri"},"results":{"type":"array","items":{"$ref":"#/components/schemas/TestSuiteRunExecution"}}},"required":["count","next","previous","results"],"title":"PaginatedTestSuiteRunExecutionList"},"AddEntityToFolderRequest":{"type":"object","properties":{"entity_id":{"type":"string","format":"uuid","description":"The ID of the entity you would like to move."}},"required":["entity_id"],"title":"AddEntityToFolderRequest"},"folder-entities_add_entity_to_folder_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"folder-entities_add_entity_to_folder_Response_200"},"V1FolderEntitiesGetParametersEntityStatus":{"type":"string","enum":["ACTIVE","ARCHIVED","PENDING_DELETION"],"title":"V1FolderEntitiesGetParametersEntityStatus"},"FolderEnum":{"type":"string","enum":["FOLDER"],"title":"FolderEnum"},"FolderEntityFolderData":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"label":{"type":"string"},"created":{"type":"string","format":"date-time"},"modified":{"type":"string","format":"date-time"},"has_contents":{"type":"boolean"}},"required":["id","label","created","modified","has_contents"],"title":"FolderEntityFolderData"},"FolderEntityFolder":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"type":{"$ref":"#/components/schemas/FolderEnum"},"data":{"$ref":"#/components/schemas/FolderEntityFolderData"}},"required":["id","type","data"],"description":"A slim representation of a Folder, as it exists within another Folder.","title":"FolderEntityFolder"},"PromptSandboxEnum":{"type":"string","enum":["PROMPT_SANDBOX"],"title":"PromptSandboxEnum"},"FolderEntityPromptSandboxData":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"label":{"type":"string"},"created":{"type":"string","format":"date-time"},"modified":{"type":"string","format":"date-time"},"status":{"$ref":"#/components/schemas/EntityStatus"},"description":{"type":["string","null"]},"last_deployed_on":{"type":["string","null"],"format":"date-time"}},"required":["id","label","created","modified","status"],"title":"FolderEntityPromptSandboxData"},"FolderEntityPromptSandbox":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"type":{"$ref":"#/components/schemas/PromptSandboxEnum"},"data":{"$ref":"#/components/schemas/FolderEntityPromptSandboxData"}},"required":["id","type","data"],"description":"A slim representation of a Prompt Sandbox, as it exists within a Folder.","title":"FolderEntityPromptSandbox"},"WorkflowSandboxDisplayData":{"type":"object","properties":{"icon":{"oneOf":[{"$ref":"#/components/schemas/WorkflowDisplayIcon"},{"type":"null"}],"description":"The icon associated with this Workflow Sandbox."}},"description":"Information used to display this Workflow Sandbox.","title":"WorkflowSandboxDisplayData"},"FolderEntityWorkflowSandboxData":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"label":{"type":"string"},"created":{"type":"string","format":"date-time"},"modified":{"type":"string","format":"date-time"},"status":{"$ref":"#/components/schemas/EntityStatus"},"description":{"type":["string","null"]},"last_deployed_on":{"type":["string","null"],"format":"date-time"},"display_data":{"oneOf":[{"$ref":"#/components/schemas/WorkflowSandboxDisplayData"},{"type":"null"}]}},"required":["id","label","created","modified","status","display_data"],"title":"FolderEntityWorkflowSandboxData"},"FolderEntityWorkflowSandbox":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"type":{"$ref":"#/components/schemas/WorkflowSandboxEnum"},"data":{"$ref":"#/components/schemas/FolderEntityWorkflowSandboxData"}},"required":["id","type","data"],"description":"A slim representation of a Workflow Sandbox, as it exists within a Folder.","title":"FolderEntityWorkflowSandbox"},"DocumentIndexEnum":{"type":"string","enum":["DOCUMENT_INDEX"],"title":"DocumentIndexEnum"},"FolderEntityDocumentIndexData":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"label":{"type":"string"},"created":{"type":"string","format":"date-time"},"modified":{"type":"string","format":"date-time"},"status":{"$ref":"#/components/schemas/EntityStatus"},"indexing_config":{"$ref":"#/components/schemas/DocumentIndexIndexingConfig"}},"required":["id","label","created","modified","status","indexing_config"],"title":"FolderEntityDocumentIndexData"},"FolderEntityDocumentIndex":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"type":{"$ref":"#/components/schemas/DocumentIndexEnum"},"data":{"$ref":"#/components/schemas/FolderEntityDocumentIndexData"}},"required":["id","type","data"],"description":"A slim representation of a Document Index, as it exists within a Folder.","title":"FolderEntityDocumentIndex"},"TestSuiteEnum":{"type":"string","enum":["TEST_SUITE"],"title":"TestSuiteEnum"},"FolderEntityTestSuiteData":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"label":{"type":"string"},"created":{"type":"string","format":"date-time"},"modified":{"type":"string","format":"date-time"},"status":{"$ref":"#/components/schemas/EntityStatus"}},"required":["id","label","created","modified","status"],"title":"FolderEntityTestSuiteData"},"FolderEntityTestSuite":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"type":{"$ref":"#/components/schemas/TestSuiteEnum"},"data":{"$ref":"#/components/schemas/FolderEntityTestSuiteData"}},"required":["id","type","data"],"description":"A slim representation of a Test Suite, as it exists within a Folder.","title":"FolderEntityTestSuite"},"DatasetEnum":{"type":"string","enum":["DATASET"],"title":"DatasetEnum"},"FolderEntityDatasetData":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"label":{"type":"string"},"name":{"type":"string"},"description":{"type":["string","null"]},"created":{"type":"string","format":"date-time"},"modified":{"type":"string","format":"date-time"}},"required":["id","label","name","created","modified"],"title":"FolderEntityDatasetData"},"FolderEntityDataset":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"type":{"$ref":"#/components/schemas/DatasetEnum"},"data":{"$ref":"#/components/schemas/FolderEntityDatasetData"}},"required":["id","type","data"],"description":"A slim representation of a Dataset, as it exists within a Folder.","title":"FolderEntityDataset"},"FolderEntity":{"oneOf":[{"$ref":"#/components/schemas/FolderEntityFolder"},{"$ref":"#/components/schemas/FolderEntityPromptSandbox"},{"$ref":"#/components/schemas/FolderEntityWorkflowSandbox"},{"$ref":"#/components/schemas/FolderEntityDocumentIndex"},{"$ref":"#/components/schemas/FolderEntityTestSuite"},{"$ref":"#/components/schemas/FolderEntityDataset"}],"title":"FolderEntity"},"PaginatedFolderEntityList":{"type":"object","properties":{"count":{"type":"integer"},"next":{"type":["string","null"],"format":"uri"},"previous":{"type":["string","null"],"format":"uri"},"results":{"type":"array","items":{"$ref":"#/components/schemas/FolderEntity"}}},"title":"PaginatedFolderEntityList"},"SecretTypeEnum":{"type":"string","enum":["USER_DEFINED","HMAC","INTERNAL_API_KEY","EXTERNALLY_PROVISIONED"],"description":"* `USER_DEFINED` - User Defined\n* `HMAC` - Hmac\n* `INTERNAL_API_KEY` - Internal Api Key\n* `EXTERNALLY_PROVISIONED` - Externally Provisioned","title":"SecretTypeEnum"},"WorkspaceSecretRead":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"modified":{"type":"string","format":"date-time"},"name":{"type":"string"},"label":{"type":"string"},"secret_type":{"$ref":"#/components/schemas/SecretTypeEnum"}},"required":["id","modified","name","label","secret_type"],"title":"WorkspaceSecretRead"},"PatchedWorkspaceSecretUpdateRequest":{"type":"object","properties":{"label":{"type":"string"},"value":{"type":"string"}},"title":"PatchedWorkspaceSecretUpdateRequest"}},"securitySchemes":{"default":{"type":"apiKey","in":"header","name":"X-API-KEY"}}}}