> ## Documentation Index > Fetch the complete documentation index at: https://app.miyon.ai/docs/llms.txt > Use this file to discover all available pages before exploring further. # List tool types > Catalog of tool types. `creatable_via_api` tells whether `POST /api/v2/tools` accepts the type, `requires_integration` and `required_integration_type` whether an `integration_id` must be passed, and `params_schema_hint` describes the expected `params`. Behaviours that belong to the agent itself, such as `system:end_call`, are listed with `creatable_via_api: false`; so are provider types without a template. ## OpenAPI ````yaml /api-reference/openapi.yaml get /api/v2/tools/types openapi: 3.1.0 info: title: Customer API version: 1.0.0-beta description: > **Beta.** This API is in beta. Contracts can still change while we complete it, including breaking changes; we announce changes in the release notes and keep them as rare as we can. Pin your integration to the field names and status codes documented here and treat unknown fields as optional. REST API to create and configure voice agents, add tools, test them with evals, read conversations, and place AI outbound calls. **Authentication.** Voice agents, settings, tools, evals and conversations use an API token created on the **Keys** page of your dashboard. Each operation lists the scope it needs under `x-required-scopes`; `:*` grants every action of a resource. Outbound calls use a separate outbound API token from the **Outbound Calls** page. Send either token as `Authorization: Bearer `. **Responses.** A single resource is returned as a flat JSON object; a collection is wrapped in a plural key (`voice_agents`, `tools`, `evals`, `conversations`) next to its paging fields. Deleting returns `204 No Content`. Everything is addressed by the voice agent's `id`; prompts and numbers are internal. **Errors.** Authentication failures return `{ "error", "message" }`. Request quotas return `429` with a `Retry-After` header and `{ "error", "message", "details" }`, where `error` is a stable machine-readable code. Every API call must finish within 30 seconds; longer requests return `503` with `mf-core:api-request-timeout`. Validation errors list the problems per field; the exact shape is shown on each operation. servers: - url: https://app.miyon.ai security: [] tags: - name: Voice Agents description: >- Create and manage voice agents. Configure them through the voice, prompt and knowledge-base settings endpoints. - name: Voice Agent Settings description: >- Read and change a voice agent's voice, prompt and knowledge-base settings. A voice agent has one prompt (its instructions, greeting and conversation settings). Read the schema of a settings group, then update one `key`/`value` pair per request. - name: Tools description: >- Create, configure, enable and execute agent tools. Tools are enabled per voice agent with `agent_id`. These endpoints accept scoped API tokens only; every error uses the `{ "error", "message", "details" }` envelope with a stable `mf-core:tool-*` code. - name: Outbound Calls description: >- Place AI calls and review their outcome. Authenticate with the outbound API token from the **Outbound Calls** page. - name: Conversations description: >- List and inspect the conversations of your account, including transcripts when your retention settings allow. - name: Evals description: >- Evals are automated test conversations that check how a voice agent responds. A scenario contains cases; each case contains the caller's turns and what the agent must say or do. Run a scenario to get pass/fail results. paths: /api/v2/tools/types: get: tags: - Tools summary: List tool types description: > Catalog of tool types. `creatable_via_api` tells whether `POST /api/v2/tools` accepts the type, `requires_integration` and `required_integration_type` whether an `integration_id` must be passed, and `params_schema_hint` describes the expected `params`. Behaviours that belong to the agent itself, such as `system:end_call`, are listed with `creatable_via_api: false`; so are provider types without a template. operationId: listToolTypes responses: '200': description: Supported tool types. content: application/json: schema: $ref: '#/components/schemas/ToolTypesResponse' '401': $ref: '#/components/responses/ToolUnauthorized' '403': $ref: '#/components/responses/ToolForbidden' '429': $ref: '#/components/responses/RateLimited' '503': $ref: '#/components/responses/ServiceUnavailable' security: - scopedJwt: [] components: schemas: ToolTypesResponse: type: object properties: types: type: array items: type: object properties: function_type: type: string description: Tool type identifier. display_name: type: string description: Title shown in the dashboard. creatable_via_api: type: boolean description: Whether `POST /api/v2/tools` accepts this type. requires_integration: type: boolean description: Whether `integration_id` must be passed. required_integration_type: type: - integer - 'null' description: Numeric integration type the integration must have. params_schema_hint: type: - string - 'null' description: Description of the expected `params`. required: - function_type - display_name - creatable_via_api - requires_integration - required_integration_type - params_schema_hint description: Tool types. required: - types ApiError: type: object description: >- Error format with a stable machine-readable `error` code, a human-readable `message` and request-specific `details`. properties: error: type: string description: >- Stable machine-readable error code, for example `mf-core:rate-limit-exceeded`. message: type: string description: Human-readable explanation. details: type: object additionalProperties: true description: >- Request-specific data, for example the offending parameter or the quota policy. required: - error - message - details responses: ToolUnauthorized: description: >- The request did not carry a valid scoped API token. Browser sessions and legacy API keys are rejected on the Tools endpoints. headers: Cache-Control: schema: type: string const: no-store content: application/json: schema: $ref: '#/components/schemas/ApiError' examples: missing: value: error: mf-core:tool-authentication-failed message: Missing authorization token details: {} expired: value: error: mf-core:tool-authentication-failed message: Token expired details: {} invalid: value: error: mf-core:tool-authentication-failed message: Invalid authorization token details: {} ToolForbidden: description: >- The token lacks the required scope (`details.scope` names it), the tool's integration is not enabled for your account, or your plan does not include the tool type. headers: Cache-Control: schema: type: string const: no-store content: application/json: schema: $ref: '#/components/schemas/ApiError' examples: scope: value: error: mf-core:tool-scope-required message: Required tool scope is missing details: scope: tools:write feature: value: error: mf-core:tool-feature-disabled message: This tool integration is not enabled details: {} warmTransfer: value: error: mf-core:tool-warm-transfer-unavailable message: Warm transfer is unavailable details: {} plan: value: error: mf-core:plan-warm-transfer-not-entitled message: Your plan does not include warm transfer details: {} RateLimited: description: >- Too many requests. Wait the number of seconds given in `Retry-After` before retrying. headers: Retry-After: description: Seconds to wait before retrying. schema: type: integer minimum: 1 content: application/json: schema: $ref: '#/components/schemas/ApiError' example: error: mf-core:rate-limit-exceeded message: Rate limit exceeded details: policy: api_write retry_after: 3 ServiceUnavailable: description: >- The request was not completed. Either it exceeded the 30-second request time limit that applies to every API call (narrow the request and retry), or rate limiting is temporarily unavailable. Retry shortly. content: application/json: schema: $ref: '#/components/schemas/ApiError' examples: timeout: value: error: mf-core:api-request-timeout message: The API request exceeded the 30-second time limit details: {} limiter: value: error: mf-core:rate-limiter-unavailable message: API rate limiting is temporarily unavailable details: policy: api_write securitySchemes: scopedJwt: type: http scheme: bearer bearerFormat: JWT description: >- Scoped API token. Required scopes are listed on each operation in x-required-scopes. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.