List

Description

List AI conversations across all surfaces, including workbench, AI agents, and story authoring.

Request

HTTP Method: GET

Parameter Description Required Type
search Optional Search term to filter conversations by title No String
favorited Optional Filter by favorited status (true/false) No Boolean
creator_id Optional Filter conversations by the ID of the creator (user) No Integer
conversation_type Optional Filter by conversation type: workbench, task_agent, chat_agent, or workbench_storyboard. An invalid value returns a 400 response. No String
created_after Optional Only return conversations created at or after this ISO 8601 timestamp No String
created_before Optional Only return conversations created at or before this ISO 8601 timestamp No String
per_page Optional Set the number of results returned per page No Integer
page Optional Specify the page of results to return if there are multiple pages. Defaults to page 1. No Integer

When both created_after and created_before are provided, created_after must be earlier than created_before. Invalid or out-of-order timestamps return a 400 response.

curl -X GET \
  "https://<<META.tenant.domain>>/api/v1/workbench?per_page=20&page=1&search=weather&favorited=true&created_after=2025-06-01T00:00:00Z" \
  -H 'content-type: application/json' \
  -H 'Authorization: Bearer <<CREDENTIAL.tines_api_key>>'

Response

A successful request will return a JSON object containing a paginated list of AI conversations.

Field description

Parameter Description
conversations Array of conversation objects.
guid The conversation GUID.
title The conversation title.
source The source of the conversation (for example, tines or slack).
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, "12.00").

Sample response

{
  "conversations": [
    {
      "guid": "ca68403e-5594-42a4-bec7-879b0b417a83",
      "title": "Reset user password",
      "source": "tines",
      "conversation_type": "workbench",
      "source_type": null,
      "source_id": null,
      "favorited": true,
      "creator_id": 12345,
      "creator_type": "User",
      "created_at": "2025-06-20T08:25:30Z",
      "updated_at": "2025-06-20T08:30:15Z",
      "tool_uses_count": 3,
      "credits_used": 1200,
      "billed_cost": {
        "currency": "usd",
        "amount": "12.00"
      }
    },
    {
      "guid": "b8f2c1a3-9876-4321-a1b2-c3d4e5f6789a",
      "title": "Phishing triage agent",
      "source": "slack",
      "conversation_type": "chat_agent",
      "source_type": null,
      "source_id": null,
      "favorited": false,
      "creator_id": 12345,
      "creator_type": "User",
      "created_at": "2025-06-19T14:20:10Z",
      "updated_at": "2025-06-19T16:45:22Z",
      "tool_uses_count": 7,
      "credits_used": 4250,
      "billed_cost": {
        "currency": "usd",
        "amount": "42.50"
      }
    }
  ],
  "meta": {
    "current_page": "https://<<META.tenant.domain>>/api/v1/workbench?per_page=20&page=1",
    "previous_page": null,
    "next_page": "https://<<META.tenant.domain>>/api/v1/workbench?per_page=20&page=2",
    "next_page_number": 2,
    "per_page": 20,
    "pages": 3,
    "count": 42
  }
}

Pagination

This endpoint supports page-based pagination using the per_page and page parameters:

  • Use per_page to specify the number of results per page
  • Use page to specify which page of results to return (defaults to 1)
  • The response includes a meta object with pagination information including total count and page links

Filtering

  • search: Filters conversations containing the search term in their title
  • favorited: Set to true to only return favorited conversations, false for non-favorited, or omit for all
  • creator_id: Only return conversations created by the specified user ID
  • conversation_type: Only return conversations of the given type. Must be one of workbench, task_agent, chat_agent, or workbench_storyboard; an invalid value returns a 400 response.
  • created_after / created_before: ISO 8601 timestamps that bound the conversation creation date. They can be used independently or together.
Was this helpful?