Load Artifact

GET

apps

{app_name}

users

{user_id}

sessions

{session_id}

artifacts

{artifact_name}

Load Artifact

curl --request GET \
  --url https://api.example.com/apps/{app_name}/users/{user_id}/sessions/{session_id}/artifacts/{artifact_name}

const options = {method: 'GET'};

fetch('https://api.example.com/apps/{app_name}/users/{user_id}/sessions/{session_id}/artifacts/{artifact_name}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/apps/{app_name}/users/{user_id}/sessions/{session_id}/artifacts/{artifact_name}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/apps/{app_name}/users/{user_id}/sessions/{session_id}/artifacts/{artifact_name}"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/apps/{app_name}/users/{user_id}/sessions/{session_id}/artifacts/{artifact_name}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "mediaResolution": {
    "numTokens": 123
  },
  "codeExecutionResult": {
    "output": "<string>",
    "id": "<string>"
  },
  "executableCode": {
    "code": "<string>",
    "id": "<string>"
  },
  "fileData": {
    "displayName": "<string>",
    "fileUri": "<string>",
    "mimeType": "<string>"
  },
  "functionCall": {
    "id": "<string>",
    "args": {},
    "name": "<string>",
    "partialArgs": [
      {
        "boolValue": true,
        "jsonPath": "<string>",
        "nullValue": "<string>",
        "numberValue": 123,
        "stringValue": "<string>",
        "willContinue": true
      }
    ],
    "willContinue": true
  },
  "functionResponse": {
    "willContinue": true,
    "parts": [
      {
        "inlineData": {
          "mimeType": "<string>",
          "data": "<string>",
          "displayName": "<string>"
        },
        "fileData": {
          "fileUri": "<string>",
          "mimeType": "<string>",
          "displayName": "<string>"
        }
      }
    ],
    "id": "<string>",
    "name": "<string>",
    "response": {}
  },
  "inlineData": {
    "data": "<string>",
    "displayName": "<string>",
    "mimeType": "<string>"
  },
  "text": "<string>",
  "thought": true,
  "thoughtSignature": "<string>",
  "videoMetadata": {
    "endOffset": "<string>",
    "fps": 123,
    "startOffset": "<string>"
  },
  "toolCall": {
    "id": "<string>",
    "args": {}
  },
  "toolResponse": {
    "id": "<string>",
    "response": {}
  },
  "partMetadata": {},
  "audioTranscription": {
    "text": "<string>",
    "finished": true,
    "languageCode": "<string>",
    "speakerLabel": "<string>",
    "words": [
      {
        "word": "<string>",
        "startOffset": "<string>",
        "endOffset": "<string>"
      }
    ]
  }
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Path Parameters

app_name

string

required

user_id

string

required

session_id

string

required

artifact_name

string

required

Query Parameters

version

integer | null

Response

Part · object | null

Successful Response

A datatype containing media content.

Exactly one field within a Part should be set, representing the specific type of content being conveyed. Using multiple fields within the same Part instance is considered invalid.

mediaResolution

PartMediaResolution · object | null

Media resolution for the input media.

Show child attributes

codeExecutionResult

CodeExecutionResult · object | null

Optional. The result of executing the ExecutableCode.

Show child attributes

executableCode

ExecutableCode · object | null

Optional. Code generated by the model that is intended to be executed.

Show child attributes

fileData

FileData · object | null

Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage.

Show child attributes

functionCall

FunctionCall · object | null

Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function.

Show child attributes

functionResponse

FunctionResponse · object | null

Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted.

Show child attributes

inlineData

Blob · object | null

Optional. The inline data content of the part. This can be used to include images, audio, or video in a request.

Show child attributes

text

string | null

Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example @my-repo will be converted to and sent as **my-repo** by the IDE agent.

thought

boolean | null

Optional. Indicates whether the part represents the model's thought process or reasoning.

thoughtSignature

string | null

Optional. An opaque signature for the thought so it can be reused in subsequent requests.

videoMetadata

VideoMetadata · object | null

Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.

Show child attributes

toolCall

ToolCall · object | null

Server-side tool call. This field is populated when the model predicts a tool invocation that should be executed on the server. The client is expected to echo this message back to the API.

Show child attributes

toolResponse

ToolResponse · object | null

The output from a server-side ToolCall execution. This field is populated by the client with the results of executing the corresponding ToolCall.

Show child attributes

partMetadata

Partmetadata · object | null

Custom metadata associated with the Part. Agents using genai.Part as content representation may need to keep track of the additional information. For example it can be name of a file/source from which the Part originates or a way to multiplex multiple Part streams. This field is not supported in Vertex AI.

audioTranscription

Transcription · object | null

Output only. The transcription of the audio part.

Show child attributes

Create Session

Delete Artifact

⌘I

Load Artifact

curl --request GET \
  --url https://api.example.com/apps/{app_name}/users/{user_id}/sessions/{session_id}/artifacts/{artifact_name}

const options = {method: 'GET'};

fetch('https://api.example.com/apps/{app_name}/users/{user_id}/sessions/{session_id}/artifacts/{artifact_name}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/apps/{app_name}/users/{user_id}/sessions/{session_id}/artifacts/{artifact_name}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/apps/{app_name}/users/{user_id}/sessions/{session_id}/artifacts/{artifact_name}"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/apps/{app_name}/users/{user_id}/sessions/{session_id}/artifacts/{artifact_name}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "mediaResolution": {
    "numTokens": 123
  },
  "codeExecutionResult": {
    "output": "<string>",
    "id": "<string>"
  },
  "executableCode": {
    "code": "<string>",
    "id": "<string>"
  },
  "fileData": {
    "displayName": "<string>",
    "fileUri": "<string>",
    "mimeType": "<string>"
  },
  "functionCall": {
    "id": "<string>",
    "args": {},
    "name": "<string>",
    "partialArgs": [
      {
        "boolValue": true,
        "jsonPath": "<string>",
        "nullValue": "<string>",
        "numberValue": 123,
        "stringValue": "<string>",
        "willContinue": true
      }
    ],
    "willContinue": true
  },
  "functionResponse": {
    "willContinue": true,
    "parts": [
      {
        "inlineData": {
          "mimeType": "<string>",
          "data": "<string>",
          "displayName": "<string>"
        },
        "fileData": {
          "fileUri": "<string>",
          "mimeType": "<string>",
          "displayName": "<string>"
        }
      }
    ],
    "id": "<string>",
    "name": "<string>",
    "response": {}
  },
  "inlineData": {
    "data": "<string>",
    "displayName": "<string>",
    "mimeType": "<string>"
  },
  "text": "<string>",
  "thought": true,
  "thoughtSignature": "<string>",
  "videoMetadata": {
    "endOffset": "<string>",
    "fps": 123,
    "startOffset": "<string>"
  },
  "toolCall": {
    "id": "<string>",
    "args": {}
  },
  "toolResponse": {
    "id": "<string>",
    "response": {}
  },
  "partMetadata": {},
  "audioTranscription": {
    "text": "<string>",
    "finished": true,
    "languageCode": "<string>",
    "speakerLabel": "<string>",
    "words": [
      {
        "word": "<string>",
        "startOffset": "<string>",
        "endOffset": "<string>"
      }
    ]
  }
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Overview

Endpoints

Path Parameters

Query Parameters

Response