---
updatedAt: 2025-07-28T18:59:28.000Z
agentTools:
  projectIndex: https://docs.ducky.ai/llms.txt
---

# List indexes within a project

Retrieve a list of all created indexes.

# OpenAPI definition

```json
{
  "openapi": "3.0.3",
  "info": {
    "contact": {
      "email": "support@ducky.ai",
      "name": "Ducky Developer Support"
    },
    "description": "API for managing and retrieving data from Ducky.",
    "title": "Ducky API",
    "version": "1.0.1"
  },
  "servers": [
    {
      "url": "https://api.ducky.ai"
    }
  ],
  "security": [
    {
      "api_key": []
    }
  ],
  "paths": {
    "/v1/indexes": {
      "get": {
        "description": "Retrieve a list of all created indexes.",
        "operationId": "listIndexes",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ListIndexesResponse"
                }
              }
            },
            "description": "A list of indexes"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            },
            "description": "Invalid request (e.g., missing or invalid fields)"
          }
        },
        "summary": "List indexes within a project",
        "tags": [
          "indexes"
        ],
        "x-speakeasy-name-override": "list",
        "x-code-samples": [
          {
            "language": "python",
            "label": "listIndexes",
            "code": "from duckyai import DuckyAI\nimport os\n\nclient = DuckyAI(\n    api_key=os.getenv(\"DUCKYAI_API_KEY\", \"\"),\n)\nres = client.indexes.list()\nprint(res.indexes)",
            "install": "pip install duckyai"
          }
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "ErrorResponse": {
        "example": {
          "error": "error"
        },
        "properties": {
          "error": {
            "description": "Error message explaining the issue",
            "title": "error",
            "type": "string"
          }
        },
        "title": "ErrorResponse",
        "type": "object"
      },
      "Index": {
        "example": {
          "record_count": 0,
          "index_id": "index_id",
          "index_name": "index_name",
          "status": "status"
        },
        "properties": {
          "index_id": {
            "description": "The unique identifier of the index",
            "title": "index_id",
            "type": "string"
          },
          "index_name": {
            "description": "The name of the index",
            "title": "index_name",
            "type": "string"
          },
          "record_count": {
            "description": "The number of records in the index",
            "title": "record_count",
            "type": "integer"
          },
          "status": {
            "description": "The status of the index",
            "title": "status",
            "type": "string"
          }
        },
        "required": [
          "index_id",
          "index_name",
          "record_count"
        ],
        "title": "Index",
        "type": "object"
      },
      "ListIndexesResponse": {
        "example": {
          "indexes": [
            {
              "record_count": 0,
              "index_id": "index_id",
              "index_name": "index_name",
              "status": "status"
            },
            {
              "record_count": 0,
              "index_id": "index_id",
              "index_name": "index_name",
              "status": "status"
            }
          ]
        },
        "properties": {
          "indexes": {
            "description": "List of all indexes",
            "items": {
              "$ref": "#/components/schemas/Index"
            },
            "title": "indexes",
            "type": "array"
          }
        },
        "title": "ListIndexesResponse",
        "type": "object"
      }
    },
    "securitySchemes": {
      "api_key": {
        "description": "API key providing access to a project.",
        "in": "header",
        "name": "x-api-key",
        "type": "apiKey"
      }
    }
  },
  "x-google-backend": {
    "address": "api.ducky.ai"
  },
  "x-samples-languages": [
    "python",
    "shell"
  ]
}
```