Class ExecuteCreateParams
-
- All Implemented Interfaces:
-
dev.case.api.core.Params
public final class ExecuteCreateParams implements Params
Creates an ephemeral agent and immediately executes a run. Returns the run ID for polling status and results. This is the fastest way to run an agent without managing agent lifecycle.
Ephemeral agent lifecycle: The agent created by this endpoint is automatically soft-deleted and its scoped API key revoked when the run completes (whether it succeeds, fails, or times out). Ephemeral agents do not appear in GET /agent/v1/agents listings. The returned agentId is valid only for the duration of the run — do not store it for reuse. For persistent, reusable agents, use POST /agent/v1/agents instead.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classExecuteCreateParams.BuilderA builder for ExecuteCreateParams.
public final classExecuteCreateParams.Bodypublic final classExecuteCreateParams.SandboxCustom sandbox resources (cpu, memoryMiB)
-
Method Summary
Modifier and Type Method Description final Stringprompt()Task prompt for the agent final Optional<List<String>>disabledTools()Denylist of tools the agent cannot use. final Optional<List<String>>enabledTools()Allowlist of tools the agent can use. final Optional<String>guidance()Additional context or constraints for this run final Optional<String>instructions()System instructions. final Optional<String>model()LLM model identifier. final Optional<List<String>>objectIds()Scope this run to specific vault object IDs. final Optional<ExecuteCreateParams.Sandbox>sandbox()Custom sandbox resources (cpu, memoryMiB) final Optional<List<String>>vaultIds()Restrict agent to specific vault IDs final JsonField<String>_prompt()Returns the raw JSON value of prompt. final JsonField<List<String>>_disabledTools()Returns the raw JSON value of disabledTools. final JsonField<List<String>>_enabledTools()Returns the raw JSON value of enabledTools. final JsonField<String>_guidance()Returns the raw JSON value of guidance. final JsonField<String>_instructions()Returns the raw JSON value of instructions. final JsonField<String>_model()Returns the raw JSON value of model. final JsonField<List<String>>_objectIds()Returns the raw JSON value of objectIds. final JsonField<ExecuteCreateParams.Sandbox>_sandbox()Returns the raw JSON value of sandbox. final JsonField<List<String>>_vaultIds()Returns the raw JSON value of vaultIds. final Map<String, JsonValue>_additionalBodyProperties()final Headers_additionalHeaders()Additional headers to send with the request. final QueryParams_additionalQueryParams()Additional query param to send with the request. final ExecuteCreateParams.BuildertoBuilder()final ExecuteCreateParams.Body_body()Headers_headers()The full set of headers in the parameters, including both fixed and additional headers. QueryParams_queryParams()The full set of query params in the parameters, including both fixed and additional query params. Booleanequals(Object other)IntegerhashCode()StringtoString()final static ExecuteCreateParams.Builderbuilder()Returns a mutable builder for constructing an instance of ExecuteCreateParams. -
-
Method Detail
-
disabledTools
final Optional<List<String>> disabledTools()
Denylist of tools the agent cannot use. Mutually exclusive with enabledTools — set one or the other, not both.
-
enabledTools
final Optional<List<String>> enabledTools()
Allowlist of tools the agent can use. Mutually exclusive with disabledTools — set one or the other, not both.
-
instructions
final Optional<String> instructions()
System instructions. Defaults to a general-purpose legal assistant prompt if not provided.
-
objectIds
final Optional<List<String>> objectIds()
Scope this run to specific vault object IDs. The agent will only access these objects.
-
sandbox
final Optional<ExecuteCreateParams.Sandbox> sandbox()
Custom sandbox resources (cpu, memoryMiB)
-
_prompt
final JsonField<String> _prompt()
Returns the raw JSON value of prompt.
Unlike prompt, this method doesn't throw if the JSON field has an unexpected type.
-
_disabledTools
final JsonField<List<String>> _disabledTools()
Returns the raw JSON value of disabledTools.
Unlike disabledTools, this method doesn't throw if the JSON field has an unexpected type.
-
_enabledTools
final JsonField<List<String>> _enabledTools()
Returns the raw JSON value of enabledTools.
Unlike enabledTools, this method doesn't throw if the JSON field has an unexpected type.
-
_guidance
final JsonField<String> _guidance()
Returns the raw JSON value of guidance.
Unlike guidance, this method doesn't throw if the JSON field has an unexpected type.
-
_instructions
final JsonField<String> _instructions()
Returns the raw JSON value of instructions.
Unlike instructions, this method doesn't throw if the JSON field has an unexpected type.
-
_model
final JsonField<String> _model()
Returns the raw JSON value of model.
Unlike model, this method doesn't throw if the JSON field has an unexpected type.
-
_objectIds
final JsonField<List<String>> _objectIds()
Returns the raw JSON value of objectIds.
Unlike objectIds, this method doesn't throw if the JSON field has an unexpected type.
-
_sandbox
final JsonField<ExecuteCreateParams.Sandbox> _sandbox()
Returns the raw JSON value of sandbox.
Unlike sandbox, this method doesn't throw if the JSON field has an unexpected type.
-
_vaultIds
final JsonField<List<String>> _vaultIds()
Returns the raw JSON value of vaultIds.
Unlike vaultIds, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalBodyProperties
final Map<String, JsonValue> _additionalBodyProperties()
-
_additionalHeaders
final Headers _additionalHeaders()
Additional headers to send with the request.
-
_additionalQueryParams
final QueryParams _additionalQueryParams()
Additional query param to send with the request.
-
toBuilder
final ExecuteCreateParams.Builder toBuilder()
-
_body
final ExecuteCreateParams.Body _body()
-
_headers
Headers _headers()
The full set of headers in the parameters, including both fixed and additional headers.
-
_queryParams
QueryParams _queryParams()
The full set of query params in the parameters, including both fixed and additional query params.
-
builder
final static ExecuteCreateParams.Builder builder()
Returns a mutable builder for constructing an instance of ExecuteCreateParams.
The following fields are required:
.prompt()
-
-
-
-