Skip to content
OperadeDocs

Search documentation

Type to search documentation.

DashboardContact
Documentation
Copy page
Open raw Markdown

List tools

List workspace tools with supported search, type, and creator filters.

Endpoint

GET/api/v1/workspaces/{workspace_id}/tools

Authentication

Operation classAuthenticationMinimum roleAPI key
dashboard-session-apiDashboard session cookie; mutations also require X-CX-Request: 1.memberNot allowed

Parameters

NameInTypeRequiredDescription
workspace_idpathstringYes—
qquerystring or nullNo—
typequerystring or nullNo—
created_byquerystring or nullNo—

Request body

This operation has no request body.

Example

cURL
curl --request GET 'https://operade.ai/api/v1/workspaces/ws_demo/tools' \
  --cookie 'cx_session=YOUR_SESSION_COOKIE'

Responses

StatusDescriptionContent
4XXHandled client errorapplication/json: ErrorResponse
200Successful Responseapplication/json: ToolListResponse

4XX application/json response schema

Field pathTypeReferenceFormatNullableRequiredEnumDescription
$objectErrorResponse—NoYes——
errorobjectErrorItem—NoYes——
error.codestring——NoYes——
error.detailsobject——NoNo——
error.messagestring——NoYes——

200 application/json response schema

Field pathTypeReferenceFormatNullableRequiredEnumDescription
$objectToolListResponse—NoYes——
itemsarray<object>——NoYes——
items[]objectWebhookTool or GoogleSheetsToolMember or GoogleSheetsToolAdmin—NoYes——
items[].configobjectKonfigWebhook—NoYes——
items[].config.assignmentsarray<Assignment>——NoNo——
items[].config.assignments[]objectAssignment—NoYes—Petik satu nilai dari balasan tool dan simpan sebagai variabel percakapan. Nama field ikut ElevenLabs (`DynamicVariableAssignment`). `source` mereka cuma punya satu nilai (`response`), jadi tidak ikut disalin — field dengan satu nilai yang mungkin adalah field yang tidak perlu ada.
items[].config.assignments[].dynamic_variablestring——NoYes——
items[].config.assignments[].value_pathstring——NoYes——
items[].config.authobject or nullAuth—YesNo—Rahasianya tidak pernah ditulis di sini — yang disimpan NAMA secret. Brankasnya sudah ada (`core/secrets.py`, AES-256-GCM per workspace), jadi tidak ada sumber daya "auth connection" baru seperti punya ElevenLabs.
items[].config.auth.body_namestring or null——YesNo——
items[].config.auth.header_namestring or null——YesNo——
items[].config.auth.secret_namestring——NoYes——
items[].config.auth.typestring——NoYes"bearer", "basic", "header", "body"—
items[].config.body_fieldsobject——NoNo——
items[].config.methodstring——NoNo"GET", "POST", "PUT", "PATCH", "DELETE"—
items[].config.parametersobject——NoNo——
items[].config.request_headersobject——NoNo——
items[].config.response_mocksarray<MockResponse>——NoNo——
items[].config.response_mocks[]objectMockResponse—NoYes——
items[].config.response_mocks[].is_errorboolean——NoNo——
items[].config.response_mocks[].mock_resultstring——NoYes——
items[].config.response_mocks[].parameter_conditionsarray<ParameterCondition>——NoNo——
items[].config.response_mocks[].parameter_conditions[]objectParameterCondition—NoYes——
items[].config.response_mocks[].parameter_conditions[].evalobjectAnythingEval or ExactEval or RegexEval or LlmEval—NoYes——
items[].config.response_mocks[].parameter_conditions[].pathstring——NoYes——
items[].config.timeout_secsnumber——NoNo——
items[].config.urlstring——NoYes——
items[].created_atstring—date-timeNoYes——
items[].created_bystring——NoYes——
items[].descriptionstring——NoYes——
items[].idstring——NoYes——
items[].namestring——NoYes——
items[].typestring——NoYes"webhook"—
items[].updated_atstring—date-timeNoYes——
items[].capability_summarystring——NoYes——
items[].statusstring——NoYes"ready", "unavailable"—
items[].capability_locked_atstring or null—date-timeYesYes——

Response example

Response body JSON
{
  "items": []
}

Errors

Reviewed common and route-declared errors are summarized here; the list is not exhaustive. Start with the distributed error index to find each code's canonical domain page.

StatusCodeDescription
401unauthenticatedAuthentication is missing, invalid, or revoked.
403forbiddenThe authenticated caller does not have access to this operation.
404not_foundThe requested workspace resource was not found.
On this page
  1. Endpoint
  2. Authentication
  3. Parameters
  4. Request body
  5. Example
  6. Responses
  7. 4XX application/json response schema
  8. 200 application/json response schema
  9. Response example
  10. Errors
  11. Related operations