Artifacts Searcher

Edit online

The Artifacts Searcher tool searches and retrieves detailed information about API, application source objects, and table artifacts based on user queries.

The Artifacts Searcher tool supports filtering by source type and provides structured results in markdown format with the following columns:

  • Name
  • Type
  • Location
  • Source ID
Use this tool to quickly locate and retrieve relevant technical details across various domains, including:
APIs
Find API documentation and usage guidelines stored in database tables. This helps developers understand how to integrate and use APIs effectively.
Application objects
Application objects refer to entities and components within software platforms. Examples include Salesforce and ServiceNow. Use the tool to fetch metadata about these objects, such as their properties and methods.
Database tables
Database tables are structured storage units that organize and retrieve data efficiently. You can use the tool to:
  • Access API documentation stored in tables for quick reference.
  • Retrieve application object details, including attributes and behaviors.
  • Explore table structures, such as column names and data types, to understand data organization.
Key highlights
  • Searches across API endpoints, application source objects, and database tables.
  • Displays detailed metadata including source location and specifications.
  • Supports filtering by OpenAPI versions and API types.
  • Provides formatted markdown tables for easy reading.
The following operations are supported in the Artifacts Searcher tool:
Note: When you enter a prompt to search for an API, or a database table and the search results are not appropriate. Do the manual refresh to resolve this issue.

Search for API artifacts

When you enter a prompt to search for application source artifacts, the tool searches for APIs matching the specified criteria and displays detailed information about their specifications and locations.

This operation displays a markdown-formatted table containing API metadata.
Table 1. Parameters
Parameter Required Description
text Yes Search query for API names or descriptions.
source_type Yes Set to "API" for this operation.
Example prompts
  • List all APIs that support the OpenAPI 3 specification
  • Show me all APIs that have paths containing the word 'order'
  • What are all the APIs supporting user authentication operations?

Search for table artifacts

When you enter a prompt to search for table artifacts, the tool searches for database tables matching the specified criteria and displays their schema and metadata information.
Note: When you search for an artifact, the tool displays only the top five matches by default, even if more entries exist in the database for your query.
This operation displays a markdown-formatted table containing table metadata.
Table 2. Parameters
Parameter Required Description
text Yes Search query for table names or descriptions.
source_type Yes Set to "endpoint_schema" for this operation.
Example prompts
  • search for available tables with name procurement_order
  • What are all the tables supporting order-related operations?
  • List all tables in the sales schema