Model Grok xAI di Gemini Enterprise Agent Platform mendukung Responses API untuk menghasilkan respons.
Halaman ini menunjukkan cara melakukan panggilan ke model Grok menggunakan Responses API.
Sebelum memulai
Untuk menggunakan model Grok dengan Gemini Enterprise Agent Platform, Anda harus melakukan langkah-langkah berikut. Gemini Enterprise Agent Platform API (aiplatform.googleapis.com) harus diaktifkan.
- Login ke akun Google Cloud Anda. Jika Anda baru menggunakan Google Cloud, buat akun untuk mengevaluasi performa produk kami dalam skenario dunia nyata. Pelanggan baru juga mendapatkan kredit gratis senilai $300 untuk menjalankan, menguji, dan men-deploy workload.
-
In the Google Cloud console, on the project selector page, select or create a Google Cloud project.
Roles required to select or create a project
- Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
-
Create a project: To create a project, you need the Project Creator role
(
roles/resourcemanager.projectCreator), which contains theresourcemanager.projects.createpermission. Learn how to grant roles.
-
Verify that billing is enabled for your Google Cloud project.
Enable the Gemini Enterprise Agent Platform API, if it is not already enabled.
Roles required to enable APIs
To enable APIs, you need the
serviceusage.services.enablepermission. If you created the project, then you likely already have this permission through the Owner role (roles/owner). Otherwise, you can get this permission through the Service Usage Admin role (roles/serviceusage.serviceUsageAdmin). Learn how to grant roles.-
In the Google Cloud console, on the project selector page, select or create a Google Cloud project.
Roles required to select or create a project
- Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
-
Create a project: To create a project, you need the Project Creator role
(
roles/resourcemanager.projectCreator), which contains theresourcemanager.projects.createpermission. Learn how to grant roles.
-
Verify that billing is enabled for your Google Cloud project.
Enable the Gemini Enterprise Agent Platform API, if it is not already enabled.
Roles required to enable APIs
To enable APIs, you need the
serviceusage.services.enablepermission. If you created the project, then you likely already have this permission through the Owner role (roles/owner). Otherwise, you can get this permission through the Service Usage Admin role (roles/serviceusage.serviceUsageAdmin). Learn how to grant roles.
Melakukan panggilan stateless ke Responses API
Nilai default untuk store adalah false, sehingga permintaan bersifat stateless kecuali jika Anda menetapkan store ke true. Contoh berikut
menetapkan store ke false (atau False di
Python) secara eksplisit.
Melakukan panggilan non-streaming ke Responses API
Contoh berikut menunjukkan cara melakukan panggilan non-streaming ke Responses API:
Python
Sebelum mencoba contoh ini, ikuti petunjuk penyiapan Python di Panduan memulai Agent Platform menggunakan library klien.
Untuk melakukan autentikasi ke Agent Platform, siapkan Kredensial Default Aplikasi. Untuk mengetahui informasi selengkapnya, lihat Menyiapkan autentikasi untuk lingkungan pengembangan lokal.
Sebelum menjalankan contoh ini, pastikan untuk menetapkan variabel lingkungan OPENAI_BASE_URL atau menyiapkan kredensial OAuth.
Untuk mengetahui informasi selengkapnya, lihat Autentikasi dan kredensial.
import google.auth import google.auth.transport.requests from openai import OpenAI credentials, _ = google.auth.default( scopes=["https://www.googleapis.com/auth/cloud-platform"] ) credentials.refresh(google.auth.transport.requests.Request()) client = OpenAI( base_url="https://aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/global/endpoints/openapi", api_key=credentials.token, ) response = client.responses.create( model="MODEL", input="INPUT", max_output_tokens=MAX_OUTPUT_TOKENS, stream=False, store=False, ) print(response)
- PROJECT_ID: Project ID Google Cloud Anda.
- MODEL: Nama model yang ingin Anda gunakan, misalnya
xai/grok-4.7. - INPUT: Perintah atau input untuk model.
- MAX_OUTPUT_TOKENS:
Jumlah maksimum token yang dapat dibuat dalam respons. Token terdiri dari sekitar empat karakter. 100 token setara dengan sekitar 60-80 kata.
Tentukan nilai yang lebih rendah untuk respons yang lebih singkat dan nilai yang lebih tinggi untuk respons yang berpotensi lebih panjang.
REST
Setelah menyiapkan lingkungan, Anda dapat menggunakan REST untuk menguji perintah teks. Contoh berikut mengirimkan permintaan ke endpoint model penayang.
Sebelum menggunakan salah satu data permintaan, lakukan penggantian berikut:
- PROJECT_ID: Project ID Google Cloud Anda.
- MODEL: Nama model yang ingin Anda gunakan, misalnya
xai/grok-4.7. - INPUT: Perintah atau input untuk model.
- MAX_OUTPUT_TOKENS:
Jumlah maksimum token yang dapat dibuat dalam respons. Token terdiri dari sekitar empat karakter. 100 token setara dengan sekitar 60-80 kata.
Tentukan nilai yang lebih rendah untuk respons yang lebih singkat dan nilai yang lebih tinggi untuk respons yang berpotensi lebih panjang.
Metode HTTP dan URL:
POST https://aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/global/endpoints/openapi/responses
Meminta isi JSON:
{
"model": "MODEL",
"input": "INPUT",
"max_output_tokens": MAX_OUTPUT_TOKENS,
"stream": false,
"store": false
}
Untuk mengirim permintaan Anda, pilih salah satu opsi berikut:
curl
Simpan isi permintaan dalam file bernama request.json,
dan jalankan perintah berikut:
curl -X POST \
-H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
-H "Content-Type: application/json; charset=utf-8" \
-d @request.json \
"https://aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/global/endpoints/openapi/responses"
PowerShell
Simpan isi permintaan dalam file bernama request.json,
dan jalankan perintah berikut:
$cred = gcloud auth application-default print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }
Invoke-WebRequest `
-Method POST `
-Headers $headers `
-ContentType: "application/json; charset=utf-8" `
-InFile request.json `
-Uri "https://aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/global/endpoints/openapi/responses" | Select-Object -Expand Content
Contoh berikut menunjukkan permintaan curl lengkap:
curl -s -X POST \ -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \ -H "Content-Type: application/json" \ "https://aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/global/endpoints/openapi/responses" \ -d '{ "model": "xai/grok-4.7", "input": "Explain black holes in one short sentence.", "max_output_tokens": 100, "stream": false, "store": false }'
Berdasarkan definisi Responses API, respons non-streaming akan berisi ID unik, metadata model, statistik penggunaan, dan array output yang berisi teks yang dihasilkan.
{
"background": false,
"completed_at": 1778892918,
"created_at": 1778892916,
"error": null,
"frequency_penalty": 0,
"id": "c8AHavnIMP6UifEPgIfcgAg",
"incomplete_details": null,
"instructions": null,
"max_output_tokens": null,
"max_tool_calls": null,
"metadata": {
"system_fingerprint": "fp_39c5j0a3e9"
},
"model": "MODEL",
"object": "response",
"output": [
{
"content": [
{
"annotations": [],
"logprobs": [],
"text": "OUTPUT_TEXT",
"type": "output_text"
}
],
"id": "msg_c8AHavnIMP6UifEPgIfcgAg",
"role": "assistant",
"status": "completed",
"type": "message"
}
],
"parallel_tool_calls": true,
"presence_penalty": 0,
"previous_response_id": null,
"prompt_cache_key": null,
"reasoning": {
"effort": "medium",
"summary": "detailed"
},
"safety_identifier": null,
"service_tier": "default",
"status": "completed",
"store": false,
"temperature": 0.7,
"text": {
"format": {
"type": "text"
}
},
"tool_choice": "auto",
"tools": [],
"top_logprobs": 0,
"top_p": 0.95,
"truncation": "disabled",
"usage": {
"extra_properties": {
"google": {
"traffic_type": "ON_DEMAND"
}
},
"input_tokens": 335,
"input_tokens_details": {
"cached_tokens": 320
},
"num_server_side_tools_used": 0,
"num_sources_used": 0,
"output_tokens": 305,
"output_tokens_details": {
"reasoning_tokens": 284
},
"total_tokens": 640
},
"user": null
}
Melakukan panggilan streaming ke Responses API
Contoh berikut menunjukkan cara melakukan panggilan streaming ke Responses API:
Python
Sebelum mencoba contoh ini, ikuti petunjuk penyiapan Python di Panduan memulai Agent Platform menggunakan library klien.
Untuk melakukan autentikasi ke Agent Platform, siapkan Kredensial Default Aplikasi. Untuk mengetahui informasi selengkapnya, lihat Menyiapkan autentikasi untuk lingkungan pengembangan lokal.
Sebelum menjalankan contoh ini, pastikan untuk menetapkan variabel lingkungan OPENAI_BASE_URL atau menyiapkan kredensial OAuth.
Untuk mengetahui informasi selengkapnya, lihat Autentikasi dan kredensial.
import google.auth import google.auth.transport.requests from openai import OpenAI credentials, _ = google.auth.default( scopes=["https://www.googleapis.com/auth/cloud-platform"] ) credentials.refresh(google.auth.transport.requests.Request()) client = OpenAI( base_url="https://aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/global/endpoints/openapi", api_key=credentials.token, ) stream = client.responses.create( model="MODEL", input="INPUT", max_output_tokens=MAX_OUTPUT_TOKENS, stream=True, store=False, ) for event in stream: if event.type == "response.output_text.delta": print(event.delta, end="")
- PROJECT_ID: Project ID Google Cloud Anda.
- MODEL: Nama model yang ingin Anda gunakan, misalnya
xai/grok-4.7. - INPUT: Perintah atau input untuk model.
- MAX_OUTPUT_TOKENS:
Jumlah maksimum token yang dapat dibuat dalam respons. Token terdiri dari sekitar empat karakter. 100 token setara dengan sekitar 60-80 kata.
Tentukan nilai yang lebih rendah untuk respons yang lebih singkat dan nilai yang lebih tinggi untuk respons yang berpotensi lebih panjang.
REST
Setelah menyiapkan lingkungan, Anda dapat menggunakan REST untuk menguji perintah teks. Contoh berikut mengirimkan permintaan ke endpoint model penayang.
Sebelum menggunakan salah satu data permintaan, lakukan penggantian berikut:
- PROJECT_ID: Project ID Google Cloud Anda.
- MODEL: Nama model yang ingin Anda gunakan, misalnya
xai/grok-4.7. - INPUT: Perintah atau input untuk model.
- MAX_OUTPUT_TOKENS:
Jumlah maksimum token yang dapat dibuat dalam respons. Token terdiri dari sekitar empat karakter. 100 token setara dengan sekitar 60-80 kata.
Tentukan nilai yang lebih rendah untuk respons yang lebih singkat dan nilai yang lebih tinggi untuk respons yang berpotensi lebih panjang.
Metode HTTP dan URL:
POST https://aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/global/endpoints/openapi/responses
Meminta isi JSON:
{
"model": "MODEL",
"input": "INPUT",
"max_output_tokens": MAX_OUTPUT_TOKENS,
"stream": true,
"store": false
}
Untuk mengirim permintaan Anda, pilih salah satu opsi berikut:
curl
Simpan isi permintaan dalam file bernama request.json,
dan jalankan perintah berikut:
curl -X POST \
-H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
-H "Content-Type: application/json; charset=utf-8" \
-d @request.json \
"https://aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/global/endpoints/openapi/responses"
PowerShell
Simpan isi permintaan dalam file bernama request.json,
dan jalankan perintah berikut:
$cred = gcloud auth application-default print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }
Invoke-WebRequest `
-Method POST `
-Headers $headers `
-ContentType: "application/json; charset=utf-8" `
-InFile request.json `
-Uri "https://aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/global/endpoints/openapi/responses" | Select-Object -Expand Content
Melakukan panggilan stateful ke Responses API
Untuk membuat permintaan stateful, Anda harus mengonfigurasi
Organization Policy Service untuk mengizinkannya.
Secara khusus, perbarui batasan
constraints/vertexai.allowedPartnerModelFeatures dengan menambahkan
publishers/xai/models/MODEL_NAME:stateful_responses_api
ke nilai yang diizinkan (misalnya,
publishers/xai/models/grok-4.7:stateful_responses_api). Untuk mengetahui
informasi selengkapnya, lihat
Mengontrol akses model.
Responses API mendukung percakapan multi-giliran melalui permintaan stateful.
Nilai default untuk store adalah false, jadi untuk membuat permintaan stateful, Anda harus
secara eksplisit menetapkan store ke true. Dalam percakapan stateful, Anda dapat merujuk
respons sebelumnya dengan memberikan id-nya di kolom previous_response_id.
Membuat respons
Contoh berikut menunjukkan percakapan dua giliran menggunakan Responses API:
Giliran 1: Permintaan awal
Pada giliran pertama, buat permintaan dengan store yang ditetapkan ke true. Jika Anda menghilangkan parameter store, parameter ini akan ditetapkan secara default ke false dan respons tidak akan disimpan.
Python
Sebelum mencoba contoh ini, ikuti petunjuk penyiapan Python di Panduan memulai Agent Platform menggunakan library klien.
Untuk melakukan autentikasi ke Agent Platform, siapkan Kredensial Default Aplikasi. Untuk mengetahui informasi selengkapnya, lihat Menyiapkan autentikasi untuk lingkungan pengembangan lokal.
Sebelum menjalankan contoh ini, pastikan untuk menetapkan variabel lingkungan OPENAI_BASE_URL atau menyiapkan kredensial OAuth.
Untuk mengetahui informasi selengkapnya, lihat Autentikasi dan kredensial.
import google.auth import google.auth.transport.requests from openai import OpenAI credentials, _ = google.auth.default( scopes=["https://www.googleapis.com/auth/cloud-platform"] ) credentials.refresh(google.auth.transport.requests.Request()) client = OpenAI( base_url="https://aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/global/endpoints/openapi", api_key=credentials.token, ) response = client.responses.create( model="MODEL", input="randomly pick 3 colors, just return the words of the colors", store=True, ) print(response)
- PROJECT_ID: Project ID Google Cloud Anda.
- MODEL: Nama model yang ingin Anda gunakan, misalnya
xai/grok-4.7.
Contoh respons untuk Giliran 1:
{ "background": false, "completed_at": 1793834418, "created_at": 1793834418, "error": null, "frequency_penalty": 0, "id": "5f76a045-71d9-45af-8b07-1f2feae0675a", "incomplete_details": null, "instructions": null, "max_output_tokens": null, "max_tool_calls": null, "metadata": { "system_fingerprint": "fp_grok47_0" }, "model": "xai/grok-4.7", "object": "response", "output": [ { "content": [ { "annotations": [], "logprobs": [], "text": "cerulean amber violet", "type": "output_text" } ], "id": "msg_5f76a045-71d9-45af-8b07-1f2feae0675a", "role": "assistant", "status": "completed", "type": "message" } ], "parallel_tool_calls": true, "presence_penalty": 0, "previous_response_id": null, "prompt_cache_key": null, "reasoning": { "effort": "high", "summary": "detailed" }, "safety_identifier": null, "service_tier": "default", "status": "completed", "store": true, "temperature": 0.7, "text": { "format": { "type": "text" } }, "tool_choice": "auto", "tools": [], "top_logprobs": 0, "top_p": 0.95, "truncation": "disabled", "usage": { "context_details": { "input_tokens": 220, "output_tokens": 144 }, "extra_properties": { "google": { "traffic_type": "ON_DEMAND" } }, "input_tokens": 220, "input_tokens_details": { "cached_tokens": 0 }, "num_server_side_tools_used": 0, "num_sources_used": 0, "output_tokens": 144, "output_tokens_details": { "reasoning_tokens": 139 }, "total_tokens": 364 }, "user": null }
REST
Setelah menyiapkan lingkungan, Anda dapat menggunakan REST untuk menguji perintah teks. Contoh berikut mengirimkan permintaan ke endpoint model penayang.
Sebelum menggunakan salah satu data permintaan, lakukan penggantian berikut:
- PROJECT_ID: Project ID Google Cloud Anda.
- MODEL: Nama model yang ingin Anda gunakan, misalnya
xai/grok-4.7.
Metode HTTP dan URL:
POST https://aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/global/endpoints/openapi/responses
Meminta isi JSON:
{
"model": "MODEL",
"input": "randomly pick 3 colors, just return the words of the colors",
"store": true
}
Untuk mengirim permintaan Anda, pilih salah satu opsi berikut:
curl
Simpan isi permintaan dalam file bernama request.json,
dan jalankan perintah berikut:
curl -X POST \
-H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
-H "Content-Type: application/json; charset=utf-8" \
-d @request.json \
"https://aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/global/endpoints/openapi/responses"
PowerShell
Simpan isi permintaan dalam file bernama request.json,
dan jalankan perintah berikut:
$cred = gcloud auth application-default print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }
Invoke-WebRequest `
-Method POST `
-Headers $headers `
-ContentType: "application/json; charset=utf-8" `
-InFile request.json `
-Uri "https://aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/global/endpoints/openapi/responses" | Select-Object -Expand Content
Contoh berikut menunjukkan permintaan curl lengkap:
curl -X POST \ -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \ -H "Content-Type: application/json" \ "https://aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/global/endpoints/openapi/responses" \ -d '{ "model": "xai/grok-4.7", "input": "randomly pick 3 colors, just return the words of the colors", "store": true }'
Contoh respons untuk Giliran 1:
{
"background": false,
"completed_at": 1793834418,
"created_at": 1793834418,
"error": null,
"frequency_penalty": 0,
"id": "5f76a045-71d9-45af-8b07-1f2feae0675a",
"incomplete_details": null,
"instructions": null,
"max_output_tokens": null,
"max_tool_calls": null,
"metadata": {
"system_fingerprint": "fp_grok47_0"
},
"model": "xai/grok-4.7",
"object": "response",
"output": [
{
"content": [
{
"annotations": [],
"logprobs": [],
"text": "cerulean amber violet",
"type": "output_text"
}
],
"id": "msg_5f76a045-71d9-45af-8b07-1f2feae0675a",
"role": "assistant",
"status": "completed",
"type": "message"
}
],
"parallel_tool_calls": true,
"presence_penalty": 0,
"previous_response_id": null,
"prompt_cache_key": null,
"reasoning": {
"effort": "high",
"summary": "detailed"
},
"safety_identifier": null,
"service_tier": "default",
"status": "completed",
"store": true,
"temperature": 0.7,
"text": {
"format": {
"type": "text"
}
},
"tool_choice": "auto",
"tools": [],
"top_logprobs": 0,
"top_p": 0.95,
"truncation": "disabled",
"usage": {
"context_details": {
"input_tokens": 220,
"output_tokens": 144
},
"extra_properties": {
"google": {
"traffic_type": "ON_DEMAND"
}
},
"input_tokens": 220,
"input_tokens_details": {
"cached_tokens": 0
},
"num_server_side_tools_used": 0,
"num_sources_used": 0,
"output_tokens": 144,
"output_tokens_details": {
"reasoning_tokens": 139
},
"total_tokens": 364
},
"user": null
}
Giliran 2: Permintaan lanjutan
Pada giliran kedua, referensikan ID dari respons sebelumnya dalam parameter previous_response_id. Tetapkan store ke true jika Anda juga ingin menyimpan
respons ini, misalnya untuk melanjutkan percakapan atau mengambilnya
nanti.
Python
Sebelum mencoba contoh ini, ikuti petunjuk penyiapan Python di Panduan memulai Agent Platform menggunakan library klien.
Untuk melakukan autentikasi ke Agent Platform, siapkan Kredensial Default Aplikasi. Untuk mengetahui informasi selengkapnya, lihat Menyiapkan autentikasi untuk lingkungan pengembangan lokal.
Sebelum menjalankan contoh ini, pastikan untuk menetapkan variabel lingkungan OPENAI_BASE_URL atau menyiapkan kredensial OAuth.
Untuk mengetahui informasi selengkapnya, lihat Autentikasi dan kredensial.
import google.auth import google.auth.transport.requests from openai import OpenAI credentials, _ = google.auth.default( scopes=["https://www.googleapis.com/auth/cloud-platform"] ) credentials.refresh(google.auth.transport.requests.Request()) client = OpenAI( base_url="https://aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/global/endpoints/openapi", api_key=credentials.token, ) response = client.responses.create( model="MODEL", input="What is the second color?", previous_response_id="PREVIOUS_RESPONSE_ID", store=True, ) print(response)
- PROJECT_ID: Project ID Google Cloud Anda.
- MODEL: Nama model yang ingin Anda gunakan, misalnya
xai/grok-4.7. - PREVIOUS_RESPONSE_ID: ID respons sebelumnya untuk melanjutkan percakapan.
Contoh respons untuk Giliran 2:
{ "background": false, "completed_at": 1793835029, "created_at": 1793835029, "error": null, "frequency_penalty": 0, "id": "ee8b6aa6-777e-4aa2-8db4-46bbfe84491b", "incomplete_details": null, "instructions": null, "max_output_tokens": null, "max_tool_calls": null, "metadata": { "system_fingerprint": "fp_grok47_0" }, "model": "xai/grok-4.7", "object": "response", "output": [ { "content": [ { "annotations": [], "logprobs": [], "text": "amber", "type": "output_text" } ], "id": "msg_ee8b6aa6-777e-4aa2-8db4-46bbfe84491b", "role": "assistant", "status": "completed", "type": "message" } ], "parallel_tool_calls": true, "presence_penalty": 0, "previous_response_id": "5f76a045-71d9-45af-8b07-1f2feae0675a", "prompt_cache_key": null, "reasoning": { "effort": "high", "summary": "detailed" }, "safety_identifier": null, "service_tier": "default", "status": "completed", "store": true, "temperature": 0.7, "text": { "format": { "type": "text" } }, "tool_choice": "auto", "tools": [], "top_logprobs": 0, "top_p": 0.95, "truncation": "disabled", "usage": { "context_details": { "input_tokens": 239, "output_tokens": 41 }, "extra_properties": { "google": { "traffic_type": "ON_DEMAND" } }, "input_tokens": 239, "input_tokens_details": { "cached_tokens": 0 }, "num_server_side_tools_used": 0, "num_sources_used": 0, "output_tokens": 41, "output_tokens_details": { "reasoning_tokens": 40 }, "total_tokens": 280 }, "user": null }
REST
Setelah menyiapkan lingkungan, Anda dapat menggunakan REST untuk menguji perintah teks. Contoh berikut mengirimkan permintaan ke endpoint model penayang.
Sebelum menggunakan salah satu data permintaan, lakukan penggantian berikut:
- PROJECT_ID: Project ID Google Cloud Anda.
- MODEL: Nama model yang ingin Anda gunakan, misalnya
xai/grok-4.7. - PREVIOUS_RESPONSE_ID: ID respons sebelumnya.
Metode HTTP dan URL:
POST https://aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/global/endpoints/openapi/responses
Meminta isi JSON:
{
"model": "MODEL",
"input": "What is the second color?",
"previous_response_id": "PREVIOUS_RESPONSE_ID",
"store": true
}
Untuk mengirim permintaan Anda, pilih salah satu opsi berikut:
curl
Simpan isi permintaan dalam file bernama request.json,
dan jalankan perintah berikut:
curl -X POST \
-H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
-H "Content-Type: application/json; charset=utf-8" \
-d @request.json \
"https://aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/global/endpoints/openapi/responses"
PowerShell
Simpan isi permintaan dalam file bernama request.json,
dan jalankan perintah berikut:
$cred = gcloud auth application-default print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }
Invoke-WebRequest `
-Method POST `
-Headers $headers `
-ContentType: "application/json; charset=utf-8" `
-InFile request.json `
-Uri "https://aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/global/endpoints/openapi/responses" | Select-Object -Expand Content
Contoh berikut menunjukkan permintaan curl lengkap:
curl -X POST \ -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \ -H "Content-Type: application/json" \ "https://aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/global/endpoints/openapi/responses" \ -d '{ "model": "xai/grok-4.7", "input": "What is the second color?", "previous_response_id": "5f76a045-71d9-45af-8b07-1f2feae0675a", "store": true }'
Contoh respons untuk Giliran 2:
{
"background": false,
"completed_at": 1793835029,
"created_at": 1793835029,
"error": null,
"frequency_penalty": 0,
"id": "ee8b6aa6-777e-4aa2-8db4-46bbfe84491b",
"incomplete_details": null,
"instructions": null,
"max_output_tokens": null,
"max_tool_calls": null,
"metadata": {
"system_fingerprint": "fp_grok47_0"
},
"model": "xai/grok-4.7",
"object": "response",
"output": [
{
"content": [
{
"annotations": [],
"logprobs": [],
"text": "amber",
"type": "output_text"
}
],
"id": "msg_ee8b6aa6-777e-4aa2-8db4-46bbfe84491b",
"role": "assistant",
"status": "completed",
"type": "message"
}
],
"parallel_tool_calls": true,
"presence_penalty": 0,
"previous_response_id": "5f76a045-71d9-45af-8b07-1f2feae0675a",
"prompt_cache_key": null,
"reasoning": {
"effort": "high",
"summary": "detailed"
},
"safety_identifier": null,
"service_tier": "default",
"status": "completed",
"store": true,
"temperature": 0.7,
"text": {
"format": {
"type": "text"
}
},
"tool_choice": "auto",
"tools": [],
"top_logprobs": 0,
"top_p": 0.95,
"truncation": "disabled",
"usage": {
"context_details": {
"input_tokens": 239,
"output_tokens": 41
},
"extra_properties": {
"google": {
"traffic_type": "ON_DEMAND"
}
},
"input_tokens": 239,
"input_tokens_details": {
"cached_tokens": 0
},
"num_server_side_tools_used": 0,
"num_sources_used": 0,
"output_tokens": 41,
"output_tokens_details": {
"reasoning_tokens": 40
},
"total_tokens": 280
},
"user": null
}
Mendapatkan respons
Anda dapat mengambil respons yang dibuat sebelumnya berdasarkan ID-nya.
Python
Sebelum mencoba contoh ini, ikuti petunjuk penyiapan Python di Panduan memulai Agent Platform menggunakan library klien.
Untuk melakukan autentikasi ke Agent Platform, siapkan Kredensial Default Aplikasi. Untuk mengetahui informasi selengkapnya, lihat Menyiapkan autentikasi untuk lingkungan pengembangan lokal.
Sebelum menjalankan contoh ini, pastikan untuk menetapkan variabel lingkungan OPENAI_BASE_URL atau menyiapkan kredensial OAuth.
Untuk mengetahui informasi selengkapnya, lihat Autentikasi dan kredensial.
import json import google.auth import google.auth.transport.requests from openai import OpenAI credentials, _ = google.auth.default( scopes=["https://www.googleapis.com/auth/cloud-platform"] ) credentials.refresh(google.auth.transport.requests.Request()) client = OpenAI( base_url="https://aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/global/endpoints/openapi", api_key=credentials.token, ) response_id = "RESPONSE_ID" retrieved_response = client.responses.retrieve(response_id) print(json.dumps(retrieved_response.model_dump(), indent=2))
- PROJECT_ID: Project ID Google Cloud Anda.
- RESPONSE_ID: ID respons yang akan diambil.
Contoh respons:
{ "background": false, "completed_at": 1793834418, "created_at": 1793834418, "error": null, "frequency_penalty": 0, "id": "5f76a045-71d9-45af-8b07-1f2feae0675a", "incomplete_details": null, "instructions": null, "max_output_tokens": null, "max_tool_calls": null, "metadata": { "system_fingerprint": "fp_grok47_0" }, "model": "xai/grok-4.7", "object": "response", "output": [ { "content": [ { "annotations": [], "logprobs": [], "text": "cerulean amber violet", "type": "output_text" } ], "id": "msg_5f76a045-71d9-45af-8b07-1f2feae0675a", "role": "assistant", "status": "completed", "type": "message" } ], "parallel_tool_calls": true, "presence_penalty": 0, "previous_response_id": null, "prompt_cache_key": null, "reasoning": { "effort": "high", "summary": "detailed" }, "safety_identifier": null, "service_tier": "default", "status": "completed", "store": true, "temperature": 0.7, "text": { "format": { "type": "text" } }, "tool_choice": "auto", "tools": [], "top_logprobs": 0, "top_p": 0.95, "truncation": "disabled", "usage": { "context_details": { "input_tokens": 220, "output_tokens": 144 }, "extra_properties": { "google": { "traffic_type": "ON_DEMAND" } }, "input_tokens": 220, "input_tokens_details": { "cached_tokens": 0 }, "num_server_side_tools_used": 0, "num_sources_used": 0, "output_tokens": 144, "output_tokens_details": { "reasoning_tokens": 139 }, "total_tokens": 364 }, "user": null }
REST
Setelah menyiapkan lingkungan, Anda dapat menggunakan REST untuk menguji perintah teks. Contoh berikut mengirimkan permintaan ke endpoint model penayang.
Sebelum menggunakan salah satu data permintaan, lakukan penggantian berikut:
- PROJECT_ID: Project ID Google Cloud Anda.
- RESPONSE_ID: ID respons yang akan diambil.
Metode HTTP dan URL:
GET https://aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/global/endpoints/openapi/responses/RESPONSE_ID
Untuk mengirim permintaan Anda, pilih salah satu opsi berikut:
curl
Jalankan perintah berikut:
curl -X GET \
-H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
"https://aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/global/endpoints/openapi/responses/RESPONSE_ID"
PowerShell
Jalankan perintah berikut:
$cred = gcloud auth application-default print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }
Invoke-WebRequest `
-Method GET `
-Headers $headers `
-Uri "https://aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/global/endpoints/openapi/responses/RESPONSE_ID" | Select-Object -Expand Content
Contoh berikut menunjukkan permintaan curl lengkap:
curl -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \ -H "Content-Type: application/json" \ "https://aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/global/endpoints/openapi/responses/5f76a045-71d9-45af-8b07-1f2feae0675a"
Contoh respons:
{
"background": false,
"completed_at": 1793834418,
"created_at": 1793834418,
"error": null,
"frequency_penalty": 0,
"id": "5f76a045-71d9-45af-8b07-1f2feae0675a",
"incomplete_details": null,
"instructions": null,
"max_output_tokens": null,
"max_tool_calls": null,
"metadata": {
"system_fingerprint": "fp_grok47_0"
},
"model": "xai/grok-4.7",
"object": "response",
"output": [
{
"content": [
{
"annotations": [],
"logprobs": [],
"text": "cerulean amber violet",
"type": "output_text"
}
],
"id": "msg_5f76a045-71d9-45af-8b07-1f2feae0675a",
"role": "assistant",
"status": "completed",
"type": "message"
}
],
"parallel_tool_calls": true,
"presence_penalty": 0,
"previous_response_id": null,
"prompt_cache_key": null,
"reasoning": {
"effort": "high",
"summary": "detailed"
},
"safety_identifier": null,
"service_tier": "default",
"status": "completed",
"store": true,
"temperature": 0.7,
"text": {
"format": {
"type": "text"
}
},
"tool_choice": "auto",
"tools": [],
"top_logprobs": 0,
"top_p": 0.95,
"truncation": "disabled",
"usage": {
"context_details": {
"input_tokens": 220,
"output_tokens": 144
},
"extra_properties": {
"google": {
"traffic_type": "ON_DEMAND"
}
},
"input_tokens": 220,
"input_tokens_details": {
"cached_tokens": 0
},
"num_server_side_tools_used": 0,
"num_sources_used": 0,
"output_tokens": 144,
"output_tokens_details": {
"reasoning_tokens": 139
},
"total_tokens": 364
},
"user": null
}
Menghapus respons
Anda dapat menghapus respons yang dibuat sebelumnya berdasarkan ID-nya.
Setelah menghapus respons, Anda tidak dapat mengambilnya atau menggunakan ID-nya sebagai
previous_response_id dalam permintaan baru. Menghapus respons tidak akan menghapus
kontennya dari respons berikutnya dalam percakapan yang sama: setiap respons yang
mereferensikannya melalui previous_response_id akan menyimpan konten tersebut sebagai konteks
hingga Anda menghapus respons tersebut juga. Untuk menghapus seluruh percakapan, hapus
setiap respons yang tersimpan di dalamnya.
Python
Sebelum mencoba contoh ini, ikuti petunjuk penyiapan Python di Panduan memulai Agent Platform menggunakan library klien.
Untuk melakukan autentikasi ke Agent Platform, siapkan Kredensial Default Aplikasi. Untuk mengetahui informasi selengkapnya, lihat Menyiapkan autentikasi untuk lingkungan pengembangan lokal.
Sebelum menjalankan contoh ini, pastikan untuk menetapkan variabel lingkungan OPENAI_BASE_URL atau menyiapkan kredensial OAuth.
Untuk mengetahui informasi selengkapnya, lihat Autentikasi dan kredensial.
import google.auth import google.auth.transport.requests from openai import OpenAI credentials, _ = google.auth.default( scopes=["https://www.googleapis.com/auth/cloud-platform"] ) credentials.refresh(google.auth.transport.requests.Request()) client = OpenAI( base_url="https://aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/global/endpoints/openapi", api_key=credentials.token, ) response_id = "RESPONSE_ID" delete_response = client.responses.delete(response_id) print(delete_response)
- PROJECT_ID: Project ID Google Cloud Anda.
- RESPONSE_ID: ID respons yang akan dihapus.
Contoh respons:
{ "deleted": true, "id": "5f76a045-71d9-45af-8b07-1f2feae0675a", "object": "response" }
REST
Setelah menyiapkan lingkungan, Anda dapat menggunakan REST untuk menguji perintah teks. Contoh berikut mengirimkan permintaan ke endpoint model penayang.
Sebelum menggunakan salah satu data permintaan, lakukan penggantian berikut:
- PROJECT_ID: Project ID Google Cloud Anda.
- RESPONSE_ID: ID respons yang akan dihapus.
Metode HTTP dan URL:
DELETE https://aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/global/endpoints/openapi/responses/RESPONSE_ID
Untuk mengirim permintaan Anda, pilih salah satu opsi berikut:
curl
Jalankan perintah berikut:
curl -X DELETE \
-H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
"https://aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/global/endpoints/openapi/responses/RESPONSE_ID"
PowerShell
Jalankan perintah berikut:
$cred = gcloud auth application-default print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }
Invoke-WebRequest `
-Method DELETE `
-Headers $headers `
-Uri "https://aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/global/endpoints/openapi/responses/RESPONSE_ID" | Select-Object -Expand Content
Contoh berikut menunjukkan permintaan curl lengkap:
curl -X DELETE \ -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \ -H "Content-Type: application/json" \ "https://aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/global/endpoints/openapi/responses/5f76a045-71d9-45af-8b07-1f2feae0675a"
Contoh respons:
{
"deleted": true,
"id": "5f76a045-71d9-45af-8b07-1f2feae0675a",
"object": "response"
}
Langkah berikutnya
- Pelajari lebih lanjut model Grok.
- Pelajari cara menggunakan Panggilan fungsi dengan Responses API.
- Pelajari cara menggunakan Output terstruktur dengan Responses API.