Chunk
- POSTCreate or Upsert Chunk or Chunks
- POSTSearch
- POSTAutocomplete
- POSTGet Recommended Chunks
- POSTScroll Chunks
- POSTCount chunks above threshold
- POSTGenerate suggested queries
- POSTRAG on Specified Chunks
- PUTUpdate Chunk
- PUTUpdate Chunk By Tracking Id
- GETGet Chunk By Id
- GETGet Chunk By Tracking Id
- POSTGet Chunks By Tracking Ids
- POSTGet Chunks By Ids
- DELDelete Chunk
- DELDelete Chunk By Tracking Id
- DELBulk Delete Chunks
- POSTSplit HTML Content into Chunks
Chunk Group
- POSTCreate or Upsert Group or Groups
- POSTSearch Over Groups
- POSTSearch Within Group
- POSTGet Recommended Groups
- POSTAdd Chunk to Group
- POSTAdd Chunk to Group by Tracking ID
- POSTGet Groups for Chunks
- GETGet Chunks in Group by Tracking ID
- GETGet Group by Tracking ID
- PUTUpdate Group
- DELRemove Chunk from Group
- DELDelete Group by Tracking ID
- DELDelete Group
- GETGet Group
- GETGet Chunks in Group
- GETGet Groups for Dataset
Message
Crawl
File
Analytics
Dataset
- POSTCreate Dataset
- POSTBatch Create Datasets
- POSTGet All Tags
- POSTGet events for the dataset
- PUTUpdate Dataset by ID or Tracking ID
- PUTClear Dataset
- GETGet Dataset By ID
- GETGet Dataset by Tracking ID
- GETGet Datasets from Organization
- POSTCreate ETL Job
- PUTCreate Pagefind Index for Dataset
- GETGet Pagefind Index Url for Dataset
- GETGet Usage By Dataset ID
- GETGet dataset crawl options
- GETGet apipublic page
- DELDelete Dataset
- DELDelete Dataset by Tracking ID
Organization
Health
Stripe
Metrics
Get Organization
Fetch the details of an organization by its id. Auth’ed user or api key must have an admin or owner role for the specified dataset’s organization.
curl --request GET \
--url https://api.trieve.ai/api/organization/{organization_id} \
--header 'Authorization: <api-key>' \
--header 'TR-Organization: <tr-organization>'
{
"organization": {
"created_at": "2021-01-01 00:00:00.000",
"id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
"name": "Trieve",
"registerable": true,
"updated_at": "2021-01-01 00:00:00.000"
},
"plan": {
"amount": 1000,
"chunk_count": 1000,
"created_at": "2021-01-01 00:00:00.000",
"dataset_count": 1,
"file_storage": 512,
"id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
"message_count": 1000,
"name": "Free",
"stripe_id": "plan_123",
"updated_at": "2021-01-01 00:00:00.000",
"user_count": 5
},
"subscription": {
"created_at": "2021-01-01 00:00:00.000",
"current_period_end": "2021-01-01 00:00:00.000",
"id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
"organization_id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
"plan_id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
"stripe_id": "sub_123",
"updated_at": "2021-01-01 00:00:00.000"
}
}
Authorizations
Headers
The organization id to use for the request
Path Parameters
The id of the organization you want to fetch.
Response
Timestamp of the creation of the dataset
Flag to indicate if the organization has been deleted. Deletes are handled async after the flag is set so as to avoid expensive search index compaction.
Unique identifier of the dataset, auto-generated uuid created by Trieve
Name of the organization
Configuration of the organization for the Trieve partner program. Contact partnerships@trieve.ai for more details.
Timestamp of the last update of the dataset
Flag to indicate whether or not new users may join the organization. Default is true.
Was this page helpful?
curl --request GET \
--url https://api.trieve.ai/api/organization/{organization_id} \
--header 'Authorization: <api-key>' \
--header 'TR-Organization: <tr-organization>'
{
"organization": {
"created_at": "2021-01-01 00:00:00.000",
"id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
"name": "Trieve",
"registerable": true,
"updated_at": "2021-01-01 00:00:00.000"
},
"plan": {
"amount": 1000,
"chunk_count": 1000,
"created_at": "2021-01-01 00:00:00.000",
"dataset_count": 1,
"file_storage": 512,
"id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
"message_count": 1000,
"name": "Free",
"stripe_id": "plan_123",
"updated_at": "2021-01-01 00:00:00.000",
"user_count": 5
},
"subscription": {
"created_at": "2021-01-01 00:00:00.000",
"current_period_end": "2021-01-01 00:00:00.000",
"id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
"organization_id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
"plan_id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
"stripe_id": "sub_123",
"updated_at": "2021-01-01 00:00:00.000"
}
}