Arcade Engine API
Tools that enable LLMs to interact directly with the engine API.
1.0.0The Arcade Engine API toolkit provides developers with the ability to seamlessly integrate language models (LLMs) with the Arcade Engine API, enabling dynamic interactions and tool management.
Capabilities
- Authorize users and workers for specific tools.
- Retrieve detailed information about tools, projects, and workers.
- Monitor health statuses of the Arcade Engine and workers.
- Execute tools with specified parameters and manage scheduled executions.
- Manage user authentication connections and configurations.
OAuth There is no OAuth authentication for this toolkit.
Secrets
Utilize the ARCADE_API_KEY to access secure endpoints and manage sensitive operations within the system.
Available tools(29)
| Tool name | Description | Secrets | |
|---|---|---|---|
Authorize a user to access a specific tool.
This tool authorizes a user for a specific tool by its name. It should be called when a user needs permission to access a specific tool. The tool returns the authorization status. | 1 | ||
Authorize a worker based on their ID.
This tool is used to verify and authorize a worker by their ID. It should be called when it's necessary to check if a worker has the appropriate permissions or status to perform certain tasks. | 1 | ||
Check the health status of the Arcade Engine.
Use this tool to verify if the Arcade Engine service is currently healthy and operational. | |||
Verify the ongoing authorization status of a tool.
Use this tool to check the status of an ongoing authorization process for a specific tool. Ideal for monitoring when an authorization completes or times out. | 1 | ||
Create a new worker in the system.
This tool is used to add a new worker to the system. It should be called when there's a need to register a new worker. | 1 | ||
Delete a specific auth provider by ID.
This tool deletes a specified authentication provider using its ID. It should be called when you need to remove an auth provider from the system. | 1 | ||
Delete the Model Context Protocol endpoint data.
This tool deletes data at the Model Context Protocol (MCP) endpoint, which supports Streamable HTTP transport. Use it to remove existing configurations or data tied to this endpoint. | 1 | ||
Deletes a secret using its unique ID.
Use this tool to delete a specific secret identified by its ID. Useful when needing to permanently remove a secret from the system. | 1 | ||
Deletes a user/auth provider connection.
This tool deletes a connection between a user and an authentication provider. It should be called when a user needs to disconnect their account from an external auth provider. | 1 | ||
Deletes a specified worker from the system.
Use this tool to remove a worker by providing their unique ID. It should be called when you need to permanently delete a worker record from the system. | 1 | ||
Execute a specified tool with given parameters.
This tool allows the execution of a specified tool by providing its name and necessary arguments. It's useful for triggering specific actions or processes as dictated by the tool's logic.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
If you need the schema, call with mode='get_request_schema' ONCE, then execute. | 1 | ||
Retrieve a list of tools for a specific worker.
This tool is used to get a list of tools associated with a specific worker ID. It should be called when you need an overview of tools for a particular worker. | 1 | ||
Retrieve details of a specific authentication provider.
Use this tool to obtain the details of a particular authentication provider by specifying its ID. | 1 | ||
Fetches a formatted specification for a given tool.
Use this to obtain detailed, formatted specifications for a specific tool from a provider. | 1 | ||
Get the OpenAPI 3.0 specification in JSON format.
Use this tool to retrieve the OpenAPI 3.0 specification for the Arcade Engine API, which provides detailed information about all available endpoints and their usage. | |||
Retrieve detailed information about a specific project.
This tool fetches and returns detailed information for a given project based on its ID. Use it when you need to access specific details about a project. | 1 | ||
Retrieve details for a specific scheduled tool execution.
Use this tool to get information about a specific tool execution that has been scheduled, based on its unique identifier. It provides insights into the timing and parameters of the execution. | 1 | ||
Fetch a list of scheduled tool executions.
Use this tool to retrieve a page of scheduled tool executions, useful for monitoring upcoming automated processes. | 1 | ||
Retrieve a list of tools from the engine configuration.
Use this tool to get a paginated list of tools available in the engine configuration, with optional filtering by toolkit. | 1 | ||
Retrieve the specification for a specific arcade tool.
This tool returns the arcade tool specification for a specified tool by its name. It should be called when there's a need to understand the details or capabilities of a particular tool. | 1 | ||
Retrieve worker details using their ID.
Use this tool to obtain detailed information about a worker by providing their unique ID. Ideal for situations where specific worker data is required. | 1 | ||
Retrieve the health status of a worker.
This tool is used to check the health status of a specific worker by their ID. It should be called when you need to monitor or verify the operational status of a worker. | 1 | ||
Retrieve a list of accessible projects.
This tool returns all projects that the caller has access to. It is useful for identifying projects available to a specific user or account. | 1 | ||
Retrieve all authentication connections for users.
Use this tool to get a comprehensive list of all authentication connections associated with users. Ideal for managing or auditing user authentication setups. | 1 | ||
Retrieve a list of available authentication providers.
This tool fetches a paginated list of authentication providers accessible to the caller. It should be used when identifying or managing auth providers in the system. | 1 |
Selected tools
No tools selected.
Click "Show all tools" to add tools.
Requirements
Select tools to see requirements
ArcadeEngineApi.AuthorizeUserToolAccess
Authorize a user to access a specific tool. This tool authorizes a user for a specific tool by its name. It should be called when a user needs permission to access a specific tool. The tool returns the authorization status.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
tool_name_for_authorization | string | Required | Specify the name of the tool to authorize the user for access. |
redirect_uri_after_authorization | string | Optional | Optional URI to redirect the user after authorization. |
tool_version | string | Optional | Specify the tool version to authorize. If not provided, any version will be used. |
user_id | string | Optional | The unique identifier for a user. Required only when using an API key for authorization. |
Requirements
Output
json— Response from the API endpoint 'tool-authorize'.ArcadeEngineApi.AuthorizeWorker
Authorize a worker based on their ID. This tool is used to verify and authorize a worker by their ID. It should be called when it's necessary to check if a worker has the appropriate permissions or status to perform certain tasks.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
worker_id | string | Required | The unique identifier for the worker to be authorized. |
Requirements
Output
json— Response from the API endpoint 'workers-authorize'.ArcadeEngineApi.CheckArcadeEngineHealth
Check the health status of the Arcade Engine. Use this tool to verify if the Arcade Engine service is currently healthy and operational.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'arcade-health'.ArcadeEngineApi.CheckAuthStatus
Verify the ongoing authorization status of a tool. Use this tool to check the status of an ongoing authorization process for a specific tool. Ideal for monitoring when an authorization completes or times out.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
authorization_id | string | Required | The unique ID for the authorization process to check its status. |
timeout_in_seconds | integer | Optional | Specify the timeout duration in seconds. Maximum allowed is 59 seconds. |
Requirements
Output
json— Response from the API endpoint 'auth-status'.ArcadeEngineApi.CreateWorker
Create a new worker in the system. This tool is used to add a new worker to the system. It should be called when there's a need to register a new worker.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
worker_id | string | Required | A unique identifier for the worker to be created. It should be a string. |
enable_worker | boolean | Optional | Set to true to enable the new worker upon creation, or false to keep it disabled. |
http_retry_attempts | integer | Optional | Number of retry attempts for HTTP requests if a failure occurs. |
http_secret_key | string | Optional | A secret key used for HTTP authentication and authorization. It should be a secure string provided by the service. |
http_timeout_seconds | integer | Optional | The timeout duration for the HTTP connection, specified in seconds. This defines how long the system should wait for the HTTP request to complete before timing out. |
mcp_retry_attempts | integer | Optional | Specifies the number of retry attempts for MCP connections. Provide an integer value to define how many times the system should retry a connection if it fails. |
mcp_timeout_duration | integer | Optional | The timeout duration for MCP operations in seconds. Must be an integer value. |
worker_http_uri | string | Optional | The HTTP URI for the worker's endpoint. This expects a valid URL string that specifies where the worker's service can be accessed. |
worker_resource_uri | string | Optional | The URI for the worker's resource location or service endpoint. Provide the full URI as a string. |
worker_type | string | Optional | Specifies the type of worker to be created. It should be a string indicating the category or role of the worker. |
Requirements
Output
json— Response from the API endpoint 'workers-create'.ArcadeEngineApi.DeleteAuthProvider
Delete a specific auth provider by ID. This tool deletes a specified authentication provider using its ID. It should be called when you need to remove an auth provider from the system.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
auth_provider_id | string | Required | The ID of the authentication provider to delete. |
Requirements
Output
json— Response from the API endpoint 'auth-providers-delete'.ArcadeEngineApi.DeleteMcpEndpoint
Delete the Model Context Protocol endpoint data. This tool deletes data at the Model Context Protocol (MCP) endpoint, which supports Streamable HTTP transport. Use it to remove existing configurations or data tied to this endpoint.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'mcp-endpoint'.ArcadeEngineApi.DeleteSecretById
Deletes a secret using its unique ID. Use this tool to delete a specific secret identified by its ID. Useful when needing to permanently remove a secret from the system.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
secret_id | string | Required | The unique identifier of the secret to delete. |
Requirements
Output
json— Response from the API endpoint 'secrets-delete'.ArcadeEngineApi.DeleteUserAuthConnection
Deletes a user/auth provider connection. This tool deletes a connection between a user and an authentication provider. It should be called when a user needs to disconnect their account from an external auth provider.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
connection_id | string | Required | The unique identifier for the user/auth provider connection to be deleted. |
Requirements
Output
json— Response from the API endpoint 'auth-connections-delete'.ArcadeEngineApi.DeleteWorker
Deletes a specified worker from the system. Use this tool to remove a worker by providing their unique ID. It should be called when you need to permanently delete a worker record from the system.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
worker_id | string | Required | The unique identifier for the worker to be deleted. |
Requirements
Output
json— Response from the API endpoint 'workers-delete'.ArcadeEngineApi.ExecuteTool
Execute a specified tool with given parameters. This tool allows the execution of a specified tool by providing its name and necessary arguments. It's useful for triggering specific actions or processes as dictated by the tool's logic. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'tool-execute'.ArcadeEngineApi.FetchToolsPage
Retrieve a list of tools for a specific worker. This tool is used to get a list of tools associated with a specific worker ID. It should be called when you need an overview of tools for a particular worker.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
worker_id | string | Required | The unique ID of the worker for which to retrieve the tools list. |
number_of_items | integer | Optional | Number of items to return in the result set. Default is 25 and the maximum is 100. |
start_offset | integer | Optional | Offset from the start of the list for pagination. Defaults to 0. |
Requirements
Output
json— Response from the API endpoint 'tools-list'.ArcadeEngineApi.GetAuthProviderDetails
Retrieve details of a specific authentication provider. Use this tool to obtain the details of a particular authentication provider by specifying its ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
auth_provider_id | string | Required | The ID of the authentication provider to retrieve. |
Requirements
Output
json— Response from the API endpoint 'auth-providers-get'.ArcadeEngineApi.GetFormattedToolSpecification
Fetches a formatted specification for a given tool. Use this to obtain detailed, formatted specifications for a specific tool from a provider.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
tool_name | string | Required | The name of the tool for which the formatted specification is requested. |
provider_format | string | Optional | Specifies the format of the tool as required by the provider. |
user_id | string | Optional | The identifier for the user requesting the tool specification. This should be a string. |
Requirements
Output
json— Response from the API endpoint 'tool-spec-formatted'.ArcadeEngineApi.GetOpenapiSpecification
Get the OpenAPI 3.0 specification in JSON format. Use this tool to retrieve the OpenAPI 3.0 specification for the Arcade Engine API, which provides detailed information about all available endpoints and their usage.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'openapi' (returns OpenAPI 3.0 specification).ArcadeEngineApi.GetProjectDetails
Retrieve detailed information about a specific project. This tool fetches and returns detailed information for a given project based on its ID. Use it when you need to access specific details about a project.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
authorization_token | string | Required | JWT token required for authentication. Should be provided in the format: 'Bearer <token>'. |
project_id | string | Required | The unique identifier for the project to retrieve details for. This should be a string matching the project's ID in the database. |
Requirements
Output
json— Response from the API endpoint 'get-project'.ArcadeEngineApi.GetScheduledToolDetails
Retrieve details for a specific scheduled tool execution. Use this tool to get information about a specific tool execution that has been scheduled, based on its unique identifier. It provides insights into the timing and parameters of the execution.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
scheduled_execution_id | string | Required | The unique identifier for the scheduled tool execution to retrieve details for. |
Requirements
Output
json— Response from the API endpoint 'tool-scheduled-get'.ArcadeEngineApi.GetScheduledToolExecutions
Fetch a list of scheduled tool executions. Use this tool to retrieve a page of scheduled tool executions, useful for monitoring upcoming automated processes.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
items_limit | integer | Optional | The number of scheduled tool executions to return. Defaults to 25, max is 100. |
list_offset | integer | Optional | The starting position in the list of scheduled tool executions, default is 0. |
Requirements
Output
json— Response from the API endpoint 'tool-scheduled-list'.ArcadeEngineApi.GetToolsList
Retrieve a list of tools from the engine configuration. Use this tool to get a paginated list of tools available in the engine configuration, with optional filtering by toolkit.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
include_formats | array<string> | Optional | List of tool formats to include in the response, specified by their names. |
items_per_page | integer | Optional | Specify the number of tools to return, with a maximum of 100. Defaults to 25 if not specified. |
start_offset | integer | Optional | Offset to determine the starting point from the list of tools. Default is 0. |
toolkit_name | string | Optional | Specifies the name of the toolkit to filter the tools list. |
user_id | string | Optional | The ID of the user requesting the tool list. It is used to filter the results for a specific user context. |
Requirements
Output
json— Response from the API endpoint 'tools-list-static'.ArcadeEngineApi.GetToolSpecification
Retrieve the specification for a specific arcade tool. This tool returns the arcade tool specification for a specified tool by its name. It should be called when there's a need to understand the details or capabilities of a particular tool.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
tool_name | string | Required | The name of the tool whose specification is to be retrieved. This should match the tool's registered name. |
formats_to_include | array<string> | Optional | List of tool formats to include in the response. Provide formats as a list of strings. |
user_identifier | string | Optional | The unique identifier for the user requesting the tool specification. |
Requirements
Output
json— Response from the API endpoint 'tool-spec'.ArcadeEngineApi.GetWorkerById
Retrieve worker details using their ID. Use this tool to obtain detailed information about a worker by providing their unique ID. Ideal for situations where specific worker data is required.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
worker_id | string | Required | The unique identifier for the worker to retrieve details. |
Requirements
Output
json— Response from the API endpoint 'workers-get'.ArcadeEngineApi.GetWorkerHealthStatus
Retrieve the health status of a worker. This tool is used to check the health status of a specific worker by their ID. It should be called when you need to monitor or verify the operational status of a worker.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
worker_id | string | Required | The unique identifier for the worker whose health status you want to check. |
Requirements
Output
json— Response from the API endpoint 'workers-health'.ArcadeEngineApi.ListAccessibleProjects
Retrieve a list of accessible projects. This tool returns all projects that the caller has access to. It is useful for identifying projects available to a specific user or account.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
bearer_token | string | Required | A string containing the Bearer (JWT) token for authentication. |
items_to_skip | integer | Optional | The number of projects to skip before starting to collect the result set. |
maximum_items_to_return | integer | Optional | Specifies the maximum number of projects to return. Must be an integer. |
Requirements
Output
json— Response from the API endpoint 'list-projects'.ArcadeEngineApi.ListAuthConnections
Retrieve all authentication connections for users. Use this tool to get a comprehensive list of all authentication connections associated with users. Ideal for managing or auditing user authentication setups.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
page_offset | integer | Optional | The starting point in the list for pagination. Useful for retrieving subsequent pages of data. |
page_size | integer | Optional | Number of auth connections to return per page. Use to control the size of the result set. |
provider_id | string | Optional | Unique identifier for the authentication provider. |
user_id | string | Optional | The unique identifier for the user to list authentication connections for. |
Requirements
Output
json— Response from the API endpoint 'auth-connections-list'.ArcadeEngineApi.ListAvailableAuthProviders
Retrieve a list of available authentication providers. This tool fetches a paginated list of authentication providers accessible to the caller. It should be used when identifying or managing auth providers in the system.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'auth-providers-list'.ArcadeEngineApi.ListWorkers
Retrieve a list of all workers with their definitions. Use this tool to get information about all available workers and their definitions. This can be helpful for managing or reviewing the current worker pool.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
number_of_items_to_return | integer | Optional | The maximum number of worker items to return, with a default of 25 and a maximum of 100. |
start_offset | integer | Optional | Offset from the start of the list for pagination. Defaults to 0. |
Requirements
Output
json— Response from the API endpoint 'workers-list'.ArcadeEngineApi.RetrieveFormattedToolsList
Fetches a formatted list of tools from engine configuration. Use this tool to retrieve a page of tools from the engine's configuration, which can be filtered by toolkit and formatted for a specific provider.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
filter_by_toolkit | string | Optional | Specify the toolkit name to filter the list of tools. |
number_of_items_to_return | integer | Optional | Specify the number of tools to return. Defaults to 25, with a maximum of 100. |
offset_start_index | integer | Optional | Offset from the start of the tools list. Default is 0. |
provider_format | string | Optional | Format the tools according to the provider's specifications. Accepts a string value. |
user_identifier | string | Optional | The ID of the user for whom the tool list is to be retrieved. |
Requirements
Output
json— Response from the API endpoint 'tools-list-formatted'.ArcadeEngineApi.TestWorkerConnection
Test a worker connection before adding it to the system. Use this tool to verify if a worker connection is functioning properly before integrating it into your system.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
worker_connection_type | string | Required | Specify the type of worker connection to test. It must be a string value indicating the category or mode of the worker. |
http_uri | string | Optional | Specify the HTTP URI of the worker to test the connection. |
mcp_uri | string | Optional | The URI for the MCP connection required to test a worker connection. |
Requirements
Output
json— Response from the API endpoint 'workers-test'.ArcadeEngineApi.UpdateSessionVerificationSettings
Update session verification settings for a user. This tool updates the session verification settings for the user or entity making the call. It should be used when there's a need to modify how sessions are verified, reflecting any new security or configuration preferences.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
unsafe_skip_verification | boolean | Optional | Set to true to skip the session verification, making it unsafe. |
verifier_url | string | Optional | The URL of the verifier service used for session verification. Provide a valid URL. |
Requirements
Output
json— Response from the API endpoint 'session-verification-settings-update'.