Actions

Search actions

Free-text search across the actions on a platform. Returns the matched actions and, optionally, the knowledge documents attached to each.

get/v1/available-actions/search/{platform}

Request

  • Base URL: https://api.withone.ai
  • URL: https://api.withone.ai/v1/available-actions/search/{platform}
  • Auth: one of:
    • API key in header X-One-Secret
    • OAuth 2 (authorization code, authorization URL https://api.withone.ai/oauth/authorize, token URL https://api.withone.ai/oauth/token, scopes: user:connections:read)
    • OAuth 2 (authorization code, authorization URL https://api.withone.ai/oauth/authorize, token URL https://api.withone.ai/oauth/token, scopes: org:connections:read)
    • OAuth 2 (authorization code, authorization URL https://api.withone.ai/oauth/authorize, token URL https://api.withone.ai/oauth/token, scopes: project:connections:read)

Path parameters

platformstring required

Platform name

Query parameters

querystring required

Free-text query string matched against action name / description / tags.

limitinteger

Maximum number of results to return.

includeKnowledgeboolean

Include the knowledge document associated with each matched action.

executeAgentboolean

Run the matched results through the execute agent for ranking.

knowledgeAgentboolean

Run the matched results through the knowledge agent for refinement.

includeDeprecatedboolean

Include actions marked as deprecated.

Headers

X-One-Organization-Idstring uuid

Selects the tenant this request acts in. Omit it to act in your personal scope.

X-One-Project-Idstring uuid

Selects the tenant this request acts in. Omit it to act in your personal scope.

Response

Search results

keystring required
knowledgestring nullable
method'OPTIONS' | 'GET' | 'POST' | 'PUT' | 'DELETE' | 'HEAD' | 'TRACE' | 'CONNECT' | 'PATCH' required
pathstring required
systemIdstring required
tagsstring[] required
titlestring required

Changes

No recorded changes to this operation across all 1 revision of this API.