# create_index
Source:
POST
/v1/knowledge-indexes
Select code samplecURL (shell:curl)
```js
const url = 'https://app.everruns.com/api/v1/knowledge-indexes';
const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: '{"description":"Synced product documentation","embedding_model_id":"example","name":"product-docs","source_config":"example","source_type":"github"}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
```
```sh
curl --request POST \
--url https://app.everruns.com/api/v1/knowledge-indexes \
--header 'Content-Type: application/json' \
--data '{ "description": "Synced product documentation", "embedding_model_id": "example", "name": "product-docs", "source_config": "example", "source_type": "github" }'
```
* Production APIapp.everruns.com/api/v1/knowledge-indexes
Create a new knowledge index.
## Request Bodyrequired
Media typeapplication/json
Request body for the `create_knowledge_index` operation.
object
**description**
Human-readable description. Safe to render in user-facing messages.
string | null
##### Example
```plaintext
Synced product documentation
```
**embedding\_model\_id**
required
Embedding model used to embed chunks. Required.
string
**name**
required
Human-readable name. Safe to render in user-facing messages.
string
##### Example
```plaintext
product-docs
```
**source\_config**
Non-secret source coordinates. GitHub repositories accept `owner/repo` or canonical `https://github.com/owner/repo[.git]` URLs. Never include credentials.
**source\_type**
External source type. One of `github`, `git`. Defaults to `github`.
string | null
##### Example
```plaintext
github
```
## Responses
### 201
Knowledge index created
Media typeapplication/json
Response body for a knowledge index.
object
**archived\_at**
Timestamp when this resource was archived, if any (RFC 3339).
string | null format: date-time
**created\_at**
required
Timestamp when this resource was created (RFC 3339).
string format: date-time
**deleted\_at**
Timestamp when this resource was soft-deleted, if any (RFC 3339).
string | null format: date-time
**description**
Human-readable description. Safe to render in user-facing messages.
string | null
**document\_count**
required
Number of documents currently retained by this index.
integer
**embedding\_model\_id**
required
Embedding model used to embed chunks. Required.
string
**id**
required
Prefixed public identifier. See [ID Schema](https://everruns.com/docs/advanced/id-schema/).
string
**last\_sync\_error**
Sanitized failure reason from the last failed sync, if any.
string | null
**last\_synced\_at**
Timestamp of the last successful sync, if any (RFC 3339).
string | null format: date-time
**name**
required
Human-readable name. Safe to render in user-facing messages.
string
**source\_config**
required
Non-secret source coordinates. Never holds credentials.
**source\_type**
required
External source type. One of `github`, `git`.
string
**status**
required
Current lifecycle status.
string
**sync\_status**
required
Syncout pipeline state. One of `idle`, `pending`, `syncing`, `synced`, `failed`.
string
**updated\_at**
required
Timestamp when this resource was last updated (RFC 3339).
string format: date-time
**vector\_dim**
Embedding dimension, recorded on first successful sync.
integer | null format: int32
##### Example
```json
{
"id": "kidx_01933b5a000070008000000000000001"
}
```
### 400
Invalid input
Media typeapplication/json
Standard error response.
Wire shape is [RFC 9457 Problem Details](https://www.rfc-editor.org/rfc/rfc9457): every error response includes `title` and `status`, and may include `detail`, `code`, `allowed_actions`, `retry_after_seconds`, `instance`, and `type`. The content type is rewritten to `application/problem+json` with the `application/problem+json` content type.
object
**allowed\_actions**
Recovery actions the caller can take next.
Array\