SimPRO AI Tool

AI tool for querying and managing SimPRO data via API

SimPRO AI Tool

AI-generated

Summary

Query SimPRO data using a specified resource and operation.

Inputs

  • baseUrl — Your SimPRO instance URL.
  • companyID — The company ID in SimPRO (usually '0' for main company).
  • toolDescription — How the tool is described to the AI agent, helping it understand when to use this tool.

Output shape

a success response or error message

Ensure valid resource and operation names are used; the operation requires specific parameters based on the chosen method.

Examples

Example 1: Get a specific job.

Parameters: {resource: 'Jobs', operation: 'get', pathParams: {jobID: '20000'}}.

Example 2: Search for customers by name.

Parameters: {resource: 'Customers', operation: 'list', queryParams: {search: 'test'}}.

Example 3: List jobs with filters.

Parameters: {resource: 'Jobs', operation: 'list', queryParams: {status: 'Open', pageSize: 10}}.

Discussion