Skip to main content
POST
/
api
/
v1
/
datasource
Create Data Source
curl --request POST \
  --url 'https://api.example.com/api/v1/datasource?api_key=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "ds_type": "pdf",
  "name": "<string>",
  "description": "<string>",
  "attributes": {},
  "ds_status": "empty",
  "org_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'
{
  "message": "Data created successfully",
  "meta": {},
  "data": {
    "ds_type": "pdf",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "description": "<string>",
    "attributes": {},
    "ds_status": "empty",
    "org_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}

Authorizations

​
api_key
string
query
required

Your API key for authentication. You can generate it from the Settings page. Format: starts with in-.

Body

application/json
​
ds_type
enum<string> | null
required
Available options:
pdf,
doc,
http,
tool,
text_blob,
image,
text_image
​
name
string | null
​
description
string | null
​
attributes
Attributes · object
​
ds_status
enum<string> | null
default:empty
Available options:
empty,
initialized,
in_process,
ready_for_use,
failed
​
org_id
string<uuid> | null

Response

Successful Response

​
message
string | null
default:Data created successfully
​
meta
Meta · object
​
data
IDataSourceRead · object