---
title: "Start data frame indexing"
method: POST
path: "/api/repos/{namespace}/{repo_name}/data_frames/{resource}/index"
tags: ["Data Frames"]
---

# Start data frame indexing

`POST /api/repos/{namespace}/{repo_name}/data_frames/{resource}/index`

## Request

- Base URL: `https://hub.oxen.ai`
- URL: `https://hub.oxen.ai/api/repos/{namespace}/{repo_name}/data_frames/{resource}/index`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/oxen/apis/oxen-server/docs/api/repos/:namespace/:repo_name/data_frames/:resource/index/post.ts> (a function with typed inputs; its response is checked against the schema)

Start indexing a tabular file for queryable access. Creates a workspace if the file is not already indexed.

## Path parameters

- `namespace` string, required
- `repo_name` string, required
- `resource` string, required

## Response `200`

Indexing process started or completed

- StatusMessage
  - `oxen_version` string, nullable
  - `status` string, required
  - `status_message` string, required

## Other responses

- `404`: Resource not found
- `409`: Dataset already indexed

---

[API](https://skmtc.dev/oxen/apis/oxen-server.md) - [All operations](https://skmtc.dev/oxen/apis/oxen-server/llms.txt) - [OpenAPI document](https://skmtc.dev/oxen/apis/oxen-server/revisions/2ae578129949?raw)