1. API
  2. Workbench

Workbench: Get

Last updated Open markdown version

Description

Retrieve a workbench conversation.

Request

HTTP Method: GET

Parameter Description
guid The GUID of the conversation to retrieve. 
curl -X GET \
  https://<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 conversation, including metadata, aggregate AI usage, and the full transcript.

Field description

Parameter Description
guid The conversation GUID.
title The conversation title.
source The source of the conversation (for example, tines or slack).
status The current status of the conversation: in_progress, complete, cancelled, or failed.
conversation_type The type of conversation: workbench, task_agent, chat_agent, or workbench_storyboard.
source_type The type of the resource the conversation is linked to (for example, Story), or null if it has no source.
source_id The ID of the resource the conversation is linked to, or null if it has no source.
favorited Whether the conversation is favorited by the user.
creator_id The ID of the user or agent that created the conversation.
creator_type The type of entity that created the conversation: User or Agent.
created_at ISO 8601 timestamp when the conversation was created.
updated_at ISO 8601 timestamp when the conversation was last updated.
tool_uses_count The total number of tool invocations performed during the conversation.
credits_used The total number of Tines AI credits consumed by the conversation.
billed_cost The total cost of the conversation, as an object with currency (for example, usd) and amount (a string formatted to two decimal places, for example, "0.01").
usage An object summarizing aggregate model token usage. See usage fields.
steps An array of conversation messages including user, assistant, agent, and tool interactions.

Usage fields

Parameter Description
input_tokens The total number of input tokens sent to the model across all messages.
output_tokens The total number of output tokens generated by the model across all messages.
cached_read_input_tokens The total number of input tokens served from the model's prompt cache.
cached_write_input_tokens The total number of input tokens written to the model's prompt cache.
model_ids The list of model IDs used across the conversation.

Sample response

{
  "guid": "ca68403e-5594-42a4-bec7-879b0b417a83",
  "title": "Weather in Dublin",
  "source": "tines",
  "status": "complete",
  "conversation_type": "workbench",
  "source_type": null,
  "source_id": null,
  "favorited": false,
  "creator_id": 12345,
  "creator_type": "User",
  "created_at": "2025-06-20T08:25:30Z",
  "updated_at": "2025-06-20T08:30:15Z",
  "tool_uses_count": 1,
  "credits_used": 250,
  "billed_cost": {
    "currency": "usd",
    "amount": "2.50"
  },
  "usage": {
    "input_tokens": 1840,
    "output_tokens": 412,
    "cached_read_input_tokens": 0,
    "cached_write_input_tokens": 0,
    "model_ids": ["claude-sonnet-4-6"]
  },
  "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?