Get

Description

Retrieve a workbench conversation.

Request

HTTP Method: GET

Parameter Description
guid The GUID of the conversation to retrieve. 
curl -X GET \
  https://<<META.tenant.domain>>/api/v1/workbench/<<guid>> \
  -H 'content-type: application/json' \
  -H 'Authorization: Bearer <<CREDENTIAL.tines_api_key>>'

Response

A successful request will return a JSON object representing the specified workbench conversation.

Field description

Parameter Description
guid The conversation GUID.
steps An array of conversation messages including user, assistant, and tool interactions.

Sample response

{
  "guid": "ca68403e-5594-42a4-bec7-879b0b417a83",
  "steps": [
    {
      "role": "user",
      "contents": [
        {
          "text": "what is the weather in dublin",
          "type": "text"
        }
      ]
    },
    {
      "role": "assistant",
      "contents": [
        {
          "type": "text",
          "text": "I'll check the current weather in Dublin for you."
        }
      ]
    },
    {
      "role": "tool",
      "name": "simple_weather_api_get_weather_at_location",
      "inputs": {
        "location": "Dublin"
      },
      "output": {
        "body": {
          "dt": 1750408079,
          "uvi": 2.32,
          "temp": 294.61,
          "clouds": 75,
          "sunset": 1750453002,
          "sunrise": 1750391791,
          "weather": [
            {
              "id": 803,
              "icon": "04d",
              "main": "Clouds",
              "description": "broken clouds"
            }
          ],
          "humidity": 63,
          "location": "Dublin",
          "pressure": 1020,
          "wind_deg": 140,
          "dew_point": 287.28,
          "feels_like": 294.46,
          "visibility": 10000,
          "wind_speed": 4.12
        },
        "meta": {
          "response_time": 2.341445
        },
        "status": 200,
        "headers": {
          "date": "Fri, 20 Jun 2025 08:28:00 GMT",
          "connection": "keep-alive",
          "content-type": "application/json; charset=utf-8",
          "x-request-id": "27f3829f-b8d3-462b-926d-887922459c36",
          "cache-control": "max-age=0, private, must-revalidate",
          "content-length": "318",
          "x-tines-status": "data_received",
          "referrer-policy": "strict-origin-when-cross-origin",
          "x-frame-options": "SAMEORIGIN",
          "x-tines-event-id": "198402032",
          "x-tines-revision": "47076c83",
          "x-xss-protection": "0",
          "x-download-options": "noopen",
          "content-disposition": "inline",
          "x-content-type-options": "nosniff",
          "x-tines-exit-action-id": "145208",
          "content-security-policy": "default-src 'none'",
          "x-tines-response-location": "https://v1.simple-weather-api.com/api/public/weather/result/yFb6cLyLoY0SZRpevrYCQg==",
          "x-permitted-cross-domain-policies": "none"
        }
      }
    },
    {
      "role": "assistant",
      "contents": [
        {
          "type": "text",
          "text": "Currently in Dublin, it's 21.46°C (70.63°F) with broken clouds. The humidity is at 63% with a wind speed of 4.12 m/s from the southeast (140°). Visibility is good at 10 km, and the air pressure is 1020 hPa. The sun rose at 5:43 AM and will set at 9:50 PM local time."
        }
      ]
    },
    {
      "role": "user",
      "contents": [
        {
          "text": "thanks workbench",
          "type": "text"
        }
      ]
    },
    {
      "role": "assistant",
      "contents": [
        {
          "type": "text",
          "text": "You're welcome! Let me know if you need any other information."
        }
      ]
    }
  ]
}
Was this helpful?