
<section>
    <h1>Cortex Lite Agent</h1>
</section>


The main request object for running the Cortex agent.
Contains all necessary information for processing a user query.


The conversation history and current message.
Contains both user queries and assistant responses in chronological order.


Represents a single message in the conversation.
Can be either from the user or the assistant.


The identifier of the LLM to use for processing.

The id of the message from which this run should begin.


Optional instructions to guide the model's response style and behavior.
Can be used to set the tone, format, or specific requirements for responses.


Configures how tools should be selected and used during the interaction.
Controls whether tool use is automatic, required, or specific tools should be used.


Configuration for each tool referenced in the tools array.
Keys must match the name field of tools.


List of tools available for the agent to use.
Tools may have a corresponding configuration in tool_resources.


Defines a tool that can be used by the agent.
Tools provide specific capabilities like data analysis, search, or generic functions.


Configure External Oauth with Snowflake (see <a href=https://docs.snowflake.com/en/user-guide/oauth-ext-overview>External OAuth overview</a>.) Set `X-Snowflake-Authorization-Token-Type` to `OAUTH` and set the Token to the auth token received from the external Auth server.

Set `X-Snowflake-Authorization-Token-Type` to `KEYPAIR_JWT` if the token is a key-pair authentication JWT.

Set `X-Snowflake-Authorization-Token-Type` to `OAUTH` if the token is snowflakeOAuth

Snowflake, Inc.

OpenAPI 3.0 specification for the Cortex Agent API

Cortex Agent API

Send a Cortex Agent Run Request to get results.

Bad Request. The request payload is invalid or malformed. This happens if the application didn't send the correct request payload. The response body may include the error code and message indicating the actual cause. The application must reconstruct the request body for retry.

Unauthorized. The request is not authorized. This happens if the attached access token is invalid or missing. The response body may include the error code and message indicating the actual cause, e.g., expired, invalid token. The application must obtain a new access token for retry.

Forbidden. The request is forbidden. This can also happen if the request is made even if the API is not enabled.

Not Found. The request endpoint is not valid. This happens if the API endpoint does not exist, or if the API is not enabled.

Method Not Allowed. The request method doesn't match the supported API. This happens, for example, if the application calls the API with GET method but the endpoint accepts only POST.

Request Timeout. This indicates that the request from the client timed out and was not completed by the server.

Conflict. The requested operation could not be performed due to a conflicting state that could not be resolved. This usually happens when a CREATE request was performed when there is a pre-existing resource with the same name, and also without one of the options orReplace/ifNotExists.

Internal Server Error. The server hit an unrecoverable system error. The response body may include the error code and message for further guidance. The application owner may need to reach out the customer support.

Service Unavailable. The request was not processed due to server side timeouts. The application may retry with backoff. The jittered backoff is recommended.

Gateway Timeout. The request was not processed due to server side timeouts. The application may retry with backoff. The jittered backoff is recommended.

Cortex Lite Agent

Send a Cortex Agent Run Request¶

响应¶

响应正文架构¶