Skip to main content
POST
/
documentations
Create Documentation
curl --request POST \
  --url https://api.contextone.com/documentations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "urls": [
    "<string>"
  ],
  "excludeUrls": [
    "<string>"
  ],
  "name": "<string>",
  "description": "<string>",
  "indexType": "crawl",
  "type": "public"
}
'
{
  "success": true,
  "data": {
    "id": "<string>",
    "status": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
X-Org-Id
string

Organization ID (required for private documentations)

Body

application/json
​
urls
string[]
required

Array of URLs to crawl

​
indexType
enum<string>
required

Indexing method

Available options:
crawl,
llms.txt
​
excludeUrls
string[]

URLs to exclude

​
name
string

Optional name

​
description
string

Optional description

​
type
enum<string>

Documentation visibility

Available options:
public,
private

Response

201 - application/json

Documentation created

​
success
boolean
required
​
data
object
required