Source APIs
APIs to manage a Telmai source
Tenant Id can be retrieved from the UI as listed here.
Create a source
POST
https://env1.telm.ai/api/backend/{tenant}/configuration/sources
Create a new source in the tenant
Path Parameters
tenant*
string
Tenant Id
Query Parameters
name*
string
Name of source
description
string
Description of source
Headers
Content-type
string
application/json
Authentication*
string
Bearer <access_token>. Access token retrieved from Authentication API
{
id = 'id',
name = 'name',
description = 'description',
attributes = [],
"last_upload_job_id": null
}
List all sources for this tenant
GET
https://env1.telm.ai/api/backend/{tenant}/configuration/source
Api to list all sources in a tenant
Path Parameters
tenant*
string
Tenant Id
Headers
Content-type
string
application/json
Authentication*
string
Bearer <access_token>. Access token is retrieved from Authentication API
[
{
id = 'id',
name = 'name',
description = 'description',
attributes = [
{
"id": "<id>",
"name": "<name>",
"monitored": <true/false>,
"status": "<status>",
"model_last_updated": "<date>"
},
{
"id": "<id>",
"name": "<name>",
"monitored": <true/false>,
"status": "<status>",
"model_last_updated": "<date>"
}
],
"last_upload_job_id": "<job-id>",
"scheduled_upload": <scheduled_upload>
}
]
Update a source
PUT
https://env1.telm.ai/api/backend/{tenant}/configuration/sources
Create a new source in the tenant
Path Parameters
tenant*
string
Tenant Id
Query Parameters
name*
string
Name of source
description
string
Description of source
Headers
Content-type
string
application/json
Authentication*
string
Bearer <access_token>. Access token retrieved from Authentication API
{
id = 'id',
name = 'name',
description = 'description',
attributes = [],
"last_upload_job_id": null
}
Get details of a specific source
GET
https://env1.telm.ai/api/backend/{tenant}/configuration/sources/<source-id>
Path Parameters
source-id*
string
Id of source to be retrieved.
tenant*
string
Tenant id
Headers
Content-type
string
application/json
Authorization*
string
Bearer <access_token from Authentication API>
{
"id": "<source-id>",
"name": "<source-name>",
"description": "<source-description>",
"attributes": [],
"last_upload_job_id": null,
"scheduled_upload": null
}
Delete Source
DELETE
https://env1.telm.ai/api/backend/{tenant}/configuration/sources/<source-id>
Delete a specific source
Path Parameters
source-id*
string
Id of source to be deleted. This can be retrieved by looking up a source by name
tenant*
string
Name of tenant
Headers
Content-type
string
application/json
Authorization*
string
Bearer <access_token from Authentication API>
{
"message": "Source was deleted successfully"
}
Last updated