Skip to main content
Version: 2.0

Create Tool Configuration API Definition

The Create Tool Configuration API enables you to create reusable tool configurations that store argument overrides and settings for specific tools. Organizations use this API to standardize tool behavior across multiple agents, ensuring consistent search parameters, API limits, and custom configurations while maintaining version control for rollback capabilities.

Create Tool Configuration Request and Response

To create a tool configuration, send a POST request to /v2/tools/{tool_id}/configurations. You specify the following parameters in the request body:

  • name (string, required): A human-readable name for the configuration.
  • description (string, optional): A detailed description of the configuration's purpose.
  • type (string, required): The type of tool configuration (must match the tool type).
  • argument_override (object, optional): Default argument overrides for the tool.
  • query_configuration (object, optional): Query configuration for corpora search tools.
  • metadata (object, optional): Arbitrary metadata for tracking and organization.
  • enabled (boolean, optional): Whether the configuration should be enabled (defaults to true).

The response includes the full definition of the newly created configuration, including system-generated fields such as id, version, created_at, and tool_id.

Example Request

EXAMPLE REQUEST
1

Example Response

EXAMPLE RESPONSE
1

Error Responses

The API returns standard HTTP error codes with detailed error information:

HTTP CodeError CodeDescription
400invalid_requestMissing required fields or invalid configuration type
401unauthorizedInvalid or missing API key
403forbiddenInsufficient permissions for creating tool configurations
404not_foundSpecified tool not found
409conflictA configuration with the same name already exists
429rate_limit_exceededConfiguration creation rate limit exceeded