Search Conversations

Version 4.0.26.10 (latest)

Search Conversations

Returns an array of conversation objects that match the specified search criteria. This will only return conversations owned by the current user.

The parameters limit, and offset are recommended for fetching results in page-size chunks.

Get a single conversation by id with get_conversation()

Request

GET /conversations/search
Datatype
Description
Request
HTTP Request
query
HTTP Query
Expand HTTP Query definition...
id
string
Match conversation id. Can be a comma-separated list of ids.
name
string
Match conversation name.
agent_id
string
Match conversations with a particular agent. Pass "null" to find conversations with no agent, or "not null" to find conversations with any agent.
fields
string
Requested fields.
limit
integer
Number of results to return. (used with offset)
offset
integer
Number of results to skip before returning. (used with limit)
sorts
string
One or more fields to sort by. Sortable fields: [:id, :name, :user_id, :agent_id, :created_at, :updated_at, :category]
filter_or
boolean
Combine given search criteria in a boolean OR expression
category
string
Filter on conversation category. Can be a comma-separated list of categories.
deleted
boolean
Filter on soft deleted conversations.

Response

200: conversations

Datatype
Description
(array)
can
object
Operations the current user is able to perform on this object
id
string
Conversation unique identifier
name
string
Conversation name
category
string
The category of the conversation (e.g., dashboard, conversation)
sources
Source[]
Expand Source definition...
model
string
Source model
explore
string
Source explore
user_id
string
User id
agent_id
string
Agent id
deleted
boolean
Is conversation soft deleted
created_at
string
Conversation created_at
updated_at
string
Conversation updated_at
messages
Expand ConversationMessage definition...
can
object
Operations the current user is able to perform on this object
id
string
Message unique identifier
message
object
Message content
type
string
Message type
order
integer
Message order
conversation_agent
Agent for this conversation
Expand Agent definition...
can
object
Operations the current user is able to perform on this object
id
string
Agent unique identifier
created_by_user_id
string
User that created the Agent
created_by_name
string
Name of user that created the Agent
created_by_first_name
string
Name of user that created the Agent
created_by_last_name
string
Name of user that created the Agent
created_by_avatar_url
string
Avatar URL of user that created the Agent
name
string
Agent name
description
string
Agent description
category
string
The category of the agent (e.g., dashboard, conversation)
sources
Source[]
Expand Source definition...
model
string
Source model
explore
string
Source explore
has_inaccessible_source
boolean
Has inaccessible source
golden_queries
Expand GoldenQuery definition...
can
object
Operations the current user is able to perform on this object
id
integer
Unique identifier for the golden question
query_id
integer
ID of the associated Looker Query resolved from the answer
questions
string[]
answer
string
The Explore URL representing the answer to the question
is_active
boolean
Whether this golden question should be utilized by the agent
created_by_user_id
integer
ID of the user who created the question
last_updated_by_user_id
integer
ID of the user who last updated the question
created_at
string
Time when the question was created
last_updated_at
string
Time when the question was last updated
golden_query_ids
integer[]
context
Agent context
Expand Context definition...
instructions
string
Agent instructions
deleted
boolean
Is Agent soft deleted
created_at
string
Agent created_at
updated_at
string
Agent updated_at
content_metadata_id
string
Content metadata ID for this Agent
code_interpreter
boolean
Enables Code Interpreter for this Agent
studio_agent_id
string
Studio Agent ID (if this agent was migrated)
workflow_params
Workflow parameters
Expand WorkflowParams definition...
primary_agent
string
The ID of the primary parent agent
polling_frequency_cron
string
Crontab specifying the execution frequency
destination
Workflow delivery destination
missing_agent
boolean
Agent associated with this conversation was deleted
studio_conversation_id
string
Studio Conversation ID (if this conversation was migrated)

400: Bad Request

Datatype
Description
(object)
message
string
Error details
documentation_url
string
Documentation link

404: Not Found

Datatype
Description
(object)
message
string
Error details
documentation_url
string
Documentation link

429: Too Many Requests

Datatype
Description
(object)
message
string
Error details
documentation_url
string
Documentation link