> ## Documentation Index > Fetch the complete documentation index at: https://docs.clarifeye.ai/llms.txt > Use this file to discover all available pages before exploring further. # List tools > List all tools available to the project, including tools owned by the project (`category: local`) and tools imported from other projects (`category: imported`). Use the returned `id` together with [`getToolParameters`](#operation/getToolParameters) to discover the request body schema for a given tool, then call [`runTool`](#operation/runTool) to execute it. ## OpenAPI ````yaml /api-reference/openapi-public.yaml get /projects/{project_id}/tools/ openapi: 3.0.3 info: title: Clarifeye Platform API — Public API description: > Forward-facing, supported REST API for new integrators of the Clarifeye Platform. Covers the curated public surface: authentication, knowledge management (documents), users & teams, signals, and tool execution. New integrations should target these endpoints. ## Authentication All endpoints require authentication. Include the Authorization header in every request using either format: - `Authorization: Token ` - `Authorization: Bearer ` version: 1.0.0 contact: name: Clarifeye Support servers: - url: https://eu.app.clarifeye.ai/api/v1 description: EU - url: https://us.app.clarifeye.ai/api/v1 description: US security: - BearerAuth: [] - TokenAuth: [] tags: - name: Users description: Manage users within a project - name: Invitations description: Manage project invitations - name: Documents description: Manage documents within a project - name: Signals description: Submit signals about the project's content for domain experts to review - name: Tools description: Execute configured AI tools with custom parameters - name: Interviews description: >- Assign, run and review structured interview conversations, and manage interview drafts and campaigns - name: Artifacts description: > Knowledge-store artifact catalog: list artifacts, create and edit custom artifacts, manage scope membership, read and publish versions, and configure the cohesion guide. - name: Knowledge Changelog description: Chronological log of changes to the knowledge store's artifacts. paths: /projects/{project_id}/tools/: get: tags: - Tools summary: List tools description: | List all tools available to the project, including tools owned by the project (`category: local`) and tools imported from other projects (`category: imported`). Use the returned `id` together with [`getToolParameters`](#operation/getToolParameters) to discover the request body schema for a given tool, then call [`runTool`](#operation/runTool) to execute it. operationId: listTools parameters: - $ref: '#/components/parameters/ProjectId' - name: tool_type in: query description: Filter by tool type schema: $ref: '#/components/schemas/ToolType' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Offset' responses: '200': description: Successful response content: application/json: schema: allOf: - $ref: '#/components/schemas/PaginatedResponse' - type: object properties: results: type: array items: $ref: '#/components/schemas/Tool' example: count: 2 next: null previous: null results: - id: 4f4a0a36-2c3d-4e6c-9a3b-2b1f0f1a2c11 name: Search financial chunks description: Semantic search over chunks tagged as financial reports. tool_type: retrieval retrieval_mode: semantic-chunks category: local owner_project_id: 9c2b1c0a-7a1d-4d1d-8e3a-1d2b3c4d5e6f owner_project_name: Finance Analytics readonly: false created_at: '2026-04-12T10:21:33Z' updated_at: '2026-05-02T08:44:01Z' - id: c1a7f2e0-6e8f-4f0a-9d11-8b6e5d4c3b2a name: Document retrieval (annual reports) description: Retrieve documents by name or tag. tool_type: document_retrieval retrieval_mode: semantic-chunks category: imported owner_project_id: 11111111-2222-3333-4444-555555555555 owner_project_name: Shared Tools readonly: true created_at: '2026-03-08T15:02:11Z' updated_at: '2026-04-22T11:30:00Z' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' components: parameters: ProjectId: name: project_id in: path required: true description: UUID of the project schema: type: string format: uuid Limit: name: limit in: query description: Maximum number of results per page schema: type: integer default: 100 minimum: 1 maximum: 1000 Offset: name: offset in: query description: Number of results to skip for pagination schema: type: integer default: 0 minimum: 0 schemas: ToolType: type: string enum: - retrieval - math - document_retrieval - data_statistics - websearch - sub_agent description: | Category of tool, which controls how it is executed and what parameters it accepts. The `retrieval` family additionally exposes a `retrieval_mode` field (e.g. `semantic-chunks`, `semantic-objects`, `templated-query`). PaginatedResponse: type: object properties: count: type: integer description: Total number of results next: type: string format: uri nullable: true description: URL to next page of results previous: type: string format: uri nullable: true description: URL to previous page of results results: type: array items: {} Tool: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true tool_type: $ref: '#/components/schemas/ToolType' retrieval_mode: type: string description: | For tools with `tool_type: retrieval`, the specific retrieval variant (e.g. `semantic-chunks`, `semantic-objects`, `templated-query`). Ignored for other tool types. category: type: string enum: - local - imported description: > - `local`: tool is owned by the current project. - `imported`: tool is owned by another project and exported into the current one. owner_project_id: type: string format: uuid description: UUID of the project that owns the tool. owner_project_name: type: string nullable: true description: Name of the project that owns the tool. readonly: type: boolean description: When true, the tool cannot be modified through the API. created_at: type: string format: date-time updated_at: type: string format: date-time example: id: 4f4a0a36-2c3d-4e6c-9a3b-2b1f0f1a2c11 name: Search financial chunks description: Semantic search over chunks tagged as financial reports. tool_type: retrieval retrieval_mode: semantic-chunks category: local owner_project_id: 9c2b1c0a-7a1d-4d1d-8e3a-1d2b3c4d5e6f owner_project_name: Finance Analytics readonly: false created_at: '2026-04-12T10:21:33Z' updated_at: '2026-05-02T08:44:01Z' Error: type: object properties: error: type: string description: Error message example: error: User not found responses: Unauthorized: description: Unauthorized - missing or invalid authentication content: application/json: schema: $ref: '#/components/schemas/Error' example: error: Authentication credentials were not provided. Forbidden: description: Forbidden - insufficient permissions content: application/json: schema: $ref: '#/components/schemas/Error' example: error: You do not have permission to perform this action. NotFound: description: Not found - resource does not exist content: application/json: schema: $ref: '#/components/schemas/Error' example: error: Not found. securitySchemes: BearerAuth: type: http scheme: bearer description: 'Use Authorization: Bearer ' TokenAuth: type: apiKey in: header name: Authorization description: 'Use Authorization: Token ' ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.