Skip to main content
GET
Search tools, monitor types, and plays
Authentication: workspace API key in Authorization: Bearer <key>.

Errors

Authorizations

Authorization
string
header
required

Create a workspace API key in the Deepline dashboard before calling authenticated endpoints.

Query Parameters

q
string

The task or capability to search for. Omit when filtering only by categories or search_terms.

types
string

Comma-separated kinds to search: tools, monitors, prebuilts, custom, or plays (prebuilts and custom). Omit to search everything.

exclude
string

Comma-separated kinds to leave out, using the same names as types. Applied after types.

categories
string

Comma-separated tool categories to filter.

search_terms
string

Comma-separated capability terms to rank and filter by, including when q is empty.

limit
integer
default:20

Maximum ranked results to return.

Required range: 1 <= x <= 50
offset
integer
default:0

Zero-based offset into the ranked result set.

Required range: x >= 0
task
string

Optional. What the caller is trying to accomplish, in one sentence: the input it has and the result it needs, not a restatement of q. Used to rank candidates; up to 300 characters are used.

Response

A successful Runtime API response.

results
object[]
required
kinds
string[]
required
search_ref
string
count
number
total
number
offset
number
limit
number
next_offset
number
total_is_exact
boolean
may_have_more
boolean
truncated
boolean
query
string
categories
string[]
search_terms
string[]