Type Alias CreateAgentInteraction

CreateAgentInteraction: {
    agent: AgentOption;
    agent_config?: DynamicAgentConfig | DeepResearchAgentConfig;
    background?: boolean;
    environment?: Environment | string;
    input: InteractionsInput;
    previous_interaction_id?: string;
    response_format?: ResponseFormat[] | ResponseFormat;
    response_mime_type?: string;
    response_modalities?: ResponseModality[];
    service_tier?: ServiceTier;
    store?: boolean;
    stream?: boolean;
    system_instruction?: string;
    tools?: Tool[];
    webhook_config?: WebhookConfig;
}

Parameters for creating agent interactions

Type declaration

  • agent: AgentOption

    The agent to interact with.

  • Optionalagent_config?: DynamicAgentConfig | DeepResearchAgentConfig

    Configuration parameters for the agent interaction.

  • Optionalbackground?: boolean

    Input only. Whether to run the model interaction in the background.

  • Optionalenvironment?: Environment | string

    The environment configuration for the interaction. Can be an object specifying remote environment sources or a string referencing an existing environment ID.

  • input: InteractionsInput

    The input for the interaction.

  • Optionalprevious_interaction_id?: string

    The ID of the previous interaction, if any.

  • Optionalresponse_format?: ResponseFormat[] | ResponseFormat

    Enforces that the generated response is a JSON object that complies with the JSON schema specified in this field.

  • Optionalresponse_mime_type?: string

    The mime type of the response. This is required if response_format is set.

    Deprecated

    field: This will be removed in a future release, please migrate away from it as soon as possible.

  • Optionalresponse_modalities?: ResponseModality[]

    The requested modalities of the response (TEXT, IMAGE, AUDIO).

  • Optionalservice_tier?: ServiceTier
  • Optionalstore?: boolean

    Input only. Whether to store the response and request for later retrieval.

  • Optionalstream?: boolean

    Input only. Whether the interaction will be streamed.

  • Optionalsystem_instruction?: string

    System instruction for the interaction.

  • Optionaltools?: Tool[]

    A list of tool declarations the model may call during interaction.

  • Optionalwebhook_config?: WebhookConfig

    Message for configuring webhook events for a request.

Settings